Command Quick Reference

The VM:Webgateway commands are listed below. You enter these commands from a VM userid. To view the syntax and a complete description of the command, including examples, move the cursor to the command and select it.

ACCOUNT

Authorization:   SYSADMIN, SYSOPER
Closes the VM:Webgateway accounting punch file and sends the file to the accounting userid.

ACCOUNT CLOSE 

CAN

Authorization:   None
Checks the syntax of records in DIRMAP and ACCESS files for a specified URL.

To check directory control records to see whether VM:Webgateway can determine what data to serve:

CAN URL url BERESOLVED

To check access control records to see whether VM:Webgateway will permit access to data:

CAN URL url BESERVEDTO [ [IP address] ... 
    ... [METHOD {GET | POST}] ... 
    ... [REFERRER url] [USER userid] ] 

CERTREQ

Authorization:   SYSADMIN
Creates a request for a server certificate that can be sent to a certificate authority. VM:Webgateway saves the request in a CMS file.

CERTREQ keyname ... 
    ... FILE [filename [filetype [filemode]]] ...
    ... ( COMMON /hostname/ ORGANIZATION /name/ ...
    ... [ORGANIZATIONUNIT /division/] ... 
    ... [LOCALITY /locality/] [STATE /state/] ... 
    ... [COUNTRY /country/] 

CMS

Authorization:   SYSADMIN
Lets you run a CMS subset or CP command on the VM:Webgateway service virtual machine.

CMS command

CONFIG ACCOUNT

Authorization:   SYSADMIN
Controls whether VM:Webgateway collects accounting data on the files it serves, and defines the criteria VM:Webgateway uses when sending the accounting data to the accounting userid.

To turn accounting off:

CONFIG ACCOUNT OFF

To turn accounting on and define when VM:Webgateway sends accounting data to an accounting package:

 CONFIG ACCOUNT ON TO userid [CLOSE ... 
    ... {EVERY number {SECONDS | RECORDS} | ... 
    ... WHEN time(1) [time(2) ... time(n)]}] 

CONFIG CERTIFICATE

Authorization:   SYSADMIN
Adds or deletes a certificate.

To load a certificate from a CMS file:

CONFIG CERTIFICATE ADD name TYPE {SERVER | CA}...
    ... FILE [filename [filetype [filemode]]] 

To generate a self-signed certificate:

CONFIG CERTIFICATE ADD name TYPE SERVER ...
    ... SELFSIGN COMMON /hostname/ ...
    ... ORGANIZATION /name2/ ...
    ... [ORGANIZATIONUNIT /division/] ... 
    ... [LOCALITY /locality/] [STATE /state/] ... 
    ... [COUNTRY /country/] [KEY keyname]...
    ... [SERIAL number] [PERIOD days] 

To delete a certificate:

CONFIG CERTIFICATE DELETE name

CONFIG CGIUSER

Authorization:   SYSADMIN
Adds or deletes VM userids that can serve CGI programs.

CONFIG CGIUSER {ADD | DELETE} userid
content_filetype

CONFIG DUMP

Authorization:   SYSADMIN
Identifies the VM userid to receive dumps if VM:Webgateway ends abnormally.

CONFIG DUMP userid

CONFIG FILETYPE

Authorization:   SYSADMIN
Defines a content filetype for a static file or a CGI program.

To define or redefine a content filetype for a static file:

 CONFIG FILETYPE {ADD | REPLACE} ...
   ... content_filetype FILE ...
   ... CONTENT-TYPE type ...
   ... [TRANSLATE {NONE | tablename}] ...
   ... [SSI {NO | YES}] ...
   ... [FILTER {NONE | ...
   ... WORKERPIPE delim name args delim}] ...
   ... [BFSLINEND {CRLF | NEWLINE | NONE}] 

To define or redefine a content filetype for a CGI program:

 CONFIG FILETYPE {ADD | REPLACE} ... 
   ... content_filetype CGI ENVIRONMENT ...
   ... {SVMEXEC | WORKEREXEC | ...
   ... SVMWEBSHARE | WORKERWEBSHARE} ...
   ... [AUTHHEADERPASSED {YES | NO}] 

To delete a content_filetype:

 CONFIG FILETYPE DELETE filetype 

CONFIG KEY

Authorization:   SYSADMIN
Adds or deletes a key pair.

To generate a new key pair:

CONFIG KEY ADD keyname NEW RSA 512

To load a key pair from a CMS file:

CONFIG KEY ADD keyname ... 
    ... FILE [filename [filetype [filemode]]] 

To delete a key pair:

CONFIG KEY DELETE keyname

CONFIG MSGCASE

Authorization:   SYSADMIN
Specifies whether VM:Webgateway displays messages in upper or mixed case.

CONFIG MSGCASE {MIXED | UPPER}

CONFIG MSGCMD

Authorization:   SYSADMIN
Controls which CP command (MESSAGE or MSGNOH) VM:Webgateway uses to send messages to other userids.

CONFIG MSGCMD {MESSAGE | MSGNOH}

CONFIG QUIESCE

Authorization:   SYSADMIN
Assigns or removes QUIESCE authorization to a VM userid.

CONFIG QUIESCE {ADD | DELETE} userid

CONFIG SOCKET

Authorization:   SYSADMIN
Identifies the TCP socket VM:Webgateway uses for incoming connections and the server root domain associated with that TCP socket.

If you want to display contact information, use the CONTACTNAME and CONTACTEMAIL options.

If VM:Webgateway is using SSL Feature, also specify whether it should use SSL when serving data from the specified socket.

To set the TCP socket and define the server root domain as a minidisk:

 CONFIG SOCKET ADD ipaddress tcp-portnumber ...
    ... ROOT MDISK userid vaddr ... 
    ... ( [CONTACTNAME [NONE | /name/]] ... 
    ...   [CONTACTEMAIL [NONE | e-address]] ... 
    ...   [NOSSL | SSL parms] 

To set the TCP socket and define the server root domain as an SFS directory:

 CONFIG SOCKET ADD ipaddress tcp-portnumber ...
    ... ROOT SFS sfsdir ...
    ... ( [CONTACTNAME [NONE | /name/]] ... 
    ...   [CONTACTEMAIL [NONE | e-address]] ... 
    ...   [NOSSL | SSL parms] 

To set the TCP socket and define the server root domain as a BFS directory:

 CONFIG SOCKET ADD ipaddress tcp-portnumber ...
    ... ROOT BFS bfsdir ...
    ... ( [CONTACTNAME [NONE | /name/]] ... 
    ...   [CONTACTEMAIL [NONE | e-address]] ... 
    ...   [NOSSL | SSL parms] 

To set the TCP socket and define the server root domain to use CMS search order:

 CONFIG SOCKET ADD ipaddress tcp-portnumber ...
    ... ROOT CMS filename ...
    ... ( [CONTACTNAME [NONE | /name/]] ... 
    ...   [CONTACTEMAIL [NONE | e-address]] ... 
    ...   [NOSSL | SSL parms] 

To delete a TCP socket:

 CONFIG SOCKET DELETE ipaddress tcp-portnumber 

To redefine an existing TCP socket to have new socket characteristics:

 CONFIG SOCKET REPLACE ipaddress tcp-portnumber...
    ... ROOT {MDISK userid vaddr | ...
    ... SFS sfsdir | BFS bfsdir | CMS filename}...
    ... ( [CONTACTNAME [NONE | /name/]] ... 
    ...   [CONTACTEMAIL [NONE | e-address]] ... 
    ...   [NOSSL | SSL parms] 

parms:

 CERTIFICATE (server [ca(1) ca(2) ... ca(n)]) ...
    ... [EXEMPT SSLV3 ... 
    ... ( {RSA_EXPORT/RC4_40/MD5 | ...
    ... RSA_EXPORT/RC2_40/MD5} )] ...
    ... [CLIENTCACERTIFICATES (cca-cert(1) ... 
    ...  cca-cert(2) ... cca-cert(n)) ] 

CONFIG SYSADMIN

Authorization:   SYSADMIN
Assigns or removes SYSADMIN authorization to a VM userid.

CONFIG SYSADMIN {ADD | DELETE} userid

CONFIG SYSOPER

Authorization:   SYSADMIN
Assigns or removes SYSOPER authorization to a VM userid.

CONFIG SYSOPER {ADD | DELETE} userid

CONFIG USERPAGES

Authorization:   SYSADMIN
Controls whether end users can define user pages to serve data. Also enables you to identify the initial ACCESS file.

To prevent VM:Webgateway from allowing end users to define user pages:

CONFIG USERPAGES NO

To enable VM:Webgateway to allow end users to define user pages and, optionally, identify the initial ACCESS file:

CONFIG USERPAGES YES [ACCESS fn | NOACCESS]

CONFIG USERROOT

Authorization:   SYSADMIN
Defines the default user page location for a VM userid.

To define the default user page as a minidisk:

CONFIG USERROOT MDISK * vaddr

To define the default user page as an SFS directory:

CONFIG USERROOT SFS sfsdir

To define the default user page as a BFS directory:

CONFIG USERROOT BFS bfsdir

CONFIG WORKER

Authorization:   SYSADMIN
Creates or removes VM:Webgateway worker machines.

To add a worker machine:

CONFIG WORKER ADD userid

To delete a worker machine:

CONFIG WORKER DELETE userid [WHENDONE | NOW]

END

Authorization:   SYSADMIN, SYSOPER
Ends VM:Webgateway server operation.

END [(FORCE]

EXPORT CERTIFICATE

Authorization:   SYSADMIN
Exports a copy of a certificate to a CMS file.

EXPORT CERTIFICATE name ...
    ... FILE [filename [filetype [filemode]]] 

EXPORT KEY

Authorization:   SYSADMIN
Exports a copy of a key pair to a CMS file.

EXPORT KEY keyname ...
    ... FILE [filename [filetype [filemode]]] 

QUERY ACCOUNT

Authorization:   SYSADMIN, SYSOPER
Displays the current configuration of VM:Webgateway accounting.

QUERY ACCOUNT

QUERY CERTIFICATE

Authorization:   SYSADMIN
Displays a list of certificates.

QUERY CERTIFICATE name [( TYPE {* | SERVER | CA}]

QUERY CGIUSER

Authorization:   None
Displays a list of userids that can serve CGI programs from their user pages, and the content filetypes that the user can use for CGI programs.

QUERY CGIUSER [userid [content_filetype]]

QUERY CONFIG

Authorization:   SYSADMIN
Displays configuration settings for your VM:Webgateway system.

QUERY CONFIG

QUERY DUMP

Authorization:   SYSADMIN
Displays the VM userid that receives dumps if VM:Webgateway ends abnormally.

QUERY DUMP

QUERY FILETYPE

Authorization:   None
Displays the characteristics associated with content filetypes.

To display content filetypes for static files:

QUERY FILETYPE content_filetype ... 
   ... [CONTENT-TYPE type/subtype] ...
   ... [TRANSLATE {* | NONE | tablename}] ...
   ... [SSI {* | NO | YES}] ...
   ... [FILTER {* | NONE | ...
   ... WORKERPIPE delim name args delim}] ...
   ... [BFSLINEND {CRLF | NEWLINE | NONE}] ...
   ... [SYSTEM {* | NO | YES}] 

To display content filetypes for CGI programs:

QUERY FILETYPE content_filetype [ENVIRONMENT ...
   ... {* | SVMEXEC | WORKEREXEC | ...
   ... SVMWEBSHARE | WORKERWEBSHARE}] ...
   ... [AUTHHEADERPASSED {* | YES | NO}] ... 
   ... [SYSTEM {* | NO | YES}] 

To display content filetypes for both types of files:

QUERY FILETYPE content_filetype

QUERY KEY

Authorization:   SYSADMIN
Displays a list of key pairs.

QUERY KEY keyname

QUERY MSGCASE

Authorization:   SYSADMIN
Displays the case, either MIXED or UPPER, in which VM:Webgateway displays messages.

QUERY MSGCASE

QUERY MSGCMD

Authorization:   SYSADMIN
Displays the CP command, either MESSAGE or MSGNOH, that VM:Webgateway uses to send messages to other VM userids.

QUERY MSGCMD

QUERY QUIESCE

Authorization:   SYSADMIN
Displays a list of userids that have QUIESCE authorization.

QUERY QUIESCE

QUERY SOCKET

Authorization:   None
Displays the TCP sockets that VM:Webgateway uses for incoming connections and the server root domain associated with each TCP socket. If VM:Webgateway is using SSL Feature, it also displays whether VM:Webgateway uses SSL when serving data from the identified socket.

QUERY SOCKET

QUERY SSL

Authorization:   SYSADMIN
Displays the versions of SSL that VM:Webgateway supports and the associated cipher suites.

QUERY SSL [version]

QUERY SYSADMIN

Authorization:   SYSADMIN
Displays a list of userids that have SYSADMIN authorization.

QUERY SYSADMIN

QUERY SYSOPER

Authorization:   SYSADMIN
Displays a list of userids that have SYSOPER authorization.

QUERY SYSOPER

QUERY USERPAGES

Authorization:   None
Displays whether end users can define user pages, and whether an initial ACCESS file is in use.

QUERY USERPAGES

QUERY USERROOT

Authorization:   None
Displays the minidisk, SFS directory, or BFS directory defined as the user page for a VM userid, or the system default that will be used if a user does not define a user page.

QUERY USERROOT {userid | SYSTEM}

QUERY WORKER

Authorization:   SYSADMIN, SYSOPER
Displays a list of VM:Webgateway worker machines and current status for each.

QUERY WORKER [* | userid | status]

QUIESCE

Authorization:   QUIESCE
Quiesces the VM:Webgateway database minidisk.

QUIESCE vaddr (REPLY number

SET USERROOT

Authorization:   None
Defines the root location for the user page for a user. If you want to display contact information, use the CONTACTNAME and CONTACTEMAIL parameters.

To define the user page as a minidisk:

 SET USERROOT userid MDISK userid vaddr ... 
    ... [CONTACTNAME [NONE | /name/]] ... 
    ... [CONTACTEMAIL [NONE | e-address]] 

To define the user page as an SFS directory:

 SET USERROOT userid SFS sfsdir ... 
    ... [CONTACTNAME [NONE | /name/]] ... 
    ... [CONTACTEMAIL [NONE | e-address]] 

To define the user page as a BFS directory:

 SET USERROOT userid BFS bfsdir ... 
    ... [CONTACTNAME [NONE | /name/]] ... 
    ... [CONTACTEMAIL [NONE | e-address]] 

To set the root location of a user page to the system default:

 SET USERROOT userid SYSTEM 

VIWCVTFL

Authorization:   None
Creates a DIRMAP file from a WEBSHARE FILELIST file.

VIWCVTFL filename [filetype [filemode]] ...
... [(USER | SERVER]

WORKER

Authorization:   SYSADMIN, SYSOPER
Enables you to manage VM:Webgateway worker machines.

To start a worker machine:

WORKER START {* | userid} 

To drain a worker machine:

WORKER DRAIN {* | userid} 

To force a worker machine:

WORKER FORCE {* | userid} [UNAVAIL]