This section explains the keywords for ADDRESS USS.
Important! Command output from any Address USS command will only be returned when the STEM keyword is specified. The associated WAIT keyword is only necessary when a wait time greater or less than the default OCWAIT parameter time is required. When Address USS is executed in an AOF rule type that does not permit waiting for output (all rules types except TOD, REQ, and SCR), the STEM, WAIT, and DELAY keywords are ignored and no output will be returned. In this case an RC=0 simply means that the Address USS command was successfully added to the USS server command queue.
The following keywords cannot be abbreviated.
Delays the processing of a command by the time specified. The command is not executed until this value expires.
When the STEM keyword is not specified (that is, output is not returned), the LOG keyword controls whether any output produced by the function is sent to the SYSLOG and OPSLOG. LOG(N) causes the output to be discarded without any logging. LOG(Y) sends the output to SYSLOG and OPSLOG. LOG(Y) is the default. When the STEM keyword is used, the LOG keyword is ignored and no logging occurs.
Note: This keyword must be specified when a command is issued and a response is expected.
Defines the REXX variable stem that is used to create the variables containing the command output. STEM.0 indicates the number of output variables created. If this keyword is omitted, ADDRESS USS defaults to NOOUTPUT.
An OPS/REXX variable-not a GLOBAL variable-must be specified on the STEM keyword. If a GLOBAL variable is specified, this is checked and an error is produced.
Note: When ADDRESS USS is issued from a rule without the STEM keyword, and the request is successfully queued to the USS server for execution, a return code of 0 is always returned. A CCS for z/OS command or API request may still fail if, for example, CCS for z/OS is not active. Since output from the request was not requested, no indication of this failure is returned.
Example:
ADDRESS USS "PING NODE(SYSTEM99)"
In this example, the command is passed to the USS server, and a return code of 0 is returned. When the server executes the command, a return code of 1200 is returned by the PING API call, indicating that CA NSM is not active on the node. The 1200 return code is never returned to the ADDRESS USS caller. The STEM and WAIT variables must be coded to see this return code.
Specifies a time between 1 second and 604800 seconds to allow ADDRESS USS to wait for command output to be returned. This keyword is only valid when STEM is specified and output is expected.
Note: The OSF USS servers are intended to execute relatively short USS commands. While long WAIT values may be used, we strongly recommend that the WAIT value not be set higher than 600 seconds (10 minutes). Long-running transactions should be run in the background by placing the ampersand (&) symbol at the end of the USS command. However, doing so results in the command output not being returned to the OPS/REXX EXEC that issued the command. Using the OSF USS servers to execute long running transactions may result in other automation that is time-critical to not execute in a timely fashion, since all of the USS servers may be busy executing long-running work. It may also result in the OSF USS execute queue filling up, which in turn may result in ADDRESS USS failures and failing automation.
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|