Command Specifications panel


The first panel displayed from the Object Detail Control panel is the Command Specifications panel.

Related topic

BMC Software --------- Command Specifications for object -------- BMC AMI OpsA
COMMAND ===>                                                  TGT --- NS61
Start Command/EXEC      ===> #S AAO41__________________________________
                             __________________________________________
                             __________________________________________
User Post Start EXEC    ===> __________________________________________
Stop Command/EXEC       ===> #P AAO41__________________________________
                             __________________________________________
                             __________________________________________
User Post Stop EXEC     ===> __________________________________________
Cancel Command/EXEC     ===> __________________________________________
Recovery Command/EXEC   ===> __________________________________________
Start Command Time Out  ===> 0002         Start Command Limit ===> 0003
Stop  Command Time Out  ===> 0002         Start Limit Reset   ===> Y (Y/N)
Conditional Start       ===> N (Y/N)      Conditional Stop    ===> N (Y/N)
Enter END command to process and return to Detail Control, ENTER to continue

The following table describes the fields for the Command Specifications panel.

Field

Description

Start Command/EXEC

Specify the start command or EXEC to start this object.

If you specify a command, enter the same command used to start the object from the MVS console. Prefix the Start command with the appropriate command recognition character. For example, use a pound sign (#) as a prefix for MVS commands:

#S JES2

If the command has any embedded quotation marks, you must use two single quotation marks on each side of the command specified in the Start Command/EXEC field; for example:

#S ACF,PARM=''data''

If you use an EXEC instead of a command, do not prefix the EXEC name with any command characters. Parameters can be passed to the EXEC; for example, to start IMS with a warm start, specify the EXEC as follows:

STARTIMS PROD1 WARM

When the EXEC STARTIMS is scheduled, it will be passed the two parameters PROD1 and WARM.

The EXEC name is limited to eight characters and must be a valid PDS member name. The EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI Ops Automation subsystem address space.

Warning

Important

A Start Command/EXEC is not required for transient objects.


User Post Start EXEC

Specify the name of an optional, user-specified EXEC that CSM will schedule when CSM receives an object’s start message.

When CSM receives the object’s start message, the parameters CSM passes to the User Post Start EXEC include

  • Post Start EXEC name
  • Object name
  • Object status (normal, forced, or abnormal up/down)
  • Start message text ID
  • Remaining words in start message

The User Post Start EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI OpsA subsystem address space.

Stop Command/EXEC

Specify the stop command or EXEC to stop this object normally.

If you specify a command, enter the same command used to end the object from the MVS console.

Prefix the Stop command with the appropriate command recognition character. For example, use a pound sign (#) as a prefix for MVS commands:

#F CICSPAY,CEMT P SHUT

If the command has any embedded quotation marks, you must use two single quotation marks on each side of the command specified in the Stop Command/EXEC field.

If you use an EXEC instead of a command, do not prefix the EXEC name with any command characters. Parameters can be passed to the EXEC in the same way as with a startup EXEC.

The EXEC name is limited to eight characters and must be a valid PDS member name. The Stop EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI OpsA subsystem address space. The Cancel command/EXEC is issued automatically if the Stop command/EXEC times out. See below.

Warning

Important

A Stop Command/EXEC is not required for transient objects.

User Post Stop EXEC

Specify the name of an optional, user-written EXEC that CSM schedules when CSM receives an object’s stop message.

The User Post Stop EXEC can be used to call batch work from the active scheduling product, update or define incident tracking system tickets, or trigger other events that should occur after the object has ended.

The parameters passed to the User Post Stop EXEC are the same as the one you can use for the User Post Start EXEC. The User Post Stop EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI OpsA subsystem address space.

Cancel Command/EXEC

Specify the command or EXEC to cancel this object.

If you specify a command, enter the same command used to cancel the object from the MVS console.

Prefix the Cancel command with the appropriate command recognition character. For example, use a pound sign (#) as a prefix for MVS commands:

#Z NET,CANCEL

If the command has any embedded quotation marks, you must use two single quotation marks on each side of the command specified in the Cancel Command/EXEC field.

If you use an EXEC instead of a command, do not prefix the EXEC name with any command characters. Parameters can be passed to the EXEC.

The Cancel EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI OpsA subsystem address space. The Cancel command/EXEC is automatically issued if the Stop command/EXEC times out.

Recovery Command/EXEC

Specify the command or EXEC name of an optional, user-specified EXEC that CSM schedules when CSM receives an object’s abnormal termination message.

If you specify a command and the command has any embedded quotation marks, you must use two single quotation marks on each side of the command specified in the Recovery Command/EXEC field.

When CSM receives the object’s abnormal termination message, the parameters CSM passes to the Recovery Command/EXEC include

  • Recovery EXEC name
  • Object name
  • Object status (which is ABENDDOWN)
  • Abnormal termination message text ID
  • Remaining words in the message

The Recovery EXEC must reside in a library in the SYSPROC concatenation of the BMC AMI OpsA subsystem address space.

Start Command Time Out

Enter a number from 1 to 1440 (in minutes) that CSM waits to verify the Start commands.

Rather than just changing the object’s state when a Start command is issued, CSM waits for the confirmation message to indicate that the Start command was processed properly.

The Start Command Time Out parameter indicates to CSM how long it should wait for this confirmation message before posting an ALERT to the ALERT Management Facility to report the failed command.

Format: mmmm, where m=minutes

Range: 1 through 1440 minutes

Stop Command Time Out

Enter a number from 1 to 1440 (in minutes) that CSM waits to verify the Stop commands.

Rather than just changing the object’s state when a Stop command is issued, CSM waits for the confirmation message to indicate that the Stop command was processed properly.

The Stop Command Time Out parameter indicates to CSM how long it should wait for this confirmation message before posting an ALERT to the ALERT Management Facility to report the failed command.

Format: mmmm, where m=minutes

Range: 1 through 1440 minutes

If you define a Cancel command/EXEC for an object, CSM automatically issues this command when the Stop command/EXEC reaches the time out limit set in this field.

Start Command Limit

Specify how many times during a 24-hour period that CSM will automatically issue the start commands for an object.

For example, you can specify that CSM will automatically attempt restarts for three abends of an object. If the restart fails, an ALERT is issued.

The count of retries is reset when the object stops normally, at midnight every night, and when you issue the line command Reset.

For example:

  • If you specify 0, CSM does not ever attempt to start the object.
  • If you specify 1, CSM attempts to start the object once with no retries.
  • If you specify 4, CSM attempts to start the object once and then tries three more times if the object terminates unexpectedly.

If restarting fails at any attempt, an ALERT is issued.

After unsuccessfully restarting the object the specified number of times, CSM generates an ALERT to the ALERT Management Facility that the number of retries for the specified object has been reached. An EXEC associated with the ALERT will start the object. No further restarts can be attempted until the start command counter is reset.

Format: xxxx for 4 positions

Range: 0 to 9999

Start Limit Reset

Prevent an abnormally terminating object from endlessly restarting and terminating CSM; holds a Start Command Limit for the object.

When the object is started an internal command count for the object is compared to the Start Command Limit value. If the value is exceeded, the object is not restarted.

Format: Y or N

Y: If the object is in an UP state or is a transient, its command count will be set to 1. Otherwise the command count will be set to 0. The count will be set each day at midnight.

N: Do not reset the command count for this object at midnight.

Conditional Start

Specify additional object Start commands.

Use conditional commands when an object requires more than one command in order to be started or a user wants to issue an additional command if the object does not start within a prescribed period of time.

Format: Y or N

Y: Allow user to specify Conditional Start commands.

N: Do not allow user to specify Conditional Start commands.

Conditional Stop

Specify additional object Stop commands.

Use conditional commands when an object requires more than one command in order to be stopped or a user wants to issue an additional command if the object does not stop within a prescribed period of time.

Format: Y or N

Y: Allow user to specify Conditional Stop commands.

N: Do not allow user to specify Conditional Stop commands


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Ops Automation 8.4