SET HOST

Sets the status of a virtual host to enabled or disabled.

Read syntax diagramSkip visual syntax diagram
SET HOST

>>-SET HOST(data-area)--+--------------------+-----------------><
                        '-ENABLESTATUS(cvda)-'   

Conditions: NOTAUTH, NOTFND

This command is threadsafe.

Description

The SET HOST command is used to set the status of a virtual host to enabled or disabled. Disabling a virtual host means that all the URIMAP definitions that make up the virtual host cannot be accessed by applications. When a virtual host is disabled, CICS® returns a HTTP response with a 503 (Service Unavailable) status code to Web clients.

When the INQUIRE URIMAP command is used to inquire on an individual URIMAP definition, a special status DISABLEDHOST is returned to indicate that the virtual host is disabled. You do not need to change the disabled status of the URIMAP definitions individually; the SET HOST command can be used to re-enable all the URIMAP definitions that make up the virtual host. However, note that a URIMAP definition with the DISABLEDHOST status cannot be discarded. If you want to discard the definition, it must be disabled individually (using the SET URIMAP command).

Options

HOST(data-area)
specifies the name of a virtual host. The name of each virtual host is taken from the host name specified in the URIMAP definitions that make up the virtual host. For example, if your CICS region contained URIMAP definitions that specified a host name of www.example.com, CICS would create a virtual host with the name www.example.com. A host name in a URIMAP definition can be up to 120 characters.
ENABLESTATUS(cvda)
CVDA values are:
ENABLED
The URIMAP definitions that make up the virtual host can be accessed by applications.
DISABLED
The URIMAP definitions that make up the virtual host cannot be accessed by applications.

Conditions

NOTAUTH
RESP2 values are:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values are:
5
The virtual host cannot be found.