Defining Automation Services Commands › How You Define Your Own Commands › Variables Available to a Command NCL Procedure

Variables Available to a Command NCL Procedure

The following variables can be used in an NCL procedure associated with a command, to pass data required by the command:

ZRMSYSNAME

Contains the name of the system to which the command is to be applied.

ZRMVERSION

Contains the version number of the system to which the command is to be applied.

ZRMCMDUSERID

Contains the user ID of the person who issued the command.

ZRMCMDLINK

Contains the name of a link (which is, in fact, the ACB name of the target region) that will route a command to a region. The ZRMCMDLINK variable contains the ACB name of the current region if the command is not to be routed to a different system.

ZRMCMDPARMS

Contains any command parameters specified by the user. Parameters are in the format parameter=value, separated by spaces. This enables you to override default values.

ZRMDB*

Knowledge base variables have the prefix ZRMDB. If the command is to be applied to a resource or a service defined in the knowledge base, the command procedure needs access to relevant values stored in knowledge base variables. One or more of the following four variables is likely to be required:

ZRMDBSYSNAME

Contains the name of the system image where the resource is defined if the command refers to a specific resource or service.

ZRMDBVERSION

Contains the version number of the system image where the resource is defined if the command refers to a specific resource or service.

ZRMDBCLASS

Contains the class name of the resource or service to which the command is to be applied.

ZRMDBNAME

Contains the name of the resource or service to which the command is to be applied.

ZRMST*

Status variables have the prefix ZRMST. If the command is to be applied to a defined resource or service, the command procedure needs access to relevant values stored in status table variables.

ZMSG*

Message variables have the prefix ZMSG. If the command is to be executed as a result of the receipt of a particular message, the command procedure needs access to relevant values stored in message variables.