Add Command CRQ Activity (ADDCMDCRQA)

The Add Command Change Request Activity (ADDCMDCRQA) command adds an activity to a change request description to run a command on one or more managed systems.

The activity can be conditioned so that it only runs after one or more other activities have completed (successfully or unsuccessfully). The activity can also be scheduled to run at a date and time in the future.

Restrictions:

  1. You must have *CHANGE authority to the change request description and *EXECUTE authority to the library.
  2. If a node list (NODL) value is specified, the node list can only contain entries that have a value of *SNA for the address type.

Notes:

The following notes provide information on how the command works.

  1. Authorization to the product specified on the activity is not verified until the activity runs.
  2. All conditions must be satisfied before the activity can run.
  3. The start times indicate when the activity can be started. Actual start times can be later due to network and system delays.

Parameters

Keyword Description Choices Notes
CRQD Change request description Qualified object name Required, Positional 1
Qualifier 1: Change request description Name
Qualifier 2: Library Name, *LIBL, *CURLIB
ACTIVITY Activity Name, *GEN, *LAST Optional, Positional 2
CMD Command to run Command string Optional, Positional 3
NODL Managed systems node list Element list Optional
Element 1: Node list Single values: *NONE
Other values: Qualified object name
Qualifier 1: Node list Name
Qualifier 2: Library Name, *LIBL, *CURLIB
CPNAME Managed system node names Single values: *LOCAL, *NONE
Other values (up to 50 repetitions): Element list		 Optional
Element 1: Network identifier Communications name, *NETATR
Element 2: Control point Communications name
RMTSTRTIME Start time on managed system Element list Optional
Element 1: Time zone *LCLSYS, *MGDSYS
Element 2: Start after Element list
Element 1: Time Time, *CURRENT
Element 2: Date Date, *CURRENT, *NEXT
Element 3: Start before Element list
Element 1: Time Time, *ANY, *CURRENT
Element 2: Date Date, *ANY, *CURRENT, *NEXT
RTNSPLF Return spooled file *YES, *NO, *FAIL Optional
USRPRF User profile Simple name, *NONE Optional
PASSWORD Password Character value, *USRPRF, *NONE Optional
ENCODE Encode command *YES, *NO Optional
TEXT Text 'description' Character value, *GEN Optional
COND Activity conditions Single values: *NONE
Other values (up to 5 repetitions): Element list		 Optional
Element 1: Activity Generic name, name, *PRV
Element 2: Relational operator *EQ, *GT, *LT, *LE, *NE, *GE
Element 3: End code 0-99, *SUCCESS, *FAIL, *NOTRUN, *ANY
Element 4: Condition mode *ALLNODES, *SAMENODE
STRTIME Activity start time Element list Optional
Element 1: Start after Element list
Element 1: Time Time, *CURRENT
Element 2: Date Date, *CURRENT, *NEXT
Element 2: Start before Element list
Element 1: Time Time, *ANY, *CURRENT
Element 2: Date Date, *ANY, *CURRENT, *NEXT
HOLD Hold activity *NO, *YES Optional

Change request description (CRQD)

Specifies the change request description object name.

The possible library values are:

*LIBL
All of the libraries in your library list and in the system portions of the job's library list are searched.
*CURLIB
The current library for the job is used to locate the object.
library-name
Specify that only the library named in this parameter is searched.

The possible change request description value is:

change-request-description
Specify the name of the change request description object.

Activity (ACTIVITY)

Specifies the name of the activity to add to the change request description.

*GEN
An activity name is generated. The activity name is of the form QACTxxxxxx where xxxxxx is the first multiple of ten not already being used.
*LAST
The activity is the last to run in the change request. When *LAST is specified for the activity (ACTIVITY) parameter, the condition (COND) parameter and the start time (STRTIME) parameter cannot be specified. Only one activity named *LAST can exist in the change request description.
activity-name
Specify a 10-character activity name.

Command to run (CMD)

Specifies the CL command to run. The command can be any command that can be run in batch. The command must follow the CL command format of 1 to 10 characters with the first character in alphabetic order and the other nine characters alphanumeric.

command-string
Specify the command to run on the managed system. Command prompting support is available if you press F4.

Managed systems node list (NODL)

Specifies that the node list parameter is the object name that contains a list of systems which are the destinations for the activity. This parameter cannot be specified if the control point name (CPNAME) parameter is specified.

The possible values are:

*NONE
The systems on which this activity is to be performed are not specified by a node list. Individual control point names must be specified.

The possible values are:

*LIBL
All of the libraries in the user and system portions of the job's library list are searched for the node list object.
*CURLIB
The current library for the job is used to locate the node list object.
library-name.
Specify the name of the library to be searched.

The possible node list name value is:

node-list-name
Specify the node list object name containing the list of systems on which the activity is to be performed.

Managed system node names (CPNAME)

Specifies the APPN control point names of the managed systems on which this activity is to be performed. Control point names cannot be specified if the node list (NODL) parameter is specified.

The possible values are:

*LOCAL
The local system is identified as the target system. If *LOCAL is specified, the command is run on the local system. Any spooled files created remain on the system.
*NONE
The systems on which this activity is to be performed are not identified individually. A node list must be specified.
*NETATR
The network ID of the local system is used. This is useful when the node being specified is in the same network as the local system.
network-identifier
Specify the APPN network identifier of the managed system on which the activity is to be performed.

The possible control point value is:

control-point-name
Specify the APPN control point name of the managed system on which the activity is to be performed.

Start time on managed system (RMTSTRTIME)

Specifies the date and time when the activity can begin running on the managed system. The current date and time values, and the next date values are determined when the activity begins running at the central site system based on the central site date and time.

The possible time zone values are:

*LCLSYS
The remote start time is specified in the time zone of the central site system.
*MGDSYS
The remote start time is specified in the time zone of the managed system.

The possible start after time values are:

This is the definition of the time after which the activity is to start.

*CURRENT
This function can start on the managed system at any time on or after the time this activity is started on the date specified in element 3.
start-after-time
Specify the time after when this function can start on the managed system. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where, hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start after date values are:

*CURRENT
This function starts on the managed system on any date on or after the activity starts on the central site system.
*NEXT
This function starts on the managed system on any date after the activity starts on the central site system.
start-after-date
Specify the date after the functions start on the managed system. The date must be specified in the job date format.

The possible start before time values are:

This element is ignored if start before time is *ANY.

*ANY
The activity can start at any time on or after the start time.
*CURRENT
The activity must start before the time at which the change request was submitted on the date specified on the start before date element.
start-before-time
Specify the time before which the activity must be started. If the activity cannot be started before this time, it never starts. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start before date values are:

*ANY
The activity can start at any date on or after the start date.
*CURRENT
The activity must start on the date the change request was submitted.
*NEXT
The activity must start by the day after the date the change request was submitted.
start-before-date
The date before which the activity must be started. If the activity cannot be started by this date, it never starts. The date must be specified in the job date format.

Note:

The special values *CURRENT and *NEXT cannot be specified for the date and the time if the time zone value *MGDSYS is specified.

Return spooled file (RTNSPLF)

Specifies whether the output spooled file from the remote command is returned.

The possible values are:

*YES
The spooled files created from the remote command are returned from the managed system. The spooled files from all of the nodes are combined into one spooled file that can be viewed by displaying the command activity details of the change request.
*NO
The output data is not returned from the managed system.
*FAIL
The spooled file job log is returned from the managed system if the command fails when running.

User profile (USRPRF)

Specifies the user profile under which the command runs at the remote systems. If the remote system is running the NetView Remote Operations Agent/400 product this parameter is ignored at the remote systems.

The possible values are:

*NONE
No user profile is specified. The default user profile is used on each managed system.
user-profile
Specify the name of the user profile.

Password (PASSWORD)

Specifies the password for the remote user profile.

The possible values are:

*NONE
No password is specified.
*USRPRF
The password is the same as the user profile.
password
Specify the password for the user profile.

Encode command (ENCODE)

Specifies whether or not the command, user profile, and password are encoded when sent to the managed systems. If the managed system is running the NetView Remote Operations Agent/400 product, this parameter must be to *NO.

The possible values are:

*NO
The command, user profile, and password are not encoded when the request is sent to the managed systems.
*YES
The command, user profile, and password are encoded when the request is sent to the managed systems. The remote command key, which is a managed system attribute, must be specified on both the central site system and the managed system. This attribute can be changed using the Change Managed System Attributes (CHGMGDSYSA) command. The remote command key must be the same on the central site system and the managed system.

Text 'description' (TEXT)

Specifies the activity description.

*GEN:
A description is generated based on the action specified.
text-description
Specify a 50-character description of the activity.

Activity conditions (COND)

Specifies which conditions must be met before this activity can be performed. Each condition identifies an activity which must run before this activity and the value the end code from that activity must have to allow this activity to run. The default condition is that the previous activity (in alphabetical order) must complete successfully before this activity can be run.

The possible conditioning activity values are:

The activity which must be run before this activity.

*PRV
This activity is conditioned on the previous activity. Activities are ordered alphabetically by activity name. If the activity being added is the first activity, a previous activity does not exist and any condition with *PRV is marked as having been met.
conditioning-activity-name
Specify the name of this activity which must run before this activity. The activity name specified in the activity (ACTIVITY) parameter cannot be specified in the conditioning activity name. An activity cannot be conditioned on itself.
generic*-conditioning-activity-name
Specify the generic name of the activities which must run before this activity.

The possible relational operator value is:

This element is the relational operator to use when comparing the end code from the conditioning activity.

*EQ
Equal
*GT
Greater than
*LT
Less than
*NE
Not equal
*GE
Greater than or equal
*LE
Less than or equal

The possible condition code value is:

This element is the value compared to the actual end code of the conditioning activity.

*SUCCESS
The activity ended successfully (0 <= end code <= 9). This end code can only be specified with relational operator *EQ or *NE.
*FAIL
The activity failed (10 <= end code <= 89). This end code can only be specified with relational operator *EQ or *NE.
*NOTRUN
The activity never started (90 <= end code <= 99). This end code is only specified with relational operator *EQ or *NE.
*ANY
The activity ended with any end code. This end code is only specified with relational operator *EQ.
end-code
Specify an integer value (0-99) that indicates the result of an activity (success or failure). The end code ranges and descriptions are the following:
00
Activity completed successfully.
01-09
Activity completed with warning messages.
10-29
Activity did not complete successfully.
30-39
Activity was canceled by a user before it completed.
  • 30 = Activity ended with *CNTRLD option
  • 35 = Activity ended with *IMMED option
  • 39 = Activity ended with *FRCFAIL option
40-49
Activity was not run due to errors detected by the application.
  • 40 = Activity not run for security reasons
90-99
Activity was not run because conditions or schedules were not met.
  • 95 = Scheduled start time expired
  • 99 = Conditions cannot be met

The possible condition mode values are:

This element indicates which systems the conditioning activity must have completed on before this activity can be performed.

*ALLNODES
The conditioning activity specified must complete on all nodes before this activity can run.
*SAMENODE
When the conditioning activity specified completes for a given node, the activity specified on the ACTIVITY parameter may run for that same node even though the conditioning activity specified may not have completed on all other nodes. In the case where this activity lists a node not in the conditioning activity, this activity may run for that node; the condition is ignored.

The possible value is:

*NONE
There are no conditions for this activity.

Activity start time (STRTIME)

Specifies the date and time when this activity can be started on the central site system. The current date and time values and next date values are determined when the change request is submitted.

The possible start after time values are:

*CURRENT
This activity can start any time on or after the time when the change request is submitted.
start-after-time
Specify the time when this activity can start. The time can be entered as 4 or 6 digits (hhmm or hhmmss), where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator such as a colon (:). With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start after date values are:

*CURRENT
This activity can start on or after the date on which the change request is submitted.
*NEXT
The activity can start on any date after the date the change request is submitted.
start-after-date
Specify the date after this activity can start. The date must be specified in the job date format.

The possible start before time values are:

This element is ignored if the start before date is *ANY.

*ANY
The activity can start at any time on or before the start before date.
*CURRENT
The activity must start before the time at which the change request was submitted on the date specified on the start before date element.
start-before-time
Specify the time before which the activity must start. If the activity cannot be started before this time, it never starts. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator such as a colon (:). With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start before date values are:

*ANY
The activity can start at any time after the start after time and the start after date.
*CURRENT
The activity must start on the date the change request is submitted.
*NEXT
The activity must start by the day after the date the change request is submitted.
start-before-date
Specify the date before the activity must start. If the activity is not started by this date, it never starts. The date must be specified in the job date format.

Hold activity (HOLD)

Specifies that the activity be held when the change request is submitted.

*NO
The activity is not held. It runs when all conditions are met at the start time.
*YES
The activity is held when the change request is submitted. It must be released by you before it runs.

Examples

Example 1: Adding an Activity 

ADDCMDCRQA   CRQD(MYLIB/CR1)  ACTIVITY(ACT01)  CMD(STRSBS QCMN)

This example shows how activity ACT01 is added to change request description CR1 in library MYLIB to start the QCMN subsystem on the central site system. The activity runs as soon as the change request is submitted.

Example 2: Adding an Activity for a Node list 

ADDCMDCRQA   CRQD(MYLIB/CR2)  ACTIVITY(ACT01)
             CMD(STRSBS QSNADS)  NODL(MYLIB/STORES)
             CPNAME(*NONE) RTNSPLF(*FAIL)

This example shows how activity ACT01 starts the subsystem QSNADS on the systems identified in the STORES node list in the library MYLIB. The example also asks for the spooled file to be returned to the central site system if the command fails.

Example 3: Adding an Activity for Two Systems 

ADDCMDCRQA   CRQD(MYLIB/CR3)  ACTIVITY(ACT01)
             CMD(PRODLIB/RUNREPORTS)
             CPNAME((STORENET STOREA) (STORENET STOREB))
             USRPRF(REPORTOPER)  PASSWORD(OPERPASS)
             ENCODE(*YES)

This example shows how activity ACT01 runs the detail reports for STOREA and STOREB in the STORENET network. The report runs under the REPORTOPER user profile on the managed systems. Because the user profile and a password are supplied, the request will be encoded when sent to the managed system.

Error messages

None