Syntax for invoking AOSUBX
The required parameters for the AOSUBX command are EXEC() and SS | SSID(). The MSGLVL(), PRI(), TGTJNT(), TGTSS(), AOOPTION(), and WAIT() keywords are optional.
A description of the parameters follows.
Parameter | Required/optional | Description |
|---|---|---|
EXEC | required | The name of the EXEC and any parameters to be passed to the symbolic variables defined as input in the EXEC Maximum length is any number of characters allowed by the PARM= statement. The SS | SSID() parameter is required. |
MSGLVL[ON | NONE] | optional | What informational messages are written to the JES job log when the AOSUBX program is used to schedule an EXEC Valid values are ON and NONE where ON specifies that informational messages relating to the processing of the requested command will be written to the JES2 job log NONE specifies informational messages will not be written to the JES2 job log The default is NONE. |
PRI(NORMAL|HIGH| HOT | FIRST | SINGLE | XSINGLE) | optional | Valid values are as follows: NORM | N Schedules the EXEC with the normal priority setting by using first in, first out (FIFO) queuing strategy. The EXEC is placed in the Normal priority queue and uses an EXEC thread from the MAXNORM thread pool. HIGH | H Schedules the EXEC with a high priority setting by using a FIFO queuing strategy. The EXEC is placed in the High priority queue and uses an EXEC thread from the MAXHIGH thread pool. HOT | T Schedules the EXEC as a hot EXEC by using a FIFO queuing strategy on the Hot priority queue. The next available EXEC thread from either the Normal or the High priority EXEC thread pool is used to run the EXEC waiting on the Hot priority queue. FIRST | F Schedules the EXEC as hot EXEC by using a last in, first out (LIFO) queuing strategy on the Hot priority queue. The next available EXEC thread from either the NORM or the HIGH EXEC thread pool is used to run the EXEC waiting on the Hot priority queue. SINGLE | S Schedules the EXEC with the normal priority setting but allows only one instance of the EXEC to execute at a time, reagrdless of the number of available EXEC threads. For EXECs to be single-threaded using this option, the EXECs must have the same name and must specify SINGLE when scheduled. EXECs that have the same name but are scheduled without the SINGLE specification are not single-threaded with those that are specified the SINGLE option. XSINGLE | X Attempts to schedule the EXEC with the normal priority setting but if another instance of the EXEC that also specified XSINGLE is already running (or waiting to run), the scheduling request is rejected and message EM6111W is written to the BBI-SS journal. |
SS | SSID() | required | The SSID of the BBI-SS PAS to process this EXEC or the SSID of a local BBI-SS PAS that will route the request to a remote BBI-SS PAS (as specified by the SSID specified in the TARGET|TGTSS() or TGTJNT() keyword) If you are using the default XCFGROUP specified in BBPARM member BBISSPxx, then generic wildcard characters are supported for this keyword. You can specify 1 to 4 asterisks (*) or plus signs (+). If you specify a single asterisk (*), any BBI-SS PAS found on the same LPAR might be used to process the EXEC. You can also specify SS(P*) and the EXEC can be processed by any BBI-SS PAS that begins with P. You can use also the plus sign (+) to indicate a positional wildcard such as SS(+++P). In this example, the EXEC can be processed on any BBI-SS PAS that ends in P. Use the AOOPTION parameter to further filter on the wildcard value. By specifying a value with AOOPTION, you can route the EXEC to the BMC AMI Ops Automation BBI-SS PAS that is running a product option or group of product options. AOOPTION is mutually exclusive with TGTSS and TGTJNT, and it is ignored on a fully qualified SSID specified with SS or SSID parameter. |
TGTJNT() | optional | A JNT entry defined in the SS() PAS identifies the SSID which will process this request Use this parameter to specify a target PAS that is specified in BBPARM member BBIJNT00 (with the TARGET=tgtname parameter) for a subsystem identified in SS(). The EXEC is scheduled in the PAS that corresponds to the susbsystem specified by the SUBSYS parameter of the JNT entry. This keyword is mutually exclusive with the TGTSS() keyword. When you use the TGTJNT() parameter, the value specified with this parameter becomes the value of the IMFJTGT variable in the scheduled EXEC. |
TARGET|TGTSS() | optional | Specifies the SSID of a remote BBI-SS PAS to which the request is to be routed SYSPLEX connectivity between the local and remote BBI-SS PAS must be available. The BBI-SS PAS must be in the same sysplex as the BBI-SS specified with the SSID() keyword, and both systems must have the same XCFGROUP specified in the BBPARM BBISSPxx. This keyword is mutually exclusive with the TGTJNT() keyword. |
AOOPTION | optional | Specify the product options that must be active in the BMC AMI OpsA PAS. The following values are valid: ANV, CAO, IAO, IIZ, MAO, QAO, or TSH. IIZ represents the BMC AMI OpsA BMC Impact Integration for z/OS product. The stand-alone BMC Impact Integration for z/OS product does not support AOAnywhere. The specified product option must be active in the BMC AMI OpsA PAS. AOOPTION cannot be specified if TGTSS or TGTJNT are also specified. |
WAIT() | optional | Specifies whether to wait for the completion of the EXEC or continue after scheduling |
Return codes are listed in the following table.
Value | Description |
|---|---|
-1 | When the TGTSS() keyword is used, indicates that either the request timed out or the target system was shut down in the middle of a request |
0 | Command executed successfully |
8 | EXEC you are trying to schedule does not exist or is disabled |
10 | Issued when WAIT(YES) is specified but the EXEC was not queued because the queues are full |
13 | AXTASK abended in the PAS Contact BMC support. |
16 | Syntax error occurred; no input parameters supplied or an unrecognized command was specified |
32 | No XCF connection exists between the subsystem specified with the SS | SSID() keyword and the subsystem specified using the TGTSS() keyword The target subsystem is most likely not active or not in the same sysplex as originating subsystem. |
36 | Local BBI-SS PAS specified by the SSID parameter is not available or none of the SSID(wildcard) BBI-SS PASs satisfied the AOOPTION criteria |
40 | Security definitions disallowed access to this function on the specified subsystem |
48 | Incompatible AOAnywhere versions exist |
52 | Failed attempt to execute this function under NetView without a valid Access NV product key |
56 | BBI-SS PAS is not a BMC AMI OpsA system If this BBI-PAS is meant to be a BMC AMI OpsA PAS, ensure that the BMCPSWD DD of the PAS JCL contains valid BMC AMI OpsA keys and product=AAO is specified in BBISSP00. |
60 | Specified JNT entry could not be located in the PAS that is identified by the SSID() keyword |
64 | The internal load of the CSLOAD module has failed This failure is most likely due to the module not being available in the job's STEPLIB JCL statement. |
68 | A failure has occurred while the EXEC was attempting to write the multi-line WTO of messages that an EXEC returned to AOSUBX Message AW0809E is also issued. |
2048 + return code | When specifying WAIT(Y) and the command was executed successfully, a value 2048 is added to the EXEC’s exit code before the return code is generated Note that WAIT(Y) is required to obtain the exit code which is coded with the IMFEXEC EXIT command of the of the EXEC. |