[0001]
[0002]
[0003]
[0004]
[0005]
[0006]
[0007]
[0008]
[0009]
[0010]
[0011]
[0012]
[0013]
[0014]
[0015]
[0016]
[0017]
[0018]
[0019]
[0020]
[0021]
[0022]
[0023]
[0024]
[0025]
[0026]
[0027]
[0028]
[0029]
[0030]
[0031]
[0032]
[0033]
[0034]
[0035]
[0036]
[0037]
[0038]
[0039]
[0040]
[0041]
[0042]
[0043]
[0044]
[0045]
[0046]
[0047]
[0048]
[0049]
[0050]
[0051]
[0052]
[0053]
[0054]
[0055]
[0056]
[0057]
[0058]
[0059]
[0060]
[0061]
[0062]
[0063]
[0064]
[0065]
[0066]
[0067]
[0068]
[0069]
[0070]
[0071]
[0072]
[0073]
[0074]
[0075]
[0076]
[0077]
[0078]
[0079]
[0080]
[0081]
[0082]
[0083]
[0084]
[0085]
[0086]
[0087]
[0088]
[0089]
[0090]
[0091]
[0092]
[0093]
[0094]
[0095]
[0096]
[0097]
[0098]
[0099]
[0100]
[0101]
[0102]
[0103]
[0104]
[0105]
[0106]
[0107]
[0108]
[0109]
[0110]
[0111]
[0112]
[0113]
[0114]
[0115]
[0116]
[0117]
[0118]
[0119]
[0120]
[0121]
[0122]
[0123]
[0124]
[0125]
[0126]
[0127]
[0128]
[0129]
[0130]
[0131]
[0132]
[0133]
[0134]
[0135]
[0136]
[0137]
[0138]
[0139]
[0140]
[0141]
[0142]
[0143]
[0144]
[0145]
[0146]
[0147]
[0148]
[0149]
[0150]
[0151]
[0152]
[0153]
[0154]
[0155]
[0156]
[0157]
[0158]
[0159]
[0160]
[0161]
[0162]
[0163]
[0164]
[0165]
[0166]
[0167]
[0168]
[0169]
[0170]
[0171]
[0172]
[0173]
[0174]
[0175]
[0176]
[0177]
[0178]
[0179]
[0180]
[0181]
[0182]
[0183]
[0184]
[0185]
[0186]
[0187]
[0188]
[0189]
[0190]
[0191]
[0192]
[0193]
[0194]
[0195]
[0196]
[0197]
[0198]
[0199]
[0200]
[0201]
[0202]
[0203]
[0204]
[0205]
[0206]
[0207]
[0208]
[0209]
[0210]
[0211]
[0212]
[0213]
[0214]
[0215]
[0216]
[0217]
[0218]
[0219]
[0220]
[0221]
[0222]
[0223]
[0224]
[0225]
[0226]
[0227]
[0228]
[0229]
[0230]
[0231]
[0232]
[0233]
[0234]
[0235]
[0236]
[0237]
[0238]
[0239]
[0240]
[0241]
[0242]
[0243]
[0244]
[0245]
[0246]
[0247]
[0248]
[0249]
[0250]
[0251]
[0252]
[0253]
[0254]
[0255]
[0256]
[0257]
[0258]
[0259]
[0260]
[0261]
[0262]
[0263]
[0264]
[0265]
[0266]
[0267]
[0268]
[0269]
[0270]
[0271]
[0272]
[0273]
[0274]
[0275]
[0276]
[0277]
[0278]
[0279]
[0280]
[0281]
[0282]
[0283]
[0284]
[0285]
[0286]
[0287]
[0288]
[0289]
[0290]
[0291]
[0292]
[0293]
[0294]
[0295]
[0296]
[0297]
[0298]
[0299]
[0300]
[0301]
[0302]
[0303]
[0304]
[0305]
[0306]
[0307]
[0308]
[0309]
[0310]
[0311]
[0312]
[0313]
[0314]
[0315]
[0316]
[0317]
[0318]
[0319]
[0320]
[0321]
[0322]
[0323]
[0324]
[0325]
[0326]
[0327]
[0328]
[0329]
[0330]
[0331]
[0332]
[0333]
[0334]
[0335]
[0336]
[0337]
[0338]
[0339]
[0340]
[0341]
[0342]
[0343]
[0344]
[0345]
[0346]
[0347]
[0348]
[0349]
[0350]
[0351]
[0352]
[0353]
[0354]
[0355]
[0356]
[0357]
[0358]
[0359]
[0360]
[0361]
[0362]
[0363]
[0364]
[0365]
[0366]
[0367]
[0368]
[0369]
[0370]
[0371]
[0372]
[0373]
[0374]
[0375]
[0376]
[0377]
[0378]
[0379]
[0380]
[0381]
[0382]
[0383]
[0384]
[0385]
[0386]
[0387]
[0388]
[0389]
[0390]
[0391]
[0392]
[0393]
[0394]
[0395]
[0396]
[0397]
[0398]
[0399]
[0400]
[0401]
[0402]
[0403]
[0404]
[0405]
[0406]
[0407]
[0408]
[0409]
[0410]
[0411]
[0412]
[0413]
[0414]
[0415]
[0416]
[0417]
[0418]
[0419]
[0420]
[0421]
[0422]
[0423]
[0424]
[0425]
[0426]
[0427]
[0428]
[0429]
[0430]
[0431]
[0432]
[0433]
[0434]
[0435]
[0436]
[0437]
[0438]
[0439]
[0440]
[0441]
[0442]
[0443]
[0444]
[0445]
[0446]
[0447]
[0448]
[0449]
[0450]
[0451]
[0452]
[0453]
[0454]
[0455]
[0456]
[0457]
[0458]
[0459]
[0460]
[0461]
[0462]
[0463]
[0464]
[0465]
[0466]
[0467]
[0468]
[0469]
[0470]
[0471]
[0472]
[0473]
[0474]
[0475]
[0476]
[0477]
[0478]
[0479]
[0480]
[0481]
[0482]
[0483]
[0484]
[0485]
[0486]
[0487]
[0488]
[0489]
[0490]
[0491]
[0492]
[0493]
[0494]
[0495]
[0496]
[0497]
[0498]
[0499]
[0500]
[0501]
[0502]
[0503]
[0504]
[0505]
[0506]
[0507]
[0508]
[0509]
[0510]
[0511]
[0512]
[0513]
[0514]
[0515]
[0516]
[0517]
[0518]
[0519]
[0520]
[0521]
[0522]
[0523]
[0524]
[0525]
[0526]
[0527]
[0528]
[0529]
[0530]
[0531]
[0532]
[0533]
[0534]
[0535]
[0536]
[0537]
[0538]
[0539]
[0540]
[0541]
[0542]
[0543]
[0544]
[0545]
[0546]
[0547]
[0548]
[0549]
[0550]
[0551]
[0552]
[0553]
[0554]
[0555]
[0556]
[0557]
[0558]
[0559]
[0560]
[0561]
[0562]
[0563]
[0564]
[0565]
[0566]
[0567]
[0568]
[0569]
[0570]
[0571]
[0572]
[0573]
[0574]
[0575]
[0576]
[0577]
[0578]
[0579]
[0580]
[0581]
[0582]
[0583]
[0584]
[0585]
[0586]
[0587]
[0588]
[0589]
[0590]
[0591]
[0592]
[0593]
[0594]
[0595]
[0596]
[0597]
[0598]
[0599]
[0600]
[0601]
[0602]
[0603]
[0604]
[0605]
[0606]
[0607]
[0608]
[0609]
[0610]
[0611]
[0612]
[0613]
[0614]
[0615]
[0616]
[0617]
[0618]
[0619]
[0620]
[0621]
[0622]
[0623]
[0624]
[0625]
[0626]
[0627]
[0628]
[0629]
[0630]
[0631]
[0632]
[0633]
[0634]
[0635]
[0636]
[0637]
[0638]
[0639]
[0640]
[0641]
[0642]
[0643]
[0644]
[0645]
[0646]
[0647]
[0648]
[0649]
[0650]
[0651]
[0652]
[0653]
[0654]
[0655]
[0656]
[0657]
[0658]
[0659]
[0660]
[0661]
[0662]
[0663]
[0664]
[0665]
[0666]
[0667]
[0668]
[0669]
[0670]
[0671]
[0672]
[0673]
[0674]
[0675]
[0676]
[0677]
[0678]
[0679]
[0680]
[0681]
[0682]
[0683]
[0684]
[0685]
[0686]
[0687]
[0688]
[0689]
[0690]
[0691]
[0692]
[0693]
[0694]
[0695]
[0696]
[0697]
[0698]
[0699]
[0700]
[0701]
[0702]
[0703]
[0704]
[0705]
[0706]
[0707]
[0708]
[0709]
[0710]
[0711]
[0712]
[0713]
[0714]
[0715]
[0716]
[0717]
[0718]
[0719]
[0720]
[0721]
[0722]
[0723]
[0724]
[0725]
[0726]
[0727]
[0728]
[0729]
[0730]
[0731]
[0732]
[0733]
[0734]
[0735]
[0736]
[0737]
[0738]
[0739]
[0740]
[0741]
[0742]
[0743]
[0744]
[0745]
[0746]
[0747]
[0748]
[0749]
[0750]
[0751]
[0752]
[0753]
[0754]
[0755]
[0756]
[0757]
[0758]
[0759]
[0760]
[0761]
[0762]
[0763]
[0764]
[0765]
[0766]
[0767]
[0768]
[0769]
[0770]
[0771]
[0772]
[0773]
[0774]
[0775]
[0776]
[0777]
[0778]
[0779]
[0780]
[0781]
[0782]
[0783]
[0784]
[0785]
[0786]
[0787]
[0788]
[0789]
[0790]
[0791]
[0792]
[0793]
[0794]
[0795]
[0796]
[0797]
[0798]
[0799]
[0800]
[0801]
[0802]
[0803]
[0804]
[0805]
[0806]
[0807]
[0808]
[0809]
[0810]
[0811]
[0812]
[0813]
[0814]
[0815]
[0816]
[0817]
[0818]
[0819]
[0820]
[0821]
[0822]
[0823]
[0824]
[0825]
[0826]
[0827]
[0828]
[0829]
[0830]
[0831]
[0832]
[0833]
[0834]
[0835]
[0836]
[0837]
[0838]
[0839]
[0840]
[0841]
[0842]
[0843]
[0844]
[0845]
[0846]
[0847]
[0848]
[0849]
[0850]
[0851]
[0852]
[0853]
[0854]
[0855]
[0856]
[0857]
[0858]
[0859]
[0860]
[0861]
[0862]
[0863]
[0864]
[0865]
[0866]
[0867]
[0868]
[0869]
[0870]
[0871]
[0872]
[0873]
[0874]
[0875]
[0876]
[0877]
[0878]
[0879]
[0880]
[0881]
[0882]
[0883]
[0884]
[0885]
[0886]
[0887]
[0888]
[0889]
[0890]
[0891]
[0892]
[0893]
[0894]
[0895]
[0896]
[0897]
[0898]
[0899]
[0900]
[0901]
[0902]
[0903]
[0904]
[0905]
[0906]
[0907]
[0908]
[0909]
[0910]
[0911]
[0912]
[0913]
[0914]
[0915]
[0916]
[0917]
[0918]
[0919]
[0920]
[0921]
[0922]
[0923]
[0924]
[0925]
[0926]
[0927]
[0928]
[0929]
[0930]
[0931]
[0932]
[0933]
[0934]
[0935]
[0936]
[0937]
[0938]
[0939]
[0940]
[0941]
[0942]
[0943]
[0944]
[0945]
[0946]
[0947]
[0948]
[0949]
[0950]
[0951]
[0952]
[0953]
[0954]
[0955]
[0956]
[0957]
[0958]
[0959]
[0960]
[0961]
[0962]
[0963]
[0964]
[0965]
[0966]
[0967]
[0968]
[0969]
[0970]
[0971]
[0972]
[0973]
[0974]
[0975]
[0976]
[0977]
[0978]
[0979]
[0980]
[0981]
[0982]
[0983]
[0984]
[0985]
[0986]
[0987]
[0988]
[0989]
[0990]
[0991]
[0992]
[0993]
[0994]
[0995]
[0996]
[0997]
[0998]
[0999]
[1000]
[1001]
[1002]
[1003]
[1004]
[1005]
[1006]
[1007]
[1008]
[1009]
[1010]
[1011]
[1012]
[1013]
[1014]
[1015]
[1016]
[1017]
[1018]
[1019]
[1020]
[1021]
[1022]
[1023]
[1024]
[1025]
[1026]
[1027]
[1028]
[1029]
[1030]
[1031]
[1032]
[1033]
[1034]
[1035]
[1036]
[1037]
[1038]
[1039]
[1040]
[1041]
[1042]
[1043]
[1044]
[1045]
[1046]
[1047]
[1048]
[1049]
[1050]
[1051]
[1052]
[1053]
[1054]
[1055]
[1056]
[1057]
[1058]
[1059]
[1060]
[1061]
[1062]
[1063]
[1064]
[1065]
[1066]
[1067]
[1068]
[1069]
[1070]
[1071]
[1072]
[1073]
[1074]
[1075]
[1076]
[1077]
[1078]
[1079]
[1080]
[1081]
[1082]
[1083]
[1084]
[1085]
[1086]
[1087]
[1088]
[1089]
[1090]
[1091]
[1092]
[1093]
[1094]
[1095]
[1096]
[1097]
[1098]
[1099]
[1100]
[1101]
[1102]
[1103]
[1104]
[1105]
[1106]
[1107]
[1108]
[1109]
[1110]
[1111]
[1112]
[1113]
[1114]
[1115]
[1116]
[1117]
[1118]
[1119]
[1120]
[1121]
[1122]
[1123]
[1124]
[1125]
[1126]
[1127]
[1128]
[1129]
[1130]
[1131]
[1132]
[1133]
[1134]
[1135]
[1136]
[1137]
[1138]
[1139]
[1140]
[1141]
[1142]
[1143]
[1144]
[1145]
[1146]
[1147]
[1148]
[1149]
[1150]
[1151]
[1152]
[1153]
[1154]
[1155]
[1156]
[1157]
[1158]
[1159]
[1160]
[1161]
[1162]
[1163]
[1164]
[1165]
[1166]
[1167]
[1168]
[1169]
[1170]
[1171]
[1172]
[1173]
[1174]
[1175]
[1176]
[1177]
[1178]
[1179]
[1180]
[1181]
[1182]
[1183]
[1184]
[1185]
[1186]
[1187]
[1188]
[1189]
[1190]
[1191]
[1192]
[1193]
[1194]
[1195]
[1196]
[1197]
[1198]
[1199]
[1200]
[1201]
[1202]
[1203]
[1204]
[1205]
[1206]
[1207]
[1208]
[1209]
[1210]
[1211]
[1212]
[1213]
[1214]
[1215]
[1216]
[1217]
[1218]
[1219]
[1220]
[1221]
[1222]
[1223]
[1224]
[1225]
[1226]
[1227]
[1228]
[1229]
[1230]
[1231]
[1232]
[1233]
[1234]
[1235]
[1236]
[1237]
[1238]
[1239]
[1240]
[1241]
[1242]
[1243]
[1244]
[1245]
|1Server Administration||
|^ The online Server Administration facility provides a rich collection of
functionality, including server control, reports and configuration. Some of
these are intended as general administration tools while others provide more
detailed information intended for server debugging and development purposes.
|^ The administration interface also provides some basic server statistics in
the lower right panel;\ local date/time, internet (UTC) equivalent,
client host, connection protocol, and request RTT (the essential network
overhead between client and server), up-times for system, server process,
server executable, CPU consumed by it, along with current connection and
requests-in-progress statistics. Alerts (in red) also can appear in this
panel.
|image%%|./admin.png|
|^ The value of the WATCH facility |link|WATCH Facility| as a general
configuration and problem-solving tool cannot be overstated.
|^ All server configuration files, with the exception of the authentication
databases, are plain text and may be modified with any prefered editor.
However the majority of these can also be administered online through a
browser. In addition the |/update| facility allows some administration of file
system portions of the Web. See |link|HTTPd Web Update||.
|^ Access to many portions of the package is constrained by file protections
and directory listing access files. See
|\|link|<REFERENCE>(hd_auth_sysuaf_profile_site)| for a method for circumventing these
restrictions.
|2Access Before Configuration|
|^ It is often a significant advantage for the inexperienced administrator on a
new and largely unconfigured installation to be able to gain access to the
facilities offered by Server Administration, particularly the WATCH facility
(|link|WATCH Facility||). This can be done quite simply by using the
authentication skeleton-key (|link|Skeleton-Key Authentication||). This allows
the site administrator to register a username and password from the
command-line that can be used to gain access to the server. In addition, the
server ensures that requesting an otherwise non-authorized Server
Administration facility generates a challenge which invokes a username/password
dialog at the browser allowing the user to enter the previously registered
username and password and gain access.
|0Method|
|bullet|
|item| Register the skeleton-key username and password.
|code|
$ HTTPD == "$WASD_EXE:HTTPD_SSL.EXE"
$! HTTPD == "$WASD_EXE:HTTPD.EXE"
$ HTTPD /DO=AUTH=SKELKEY=|/_username:password||
|!code|
|^ Note that the username must begin with an underscore, be at least 6
characters, is delimited by a colon, and that the password must be at least 8
characters. By default this username and password remains valid for 60
minutes. |*Choose strings that are less-than-obvious!||
|item| Access the server via a browser and use the server Server Administration
facility.
|^+ |link%|/httpd/-/admin/|https://the.host.name:port/httpd/-/admin/|
|item| After use the skeleton-key may be explicitly cancelled if desired.
|code|
$ HTTPD /DO=AUTH=SKELKEY=0
|!code|
|!bullet|
|2Access Configuration|
|^ Once established the site should make the Server Administration facility a
configured facility of the site. The value of its facilities cannot be
overstated.
|^ It is also recommended that for production sites the path to these reports
be controlled via authentication and authorization, using both host and
username restrictions, similar to the following:
|code|
[WHATEVER-REALM]
/httpd/-/admin/* host.ip.addr,~WebMaster,~WhoEverElse,r+w
|!code|
|^ If a full authorization environment is not required but
administration via browser is still desired restrict access to browsers
executing on the server system itself, using an appropriate
SYSUAF-authenticated username. Provision of a VMS account for server
administration only is quite feasable, see |link|Nil-Access VMS Accounts||.
|code|
[VMS]
/httpd/-/admin/* #localhost,~|/username||,r+w
|!code|
|^ If SSL is in use (|link|Transport Layer security||) then username/password
privacy is inherently secured via the encrypted communications. To restrict
server administration functions to this secure environment add the following
to the WASD_CONFIG_MAP configuration file:
|code|
/httpd/-/admin/* "403 Access denied." ![sc:https]
|!code|
|^ When using the |/revise| capability of the Server Administration facility it
is necessary to comply with all the requirements for Web update of files. This
is discussed in general terms in |link|HTTPd Web Update||. Revision of server
configuration files requires path permissions allowing write access for the
username(s) doing the administration, as well as the required ACL on the target
directory (in the following example WASD_ROOT:[LOCAL]).
|code|
[VMS]
/httpd/-/admin/* #localhost,~|/username||,r+w
/wasd_root/local/* #localhost,~|/username||,r+w
|!code|
|^ It is possible to allow general access to the Server Administration facility
and reports while restricting the ability to initiate server actions such as a
restart! Using the WORLD realm against the path is necessary, for the obvious
security reason, the server administration module will not allow itself to be
used without an authenticated username, provided as a pseudo-authenticated
"WORLD".
|code|
[VMS]
/httpd/-/admin/control/* #localhost,~|/username||,r+w
[WORLD]
/httpd/-/admin/* r
|!code|
|^ When GZIP compression is configured for the server (see
|link%|../config/##GZIP Encoding++of++WASD Configuration||)
it is not by default applied to Server Admin reports or other pages. It can be
applied, selectively if desired, using mapping rules. For instance, to apply
it to all requests not from the local intranet a rule similar to the following
can be added before the Server Admin path mapping itself.
|code|
if (!remote-addr:192.168.0.0/8) set /httpd/-/admin/* response=GZIP=all
pass /httpd/-/admin/* /httpd/-/admin/*
|!code|
|^ GZIP content-encoding can never be applied to WATCH reports.
|2Server Instances|
|^ With a single instance (see |link|Server Instances||) access to Server
Administration reports, etc. is always serviced by the one server process. If
multiple instances are configured then in common with all requests
administration requests will be serviced by any one of the associated processes
depending on the momentary state of the round-robin distribution.
|^ There are many circumstances where it is preferable to access only the one
server. This can be accomplished for two differing objectives.
|number|
|item| To facilitate access to a specific instance's Server Administration page,
including instance-specific reports etc. This is provided through the use of
an |/administration service| port (see
|link%|../config/##Administration Services++of++WASD Configuration||)
available from the Server Administration page.
|item| The Server Administration page (|link|Control Section||) and the
command-line |link|Instances||) provides the capability to explicitly set the
number of instances supported, overriding any configuration directive. After
explicitly setting this, using either means, the server must be restarted. The
explicit startup setting remains in effect until it is changed to "max"
allowing the WASD_CONFIG_GLOBAL configuration directive [InstanceMax] to once
again determine the number of instances required.
|!number|
|^ The latter approach is particularly useful when performing detailed WATCH
activities (|link|WATCH Facility||).
|^ When multiple per-node instances are executing the Server Administration
pages and reports all include an indication of which process serviced the
request. When accessing no instance in particular the process name is
presented in parentheses after the page title
|code|
HTTPd www.example.com:80
Server Administration (HTTPd:80)
|!code|
When a particular instance's administration service port is being used the
process name is separated from the page title by a hyphen
|code|
HTTPd www.example.com:80
Server Administration - HTTPd:80
|!code|
|^ Multi-instance status (see |link|Status||)
snapshots are available via HTTPDMON, the Server Admin main page and can be
reported from the command line using
|code|
$ HTTPD /DO=STATUS
|!code|
|2HTTPd Server Reports|
|^ The server provides a number of internally generated reports. Some of
these are of general interest. Others are more for evaluating WASD behaviour
and performance for development purposes. Appropriate reports have a refresh
selector allowing the report to be updated at the selected period. The
following list is in the approximate order in which they occur top-to-bottom,
left-to-right in the menu layout.
|^ It is possible to use this facility standalone, without configuring
authorisation (|link|Access Before Configuration||).
|bullet|
|item| |*Statistics |-| |
Server process up-time, CPU-time and other resources consumed, number of
connections processed, number of requests of each HTTP method, type of
processing involved (HTTPd module used), number of bytes processed, etc.
|item| |*Log+\ |-| |
Display the server process (SYS$OUTPUT) log.
The |/plus| displays all accessible server process log files for selection.
Just click on the |=&background-color:yellow;.\ + | in
|inline='_button|\ Log|&background-color:yellow;.+\ ||||.
|item| |*Configuration |-| |
A tabular summary of the server's current configuration. This is a convenient
method for viewing the information from the WASD_CONFIG_GLOBAL file.
|item| |*Services |-| |
A tabular report listing the current services (virtual servers) and the
service-specific parameters.
|item| |*Messages |-| |
A tabular report of the server's current message database, multiple
languages shown if configured that way.
|item| |*Mapping |-| |
All loaded mapping rules and any cached USER rule paths. A selector allows
rules applying only to one particular virtual server to be displayed.
|item| |*Path Authorization |-| |
If authorization is in use (|link|Authentication and Authorization||) this
report lists the paths with associated authorization and access control.
|item| |*User Authentication |-| |
List any users that have been authorized since the server was last
started, the realm authorized from, the group it applies to (if any), and what
the user's capabilities are (allowed HTTP methods). A time-stamp and counters
provide additional information.
|item| |*Secure Sockets |-| |
The SSL report lists counts of the number of SSL transactions initiated
and completed, along with session cache statistics for the currently connected
SSL service. It also lists the ciphers available and current session
information. Other reports allow the Certificate Authority (CA) database to be
view and edited, if available due to X.509 authentication being enabled.
|item| |*AlnFlt |-| |
Memory access alignment faults are constantly monitored. This displays the
accumulated statistics since the most recent startup. Should always be zero!
|item| |*Cache |-| |
Allows monitoring of cache behaviour and performance, as well as the files
currently in the cache (see
|link%|../config/##Cache Configuration++of++WASD Configuration||).
|item| |*Cluster |-| |
For clustered systems generates a report similar to the |/System Report| but
with a cluster emphasis.
|item| |*DCL Scripting |-| |
Provides some DCL, CGI and CGIplus scripting information.
|^ DCL module statistics (same information as displayed in the server
statistics report). These are cumulative for the entire life of the system
(unless zeroed).
|^ Process information shows how many actual processes exist at the time of the
report, as indicated by the PID and bolded, non-zero liftime (in minutes). The
|/soft-limit| specifies how many CGIplus scripts are allowed to continue
existing before the least used is deleted and the |/hard-limit| show how many
processes may actually exist at any one time (the margin allows for process
deletion latency). A count of how many times the CGIplus processes have been
explicitly purged (button available on this report page). The |/life-time| of
zombie processes (in minutes, zero implying use of zombies is disabled) and the
number that have been purged due to expiry. CGIplus process life-time (in
minutes, zero implying indefinite), the number purged due to life-time expiry
and the number of CGIplus processes that the server has actually purged
(deleted) to maintain the soft-limit margin specified above.
|^ Each of the allocated process data structures is listed. There may be zero
up to hard-limit items listed here depending on demand for DCL activities and
the life of the server. Items with a PID shown indicate an actual process
existing. This can be a zombie process or a CGIplus process. If no process is
indicated then the other information represents the state the last time the
item's associated process completed. Information includes the script (URL-style
path) or DCL command, total count of times the item has been used and the last
time it was. The zombie count indicates the number of time the same process
finished a request and entered the |/zombie| state. The CGIplus column
indicates it is/was a CGIplus script and shows the total number of times that
particular script has been/was used. If the process is currently in use the
client information show the client host name.
|^ If any processes are associated with any data structure a |/purge| button is
provided that forces all processes to be deleted. This can be useful if a new
script image is compiled and it is required all scripts now use this. If a
script is currently processing a request the process deletion occurs when that
processing is complete. The purge button |*does not force| a process to delete,
so a second button |*forces| all processes to delete immediately. This can be
used to forceably clear errant scripts, etc., but be warned script processing
is indiscrimately stopped!
|item| |*DECnet Scripting |-| |
DECnet module information shows totals for DECnet scripting usage and the
DECnet connection list.
|^ This list will grow, up to the specified configuration maximum, as
conconurrent scripting demand occurs. Maintained connections are indicated by
the bolded, non-zero lifetime (in minutes). When this reaches zero the task is
disconnected. The current/last task for that connection is indicated, along
with the number of times the connection was reused and a total number of uses
for that list item.
|^ |/Purge| and |/force| buttons allow current links to be broken after request
completion or forcibly disconnected.
|item| |*HTTP |-| |
Reports HTTP/2 and HTTP/1.|/n| statistics together as well as providing a list
of current HTTP/2 connections with some per-connection data. See |link|HTTP/2|
for details.
|item| |*Lock |-| |
Lists the names and status of all lock resources used to manage single and
multiple instances across single systems or a cluster. This report is more
relevant for evaluating and debugging WASD behaviour.
|item| |*Match |-| |
To assist with the refinement of string matching patterns (see
|link%|../config/##String Matching++of++WASD Configuration||).
This report allows the input of target and match strings and allows direct
access to the server's wildcard and regular expression matching routines.
Successful matches show the matching elements and a substitution field allows
resultant strings to be assessed.
|item| |*Memory+\ |-| |
Provides a report and does an integrity check on each of the Virtual Memory
(VM) zones employed by the WASD HTTPd. The |/plus| displays all server process
memory zones.
Just click on the |=&background-color:yellow;.\ + | in
|inline='_button|\ Memory|&background-color:yellow;.+\ ||||.
|item| |*Process |-| |
Lists all processes on the current system owned by the server account.
From this list a process can be selected to have a "SHOW PROCESS /ALL"
performed on it, displayed on a report page.
|item| |*Proxy |-| |
If proxy serving is enabled a report providing statistics on the various
HTTP methods used, network and cache traffic, cache reads and writes, requests
not cachable, and host name lookup are provided. This may used to help guage
the effectiveness of the cache.
|item| |*Request |-| |
Lists in-progress requests (always shows at least your own connection accessing
this report :-) Additional buttons after the report allow selection of a report
that in addition displays current persistent network connections, requests
currently under throttle control, and if enabled a list (history) of the most
recent requests (enabled by the configuration parameter [RequestHistory]).
Current requests may be selected for |/one-shot| WATCH-processing reports from
this page (|\|link|WATCH Facility||).
|^ Two other diagnostic tools are available from the same link. The first,
|/WATCH-peek Report||, providing a snapshot of the contents selected internal
fields and data structures of the request. This is primarily intended as a
problem investiagtion and development tool, and will be of limited value
without an understanding of server internals. The second accesses the "peek"
internals plus a one-shot WATCH-processing report.
|^ For servers handling a great quantity of concurrent traffic this can
generate a very large report. The |/Supervisor| report can also provide a
profile of the servers current load.
|item| |*System+\ |-| |
Shows the system, all users, memory and CPU status as a single report.
|9Server CLI /SYSPLUS|
|note|
|0System Report PLUS|
The standard system report uses a scripting process to present some of this
data in familiar formats (using DCL commands). If the system is faltering for
some reason (e.g. resource exhaustion) this may not be possible |-| and just
when it might be really useful! It |*may| still be possible to gain some
insight into system status using the |=system+| report. This uses only
internal code and provides significant technical data on system, cluster,
device and process status.
Just click on the |=&background-color:yellow;.\ + | in
|inline='_button|\ System|&background-color:yellow;.+\ ||||.
It can also be considered an alternate or supplementary view of the system for
those that don't mind, or who thrive on, more technical content.
|^ |=*.$ HTTPD /SYSPLUS\ | can provide the same report data at the command-line for
circumstances where the server is unresponsive but an interactive session is
available. Requires a 132 character width terminal session. The /SYSPLUS
report generator may be used with /OUTPUT=<filename> to capture and store
report data. See
|link%|../config/##Server Image Command-Line Parameters++of++WASD Configuration||).
|!note|
|item| |*Throttle |-| |
This report provides a list of paths with throttle rules mapped against them.
It provides the throttle values along with current and history activity
counters.
|item| |*WATCH |-| |
This report provides an online, real-time, in-browser-window view of request
processing on the |*running server||. See |link|WATCH Facility| for details.
|item| |*WebDAV |-| |
Provides configuration and statistics.
|item| |*WebSocket |-| |
Lists in-progress WebSocket requests with connection statistics and the
scripting process associated with.
|item| |*Activity |-| |
Provide a graphical |/snapshot| of server activity of a given period.
|^ The statistics are stored in a permanent global section and so carry-over
between server restarts. Where multiple instances are executing the data
represents an accumulation of all instances' processing. It is enabled by the
configuration parameter [ActivityDays]. The Server Administration facility
provides several, represented as a period of hours before the present time.
Number of requests and bytes sent to the client are represented by a histogram
with respective means for each by a line graph. A bar across the column of the
request histogram indicates the peak number of concurrent requests during the
period. A |/greyed| area indicates no data available for that time (i.e.
before the latest server startup, or in the future).
|^ Server startup and shutdown events are indicated by solid, vertical lines
the full height of the graph (see example for a restart event).
|simple#|
|& startup - green
|& shutdown - black
|& restart - grey
|& error exit - red
|!simple|
|^ Activity data is accumulated on a per-minute basis. This is the maximum
granularity of any report. When reports are selected that can display less than
this one minute granularity (i.e. with periods greater than four hours) the
value shown is the |*peak| of the number of minutes sampled for display. This
better represents the load on the server than would a mean of those samples.
|^ The graph is an image map, various regions of which allow the selection of
other reports with different periods or durations. This allows previous periods
to be examined at various levels of detail using the graph for navigation.
Various sections may have no mapping as appropriate to the current report.
|^ For multiple hour reports the upper and lower sections have distinct
functions. The middle 50% of the upper section allows the same end time (most
commonly the current hour) to be examined over twice the current period, in
this case it would be over eight hours. The left 25% allows the previous fours
hours to be viewed (if such data exists), and for non-current reports the right
25% allows the next four hours to be viewed. The lower half can be divided into
sections representing hours or days depending on the period of the current
report. This allows that period to be viewed in greater detail. For single hour
reports this section, of course, is not mapped.
|^ Remember that the URL of the mapped section will be displayed in the status
bar of the browser. As the URL contains time components it is not a difficult
task to decipher the URL displayed to see the exact time and period being
selected.
|image%%|./activity.png|
|!bullet|
|2HTTPd Server Revise|
|^ The server provides a comprehensive configuration revision facility.
|bullet|
|item| |*Configuration |-| |
A form-driven interface allows the current configuration of the server to be
altered online. This configuration may then be saved to the on-disk file and
then the server could be restarted using the new parameters. The source of the
current configuration can be either the server itself (from its volatile,
in-memory parameters) or from the on-disk configuration file. In addition it
is possible to directly edit and update the on-disk file.
|item| |*Services |-| |
A form-driven interface allows service (virtual server) configuration.
It is also possible to directly edit and update the on-disk file. The server
must be restarted for service changes to take effect.
|item| |*Messages |-| |
A form-driven interface allows the the server messages to be modified.
It is also possible to directly edit and update the on-disk file. The
server can then be restarted to use the modified database (|link|HTTPd Server
Action||).
|item| |*Mapping |-| |
No form-driven interface is currently available for changing the mapping rules.
However it is possible to directly edit and update the on-disk file. The
mapping rules could then be reloaded, changing the current server rules
(|link|HTTPd Server Action||).
|item| |*Path Authorization |-| |
No form-driven interface is currently available for changing the path
authorization configuration. However it is possible to directly edit and update
the on-disk file. The path authorization directives could the be reloaded,
changing the current server authorization (|link|HTTPd Server Action||).
|item| |*User Authentication |-| |
User authentication comprises a number of dialogues that allow the
WASD-specific (HTA) authentication databases to be administered. These
include:
|^
|simple#|
|& creating databases
|& deleting databases
|& accessing databases for administering usernames
|& listing usernames within databases
|& adding usernames
|& deleting usernames
|& modifying username permissions and other data
|& reseting in-server (cached) authentication information
|!simple|
|^ |link|Authentication and Authorization| covers authentication detail.
|item| |*Site Log |-| |
This accesses a plain-text file that could be used to record server or other
significant site configuration changes if desired. Two methods of access are
provided.
|number#|
|& Site-Log - open the file for editing, placing a date/time/author timestamp
at the top
|& Edit - open the file editing
|!number|
|^ The file name and/or location may be specified using the logical name
WASD_SITELOG.
|!bullet|
|0Enabling Server Access|
|^ Many of the server activites listed above require server account write
access to the directory in which the configuration files are stored. Where an
autononmous scripting account is in use this poses minimal threat to server
configuration integrity.
|number|
|item| Specifically map the /wasd_root/local/ path and mark it as access always
requiring authorization (ensure this is one on the first mappings in the file
and certainly before any other /wasd_root/ ones).
|code|
# WASD_CONFIG_MAP
pass /wasd_root/local/* auth=all
|!code|
|item| Add appropriate authorization rules (example from
|link%|../config/##Authorization Configuration (Basics)++of++WASD Configuration||).
|code|
# WASD_CONFIG_AUTH
["Web Admin"=WASD_WEBADMIN=id]
/httpd/-/admin/* r+w
/wasd_root/local/* r+w
|!code|
|item| Update access to the directory can be applied using the SECHAN utility
(|link|SECHAN Utility||).
|code|
$ SECHAN /WRITE WASD_ROOT:[000000]LOCAL.DIR
$ SECHAN /WRITE WASD_ROOT:[LOCAL]
|!code|
|item| Load the new mapping and authorization rules.
|code|
$ HTTPD /DO=MAP
$ HTTPD /DO=AUTH=LOAD
|!code|
|!number|
|0Alternative Using /PROFILE|
|^ If a site is using SYSUAF authentication and security profiles enabled using
the /PROFILE startup qualifier (|link|SECHAN Utility||) then a more restrictive
set up is possible, retaining the default no-access to the [LOCAL] directory.
This relies on the administering account(s) having read and write access to the
[LOCAL] directory. It is then not necessary to grant that to the server
account. It is possible to limit the application of VMS user profiles. This
is an example.
|code|
# WASD_CONFIG_MAP
set /wasd_root/local/* profile auth=all
set * noprofile
|!code|
|^ To use this approach perform steps 1, 2 and 4 from above, substituting the
following for step 3.
|code|
$ SECHAN /PACKAGE WASD_ROOT:[000000]LOCAL.DIR
$ SECHAN /PACKAGE WASD_ROOT:[LOCAL]
$ SECHAN /CONTROL WASD_ROOT:[000000]LOCAL.DIR
|!code|
|2HTTPd Server Action|
|^ The server allows certain run-time actions to be initiated. Many of these
functions can also be initiated from the command line, see
|link|HTTPd Command Line||.
|^ When multiple servers are executing on a single node or within a cluster a
JavaScript-driven checkbox appears in the bottom left of the administration
menu. |*Checking that box applies any subsequently selected action to all
servers!|
|0Control Section|
|bullet|
|item| |*Server Restart/restartNOW/restartQuiet/Exit/exitNOW |-| |
The difference between restart/exit and restartNOW/exitNOW is the former waits
for any current requests to be completed, while the latter does it immediately
regardless of any current connections. The restartQuiet variant continues
processing until demand drops to zero for more than one second at which point
it commences restart. If the browser has JavaScript enabled a cautionary alert
requesting confirmation is generated (otherwise there is no confirmation).
|item| |*Logging On/Off/Flush |-| |
The WASD_CONFIG_LOG logical must be configured to allow access logging to be
enabled and disabled from this menu.
|item| |*Caching On/Off/Purge |-| |
Caching may be enabled and disabled in an ad hoc fashion using these controls.
When being disabled after being enabled all previous data is retained. If
subsequently reenabled that data is then again available for use. This allows
convenient assessment of the subject or even object benefits on the cahing.
If purged all entries in the cache are removed.
|item| |*Instance Startup |-| |
An instance value may be set that overrides the configuration directive
[InstanceMax] at next startup. This may be used to change the number of server
processes on an ad hoc basis. Reset to "max" to return to configuration
control. Note that this can be applied to the current node only or to all
servers within a cluster, and that a subsequent restart is required.
|item| |*/DO= Button and Field |-| |
Provides a on-line facility parallel to that provided by the command-line /DO
qualifier (|link|HTTPd Command Line||). Any directive available via the
command-line can be entered using this interface and applied on a per-node or
per-cluster basis.
|!bullet|
|0Configuration Action Section|
|bullet|
|item| |*Statistics Zeroed |-| |
All counters are zeroed (except the |/number-of-times-zeroed| counter!)
|item| |*Mapping Rules Reload |-| |
Reloads the path mapping rules from the on-disk file into the running server,
clears the user SYSUAF mapping cache.
|^ |*Caution!| If changing CGIplus script mapping it is advised to restart the
server rather than reload. Some conflict is possible when using new rules
while existing CGIplus scripts are executing.
|item| |*Path Authorization Reload |-| |
Reloads the path authorization directives from the on-disk file into the
running server.
|item| |*User Authentication Cache Purge |-| |
For efficiency reasons authenticated user information is cached for a limited
period within the running server. All this cached information may be
completely purged using this action, forcing subsequent requests to be
reauthenticated from the on-disk database.
|!bullet|
|2HTTPd Command Line|
|^ A foreign command for the HTTPD control functionality will need to be
assigned in the adminstration users' LOGIN.COM, for example:
|code|
$ HTTPD == "$WASD_EXE:HTTPD"
|!code|
or (perhaps more likely)
|code|
$ HTTPD == "$WASD_EXE:HTTPD_SSL"
|!code|
|^ Some control of the executing server is available from the DCL command
line on the system on which it is executing. This functionality, |*via
the /DO= qualifier||, is available to the privileged user.
|^ These directives are communicated from the command-line (and Server
Administration page analogue - |link|Control Section||) to the per-node or
per-cluster servers using the Distributed Lock Manager. On pre-VMS V8.2 the
command buffer is limited to 15 bytes. From VMS V8.2 the buffer space
available is 63 bytes. In a cluster all systems must support the larger buffer
before WASD enables it. The smaller buffer space limits some of the directives
that take free-form parameters (e.g. /DO=DCL=PURGE=USER=DANIEL).
|0Multi-Server/Cluster-Wide|
|^ If multiple servers are executing on a host or cluster it is possible to
control all of them by adding the /CLUSTER or /ALL qualifiers. Of course,
these commands are available from batch jobs as well as interactively. In a
clustered WASD environment the same functionality is available via checkboxes
from the online Server Administration facility.
|0Need it to be jogged?|
|^ Can't quite remember what it can (and by implication can't) do?
|code|
$ HTTPD /DO=HELP
|!code|
|0Server Log Annotation|
|^ Significant server events (e.g. restart, exit, mapping rule change) can
often benefit (post-mortem :-) from an annotation in the server process log,
especially in a production environment. The command-line /NOTE="<string>" can
be used to insert the supplied string as an ad hoc annotation, or in
conjunction with a /DO=".." CLI command.
|code|
$ HTTPD /NOTE="just a note test!"
$ HTTPD /DO=RESTART /NOTE="adding services ""download."" and ""mail."""
|!code|
|^ The server process log annotation appear as follows.
|code|
%HTTPD-I-NOTE, 10-DEC-2017 22:32:30, just a note test!
%HTTPD-I-NOTE, 10-DEC-2017 22:33:05, adding services "download." and "mail."
|!code|
|^ Note may also be inserted from the Server Admin main page by using the
[/DO=] button and field and prefixing the string with /NOTE= (string
delimitting quotation marks are not required). Using the Server Admin page
annotation and commands cannot be combined.
|3Accounting|
|^ Server counters may be zeroed. These counters are those visible from the
|/statistics| Server Admininstration item and when using the HTTPDMON utility.
|code|
$ HTTPD /DO=ZERO
|!code|
|^ The HTTPDMON utility displays a status line during startup or server exit on
error. For example:
|code|
KLAATU:: 1 HTTPDMON v2.6.0 AXP Friday, 21-SEP-2018 21:40:54
Process: WASD:80 PID: 00001F9B User: HTTP$SERVER Version: 11.3.0
Up: 6 18:21:20.96 CPU: 0 00:07:25.54 Startup: 55 Exit: %X00000001
8< snip 8<
Rx: 1,365,809 (0 err) Tx: 26,965,420 (0 err) (477kB/s)
STATUS: %HTTPD-I-STARTUP, 21-SEP-2018 21:40:52, WASD:80
|!code|
|^ On occasion this can status message become constantly displayed (e.g.
command-line misoperation) with
|code|
$ HTTPD /DO=ZERO=STATUS
|!code|
restoring normal request information.
|3Alignment Faults|
|^ Alignment faults can be a significant performance issue and considerable
effort has been invested in completely eliminating them. This was done using a
internal reporting tool (primarily intended for the WASD developer) available
from the Server Admin interface. Defining the logical name WASD_ALIGN_MAP to
be a linker map of the build provides additional information.
|code|
$ HTTPD /DO=ALIGN=START
$ HTTPD /DO=ALIGN=STOP
$ HTTPD /DO=ALIGN=ZERO
$ HTTPD /DO=ALIGN=FAULT=1
|!code|
|3Authentication|
|^ See |link|Authentication and Authorization||.
|^ The authorization rule file (HTTP$AUTH) may be reloaded using either of
these variants.
|code|
$ HTTPD /DO=AUTH
$ HTTPD /DO=AUTH=LOAD
|!code|
|^ The authentication cache may be purged, resulting in re-authentication for
all subsequent authorization-controlled accesses. This may be useful when
disabling authorization or if a user has been locked-out due to too many
invalid password attempts (|link|Authorization Cache||).
|code|
$ HTTPD /DO=AUTH=PURGE
|!code|
|^ A "skeleton-key" username and password may be entered, amongst things
allowing access to the Server Administration facility
(|link|Server Administration||).
|code|
$ HTTPD /DO=AUTH=SKELKEY=_<username>:<password>[:<period>]
|!code|
|3Cache|
|^ Server cache control may also be exercised from the Server Administration
page (|link|Server Administration||). The file cache (see
|link%|../config/##Cache Configuration++of++WASD Configuration||)
may be enabled, disabled and have the contents purged (declared invalid and
reloaded) using
|code|
$ HTTPD /DO=CACHE=ON
$ HTTPD /DO=CACHE=OFF
$ HTTPD /DO=CACHE=PURGE
|!code|
|3Configuration Check|
|^ Changes to configuration files can be validated at the command-line before
reload or restart. This detects and reports any syntactical and fatal
configuration errors but of course cannot check the |/intent| of the rules.
|code|
$ HTTPD /DO=AUTH=CHECK
$ HTTPD /DO=CONFIG=CHECK
$ HTTPD /DO=GLOBAL=CHECK
$ HTTPD /DO=MAP=CHECK
$ HTTPD /DO=MSG=CHECK
$ HTTPD /DO=SERVICE=CHECK
|!code|
|^ The |/config| check sequentially processes each of the |/authorization||,
|/global||, |/mapping||, |/message| and |/service| configuration files.
|^ If additional server startup qualifiers are required to enable specific
configuration features then these must also be provided when checking. For
example:
|code|
$ HTTPD /DO=AUTH=CHECK /SYSUAF /PROFILE
|!code|
|3DCL/Scripting Processes|
|^ These commands can be useful for flushing any currently executing CGIplus
applications from the server, enabling a new version to be loaded with the
next access. See "Scripting Environment" document.
|^ All scripting processes, busy with a request or not, can be deleted (this
may cause the client to lose data).
|code|
$ HTTPD /DO=DCL=DELETE
|!code|
|^ A gentler alternative is to delete idle processes and mark busy ones for
deletion when completed processing.
|code|
$ HTTPD /DO=DCL=PURGE
|!code|
|^ A more selective DELETE and PURGE is possible, where user name, script name,
or script file name is supplied and only matching tasks have the specified
action peformed.
|code|
$ HTTPD /DO=DCL=PURGE=USER=|/username||
$ HTTPD /DO=DCL=PURGE=SCRIPT=|/script-path||
$ HTTPD /DO=DCL=PURGE=FILE=|/script-file-name||
|!code|
|^ When using the proctor facility
(|link%|../scripting/##Script Proctor++in++WASD Scripting||)
revised rules in WASD_CONFIG_GLOBAL may be |/applied| to the running server
(proctored scripting processes created and deleted), or merely |/loaded| into
the server ruleset (requiring subsequent DCL=PURGE or DCL=DELETE to activate).
|code|
$ HTTPD /DO=DCL=PROCTOR=APPLY
$ HTTPD /DO=DCL=PROCTOR=LOAD
|!code|
|3DECnet Scripting Connections|
|^ All DECnet connections, busy with a request or not, can be disconnected
(this may cause the client to lose data).
|code|
$ HTTPD /DO=DECNET=DISCONNECT
|!code|
|^ Purging is a better alternative, disconnecting idle tasks and marking busy
ones for disconnection when complete.
|code|
$ HTTPD /DO=DECNET=PURGE
|!code|
|3Hhelppp!|
|code|
$ HTTPD /DO=HELP
o ALIGN= START, STOP, ZERO with [<buf-size>,<items>,<mask>]
o AUTH reload authorization file
o AUTH=CHECK elementary check of authorization file
|...|
o ZERO zero all accounting
o ZERO=NOTICED zero the 'errors noticed' accounting
o ZERO=PROXY zero proxy accounting
$
|!code|
|3HTTP/2 Connection|
|^ Disconnect idle HTTP/2 connections.
|code|
$ HTTPD /DO=HTTP2=PURGE
|!code|
|^ All HTTP/2 connections can be disconnected (this may cause clients to lose
data), or a specific connection number.
|code|
$ HTTPD /DO=HTTP2=PURGE=ALL
$ HTTPD /DO=HTTP2=PURGE=|/number||
|!code|
|3Instances|
|^ The number of server instances (see |link|Server Instances||) may be set
from the command line. This overrides any configuration file directive and
applies at the next startup. Any configuration directive value may be used
from the command line.
|code|
$ HTTPD /DO=INSTANCE=MAX
$ HTTPD /DO=INSTANCE=CPU
$ HTTPD /DO=INSTANCE=|/integer||
|!code|
|^ |*Note that the server must be restarted for this to take effect||, that this
can be applied to the current node only or to all servers within a cluster, and
that it remains in effect until explicitly changed to "MAX" allowing the
WASD_CONFIG_GLOBAL configuration directive [InstanceMax] to once again
determine the number of instances required. The same functionality is
available from the Server Administration page (|link|HTTPd Server Action||).
|^ There are also directives to assist with WATCH activities
(|link|Server Instances||).
|code|
$ HTTPD /DO=INSTANCE=PASSIVE
$ HTTPD /DO=INSTANCE=ACTIVE
|!code|
|3Instance Status|
|^ Multi-instance (see |link|Server Instances||) status (see |link|Status||)
can be reported from the command line using
|code|
$ HTTPD /DO=STATUS
|!code|
|^ In addition, stale entries in the status table may be purged using
|code|
$ HTTPD /DO=STATUS=PURGE
|!code|
and the table completely emptied then repopulated over the next minute using
|code|
$ HTTPD /DO=STATUS=RESET
|!code|
|3Logging|
|^ Server logging control may also be exercised from the server administration
menu (|link|Server Administration||).
|^ Open the access log file(s).
|code|
$ HTTPD /DO=LOG=OPEN
|!code|
|^ Close the access log file(s).
|code|
$ HTTPD /DO=LOG=CLOSE
|!code|
|^ Close then reopen the access log file(s).
|code|
$ HTTPD /DO=LOG=REOPEN
|!code|
|^ Unwritten log records may be flushed to the file(s).
|code|
$ HTTPD /DO=LOG=FLUSH
|!code|
|3Mapping|
|^ See
|link%|../config/##Request Processing Configuration++of++WASD Configuration||.
|^ The mapping rule file (WASD_CONFIG_MAP) may be reloaded using either of these
variants.
|code|
$ HTTPD /DO=MAP
$ HTTPD /DO=MAP=LOAD
|!code|
|3Network Connection|
|^ Current network connections can be listed at the CLI.
|code|
$ HTTPD /DO=NET=LIST
|!code|
|^ This can display in an 80 character terminal depending on column widths
(e.g. service and client names) but in some circumstances will require 132
characters to use effectively. The CLI command requests the running server to
generate a report and return that via the $BRKTHRU service.
|^ Note that with HTTP/1.n there is a one-to-one relationship between requests
in progress and a network connection, displayed as a single integer, e.g.
|=1651||. With HTTP/2 there can be a many to one, where listed "connections"
being processed (i.e. requests in progress) are |/virtual| connections being
transported by an independent actual connection, and displayed as
|=1639->1632||, where |=\->1632| is the actual connection.
|code|
Connect Service / Request Client Time Duration
---------- ------------------- ---------- -------- --------
1651 https:wasd.lan:4443 router.lan 08:05:02 6.636s
[persistent:4]
1639->1632 https:wasd.lan:443 router.lan 08:00:52 4.147s
GET /httpd/-/admin/report/WATCH?rqp=1&rsp=1&con=1&err=1&htp=i&cl...
1626->1606 https:wasd.lan:443 router.lan 07:59:57 00:10:45
GET /cgi-bin/smonitor?classes=&MODES=2&PROCESSES=3&SYSTEM=1&inte...
->1632 https:wasd.lan:443 router.lan 08:00:36 19.88s
current:1 peak:1 count:5
->1606 https:wasd.lan:443 router.lan 07:25:41 00:35:14
current:1 peak:4 count:13
1 HTTP/1.n, 2 via HTTP/2, 2 HTTP/2, 17-SEP-2021 07:58:17
|!code|
|^ Disconnect |/idle| (persistent HTTP/1.n and HTTP/2) connections.
|code|
$ HTTPD /DO=NET=PURGE
|!code|
|^ All network connections can be disconnected (this may cause clients to
lose data), selectively idle HTTP/1.n or HTTP/2 connections, a specific
connection number and those matching the specified URI.
|code|
$ HTTPD /DO=NET=PURGE=ALL
$ HTTPD /DO=NET=PURGE=HTTP1
$ HTTPD /DO=NET=PURGE=HTTP2
$ HTTPD /DO=NET=PURGE=|/number||
$ HTTPD /DO=NET=PURGE=URI=|/pattern||
|!code|
|^ Additionally, network connection acceptance can be suspended (leaving
in-progress requests to complete), suspended and in-progress disconnected, and
resumed.
|code|
$ HTTPD /DO=NET=SUSPEND
$ HTTPD /DO=NET=SUSPEND=NOW
$ HTTPD /DO=NET=RESUME
|!code|
|3Shutdown and Restart|
|^ Server shutdown may also be exercised from the Server Administration page
(|link|Server Administration||).
|^ The server may be shut down, without loss of existing client requests.
Connection acceptance is stopped and any existing requests continue to be
processed until conclusion.
|code|
$ HTTPD /DO=EXIT
|!code|
|^ The server may be immediately and unconditionally shut down.
|code|
$ HTTPD /DO=EXIT=NOW
|!code|
|^ The server may be restarted, without loss of existing client requests.
Connection acceptance is stopped and any existing requests continue to be
processed until conclusion. This effectively causes the server to exit
normally and the DCL |/wrapper| procedure to restart it.
|code|
$ HTTPD /DO=RESTART
|!code|
|^ The |/now| variant restarts the server immediately regardless of existing
connections.
|code|
$ HTTPD /DO=RESTART=NOW
|!code|
|^ The when|-| |/quiet| variant restarts the server whenever request processing
drops to zero for more than one second. It allows (perhaps non-urgent) changes
to be put into effect through restart when everything has gone "quiet" and no
demands are being placed on the server.
|code|
$ HTTPD /DO=RESTART=QUIET
|!code|
|^ Significant server events such as these are prime candidates for server log
annotation!
|code|
$ HTTPD /DO=RESTART=NOW /NOTE="Restarting the server just so I can note it :-)"
|!code|
|3Secure Sockets Layer|
|^ If the optional SSL component is installed and configured these directives
become effective.
|^ If X.509 authentication is enabled the Certificate Authority (CA)
verification list can be reloaded.
|code|
$ HTTPD /DO=SSL=CA=LOAD
|!code|
|^ Server certificates, after being updated, may be reloaded into the running
services (i.e. without restart). This is a synonym for /DO=SERVICE=LOAD.
|code|
$ HTTPD /DO=SSL=CERT=LOAD
|!code|
|^ If a private key password is not included with the encode key it is
requested by the server during startup. The following example shows the
directive and the resulting prompt. When entered the password is not echoed.
|code|
$ HTTPD /DO=SSL=KEY=PASSWORD
Enter private key password []:
|!code|
|3Throttle|
|^ Unconditionally release all queued requests for immediate processing.
|code|
$ HTTPD /DO=THROTTLE=RELEASE
|!code|
|^ Unconditionally terminate all requests queued waiting for processing.
Clients receive a 503 "server too busy" response.
|code|
$ HTTPD /DO=THROTTLE=TERMINATE
|!code|
|^ For VMS V8.2 and later, a more selective RELEASE and TERMINATE is possible.
A user name or script name can be supplied and only matching requests have the
specified action peformed.
|code|
$ HTTPD /DO=THROTTLE=TERMINATE=REMOTE=|/pattern||
$ HTTPD /DO=THROTTLE=TERMINATE=SCRIPT=|/pattern||
|!code|
|3WebSocket|
|^ Unconditionally disconnects all WebSocket applications.
|code|
$ HTTPD /DO=WEBSOCKET=DISCONNECT
|!code|
|^ For VMS V8.2 and later, more selective disconnects are possible.
Disconnects WebSocket applications with connection number, with matching script
names, and with matching scripting account usernames, respectively.
|code|
$ HTTPD /DO=WEBSOCKET=DISCONNECT=|/number||
$ HTTPD /DO=WEBSOCKET=DISCONNECT=SCRIPT=|/pattern||
$ HTTPD /DO=WEBSOCKET=DISCONNECT=USER=|/pattern||
|!code|