Add CRQ Activity (ADDCRQA)

The Add Change Request Activity (ADDCRQA) command adds a change management activity to a change request description. The change management action that is to be performed by the added activity depends on the value specified on the action parameter.

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

Restrictions:

Note: If you need to cancel an installation of a NetView Distribution Manager (NetView DM) change file or other non-IBM i object, you must use the Add Change Management Activity (QNSADDCM) API.

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
ACTION Action *ACP, *ACT, *DLT, *INS, *RMV, *RTV, *RUN, *SND, *SNDINS, *SNDRUN, *UNINS Optional, Positional 3
GLBNAME Global name Element list Optional
Element 1: Global name token 1 Character value, *NETID, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 2: Global name token 2 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 3: Global name token 3 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 4: Global name token 4 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 5: Global name token 5 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 6: Global name token 6 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 7: Global name token 7 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 8: Global name token 8 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 9: Global name token 9 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 10: Global name token 10 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
COMPNAME Component name Element list Optional
Element 1: Component name token 1 Character value, *NETID
Element 2: Component name token 2 Character value, *NETID, *CPNAME
Element 3: Component name token 3 Character value, *NETID, *CPNAME
Element 4: Component name token 4 Character value, *NETID, *CPNAME
Element 5: Component name token 5 Character value, *NETID, *CPNAME
Element 6: Component name token 6 Character value, *NETID, *CPNAME
Element 7: Component name token 7 Character value, *NETID, *CPNAME
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: *NONE
Other values (up to 50 repetitions): Element list
Optional
Element 1: Network identifier Communications name, *NETATR
Element 2: Control point Character value
TEXT Text 'description' Character value, *GEN, *BLANK Optional
ACTFRC Activation force Single values: *YES
Other values: Element list
Optional
Element 1: Activation force *NO
Element 2: Delay units *SECONDS, *MINUTES, *HOURS
Element 3: Delay period 1-65535, 3600
ACTUSEACT Activation use on activate *BOTH, *PROD, *LAST, *NONE Optional
CPRTYPE Compression type *ADAPTIVE, *SNA, *USER, *NONE Optional
SNACPRCHR SNA compression character Hexadecimal value, *BLANK Optional
USRCPRINF User compression information Element list Optional
Element 1: User compression name Name
Element 2: User parameters Character value
CPRSTGSTT Compression storage state *DECOMPRESS, *COMPRESS, *NONE Optional
CPRTFRSTT Compression transfer state *DECOMPRESS, *COMPRESS, *NONE Optional
ACTUSEINS Activation use on install *PROD, *TRIAL Optional
ALTACTCOMP Alter active components *ALLOWED, *NOTALLOWED, *NONE Optional
AUTOACP Auto accept Single values: *NONE, *NO
Other values: Element list
Optional
Element 1: Auto accept *YES, *DESIRED
Element 2: Delay days 0-255
AUTORMV Auto remove *YES, *NO, *DESIRED, *NONE Optional
PRETEST Pre test *YES, *NO, *DESIRED Optional
POSTTEST Post test *YES, *NO, *DESIRED Optional
ALWRMV Allow remove *NO, *DESIRED, *YES Optional
PARM Initiate parameters Values (up to 40 repetitions): Not restricted Optional
KEEPOBJ Keep object *YES, *NO, *NONE Optional
COREQCHGNL Corequisite change name list Single values: *NONE
Other values: Element list
Optional
Element 1: Global name Values (up to 6 repetitions): Element list
Element 1: Global name token 1 Character value
Element 2: Global name token 2 Character value
Element 3: Global name token 3 Character value
Element 4: Global name token 4 Character value
Element 5: Global name token 5 Character value
Element 6: Global name token 6 Character value
Element 7: Global name token 7 Character value
Element 8: Global name token 8 Character value
Element 9: Global name token 9 Character value
Element 10: Global name token 10 Character value
REPLACE Replace object *YES, *ALLOWED, *NO Optional
TODLTNAME To be deleted name Single values: *NONE
Other values: Element list
Optional
Element 1: To be deleted name token 1 Character value, *NETID, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 2: To be deleted name token 2 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 3: To be deleted name token 3 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 4: To be deleted name token 4 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 5: To be deleted name token 5 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 6: To be deleted name token 6 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 7: To be deleted name token 7 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 8: To be deleted name token 8 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 9: To be deleted name token 9 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
Element 10: To be deleted name token 10 Character value, *ANY, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME
REFLVL Refresh level Character value Optional
FRCUNINS Force uninstall *YES, *NO Optional
RMTSTRTIME Start time on managed system Single values: *NONE
Other values: 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
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 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 will be 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.

Action (ACTION)

Specifies the change management action to be performed by the added activity.

*ACP
Causes the managed system to accept a previously installed object. The activity relinquishes resources at a managed system required to maintain removability of a change. This cancels the removability of a change previously installed in a removable manner. The resources released are, typically, unaltered versions of components affected by the change.
*ACT
Causes the managed system to activate all previously installed changes. Each managed system implements the activation in its own way. For example, the activity performs an initial program load (IPL) of a managed iSeries system or activates a configuration on a PS/2 and causes the PS/2 to restart.
*DLT
Requests a delete action at one or more managed systems.
*INS
Requests the installation of up to seven objects. The objects are treated as corequisites, which means that either all installations succeed or all do not. The activity uses an object and its corequisites, if any, to alter all components necessary to effect the change. The managed system can perform such alteration in a removable manner if required, so that a subsequent request (remove) can return all those components to their original condition prior to the alteration. Also automatic removal or automatic acceptance is possible.
*RMV
The activity, when run at the managed system, returns (that is, removes) all components previously altered in connection with a change to their condition prior to the installation of the change. This is possible only for changes previously installed in a removable manner.
*RTV
Retrieves an object identified by its global name, from a managed system or from another central site system, for storage at the central site system. To retrieve an object from more than one system, a global name with an *ANY token is required, so that each retrieved object has a unique global name. Global names with unspecified tokens (*ANY, *HIGHEST, or *LOWEST) are stored in the distribution repository when they are retrieved.
*RUN
Causes a program or procedure to be run at one or more managed systems.
*SND
Sends an object from the central site system to one or more managed systems or to another central site system.
*SNDINS
Sends an object from the central site system to one or more managed systems and installs the object at the managed system.
*SNDRUN
Sends an object from the central site system to one or more managed systems and runs the object at the managed system.
*UNINS
Removes (that is, uninstalls) a previously installed component from a managed system. The component may have originally been built from the installation of multiple objects, all of which are removed.

Global name (GLBNAME)

Specifies a global name, which is a series of tokens that uniquely identify an object in an SNA network. The global name represents the name that is used to locate the appropriate catalog entry on both the central site system and the managed systems. The catalog entry specifies the object that is to be used on that system. For example, if a retrieve action is specified, the global name is used to determine the object that is to be retrieved on the managed system. Also, the global name shows the location where it is to be stored on the central site system.

Special values in a token position indicate how to search for the object. By specifying *ANY in a token position, the token is ignored when searching for the correct object.

If an object is sent, the global name must have been previously cataloged so that it is associated with a local object name or associated with an object in the distribution repository. Retrieved objects, for which no catalog entry exists, are placed in the distribution repository.

Special values other than *SERVER, *TARGET, *MDDATE, and *MDTIME in a token position are allowed only for the following actions: *DLT, *RTV, *SND, *SNDRUN, or *SNDINS. The special values allowed for the first token are *NETID, *SERVER, *TARGET, *MDDATE, and *MDTIME.

Element 1: Token 1

The possible values are:

*NETID
The first global name token value is a network ID generated by the command from the network attributes. The network ID is determined by the current value of the LCLNETID network attribute value.
global-name-token-1
Specify the first token of the global name. The first token is recommended to be the registered enterprise ID or network ID.

Element 2-10: Token 2-10

The possible values are:

*ANY
Any token value matches when searching for the object where the action is to be performed.
*HIGHEST
The object with the highest token value has the action performed on it. The token must be ordered. This useful when a token in a global name is used to indicate a different version of the object and you need to manipulate the object with the highest version level.
*LOWEST
The object with the lowest token value has the action performed on it. The token must be ordered. This is useful when a token in global name is used to indicate a different version of the object and you need to manipulate the object with the lowest version level.
*NETID
The network ID of this system is used. The network ID is determined by the current value of the LCLNETID network attribute value.
*CPNAME
The control point name of this system is used. The control point name is determined by the current value of the LCLCPNAME network attribute value.
*SERVER:
This token is stored within the change request activity with the value &SERVER, and is replaced by the short name of the change control server when the object is distributed.
*TARGET:
This token is stored within the change request activity with the value &TARGET, and is replaced by the short name of the target when the object is distributed.
*MDDATE:
This token is stored within the change request activity with the value &DATE, and is replaced when distributed by the date the object was last modified.
*MDTIME:
This token is stored within the change request activity with the value &TIME, and is replaced when distributed by the time the object was last modified.
global-name-token-n
Specify one of a series of 1 to 16 character tokens that uniquely identify the object on which the action is to be performed. Characters A through Z and 0 through 9 can be used. Other special values (@, #, and $) can be used for tokens that represent network IDs and system names.

Note: GLBNAME is valid only when ACTION(*ACT) is not specified.

Component name (COMPNAME)

Component name, which is the set of global name tokens previous to the REF, FIX, or UPD subtree indicator (STI) tokens. The component name is used to identify the installable object that must be uninstalled from the managed system. The maximum number of tokens allowed is 7. The component name is used to identify the installable object that must be uninstalled from the managed system.

Note: COMPNAME is only valid when ACTION(*UNINS) is specified.

Element 1: Token 1

The only special value allowed for the first token is *NETID.

The possible values are:

*NETID
The network ID of this system is used. The network ID is determined by the current value of the LCLNETID network attribute value.
component-name-token-1
One of a series of 1 to 16 character tokens that uniquely identifies the object on which the action is to be performed. Characters A through Z and 0 through 9 can be used. Other special values (@, #, and $) can be used for tokens that represent network IDs and system names.

Elements 2-7: Tokens 2-7

*NETID
The network ID of this system is used. The network ID is determined by the current value of the LCLNETID network attribute value.
*CPNAME
The control point name of this system is used. The network ID is determined by the current value of the LCLCPNAME network attribute value.
component-name-token-n
One of a series of 1 to 16 character tokens that uniquely identifies the object on which the action is to be performed. Characters A through Z and 0 through 9 can be used. Other special values (@, #, and $) can be used for tokens that represent network IDs and system names.

Managed systems node list (NODL)

Specifies that the node list parameter is the object name that contains a list of systems that are the destinations for the activity. This parameter cannot be specified if the control point name (CPNAME) parameter is also 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.
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. CPNAME is required unless NODL is specified.

The possible values are:

*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. For NetView Distribution Management Agents, the network identifier is the change control server name.
control-point-name
Specify the APPN control point name of the managed system on which the activity is to be performed. For NetView Distribution Management Agents, the control point name is the change control client which supports numeric characters (0-9) in the first position of control point names that are valid in other platforms.

Text 'description' (TEXT)

Specifies the activity description.

*GEN
A text description should be generated for the activity being added. The text description should be generated based the verb specified on the ACTION parameter. The text descriptions generated are:
  • Accept object
  • Restart the system
  • Delete object
  • Run object
  • Install object
  • Remove object
  • Retrieve object
  • Send object
  • Send and run object
  • Send and install object
  • Uninstall object
*BLANK
No text is specified.
text-description
Specify a 50-character textual description of the activity.

Activation force (ACTFRC)

Specifies whether or not the managed system should proceed with the activation based on its quiesced state.

activation force
Specify the activation force value.
*NO
The managed system will not proceed with the activation if the quiesce check shows that the managed system is still active.
delay units
Indicates the unit of time on which the delay period is specified.
*SECONDS
The delay period will be specified in seconds.
*MINUTES
The delay period will be specified in minutes.
*HOURS
The delay period will be specified in hours.
delay period
Specifies the maximum amount of time that the managed system may wait to quiesce (if not already quiesced) before taking the action specified:
3600
The delay period default is 3600 seconds.
1-65535
Delay period range.
*YES
The managed system will proceed with the activation even if the quiesce check shows that the managed system is still active. Delay units and delay period are ignored when activation force is *YES.

Note: ACTFRC is valid only when ACTION(*ACT) is specified.

Activation use on activate (ACTUSEACT)

Activation use on activate. Specifies which components altered by changes will be used during the activation.

*NONE
No activation use on activate is specified.
*BOTH
Both trial and production version.
*PROD
Production version only.
*LAST
Last used; either both trial and production or production only.

Note: ACTUSEACT is valid only when ACTION(*ACT) is specified.

Compression type (CPRTYPE)

Specifies the compression algorithm and related information associated with the compression of a particular change object. When one or both of the compression transfer state or compression storage state parameter specify *COMPRESS, this parameter must be present and one (and only one) of the adaptive compression, SNA compression, or user compression algorithms may be requested. This support is dependent on the implementation on the managed system.

*NONE
No compression type is specified.
*ADAPTIVE
Specifies whether or not adaptive compression pertains to the requested object. The iSeries system does not support *ADAPTIVE.
*SNA
Specifies whether or not SNA compression pertains to the requested object.
*USER
Specifies whether or not a named user compression pertains to the requested object.

Notes:

  1. CPRTYPE is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN), or ACTION(*SNDINS) is specified
  2. CPRTYPE cannot be specified when CMPSTGSTT and CPRTFRSTT are not specified.
  3. CPRTYPE cannot be specified when CMPSTGSTT is *DECOMPRESS and CPRTFRSTT is not specified.
  4. CPRTYPE cannot be specified when CPRSTGSTT is not specified and CPRTFRSTT is *DECOMPRESS.
  5. CPRTYPE cannot be specified when CPRSTGSTT and CPRTFRSTT are *DECOMPRESS.

SNA compression character (SNACPRCHR)

Specifies information about the SNA compression algorithm as it pertains to the requested object. If omitted, the implication is that SNA compression does not pertain to the requested object.

*BLANK
When SNA compression is requested, it is optionally specified with the implied default being the (X'40') character. Otherwise, it is not specified.
SNA-prime-character
The prime compression character to be associated with the single control byte (SCB) used by the SNA compression algorithm. Valid values are '00'X - 'FF'X

Note: SNACPRCHR is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

User compression information (USRCPRINF)

Specifies information about a named user compression algorithm as it pertains to the requested object. If omitted, the implication is that user compression does not pertain to the requested object.

user-compression-name
The name of the user compression algorithm that pertains to the requested object. It should be specified when user compression is requested. Otherwise, it is not specified.
user-parameters
User parameters that apply to the user compression algorithm named in the user compression name. It is optionally specified when user compression is requested. Otherwise, it is not specified.

Note: USRCPRINF is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

Compression storage state (CPRSTGSTT)

Specifies whether or not the object should be stored in compressed format at the managed system once the object is sent.

*NONE
No compression storage state is specified.
*DECOMPRESS
Store the object in a decompressed format at the managed system. If the object is already decompressed when it arrives to the managed system, store it as received. Otherwise, decompress the object using the compression method used to catalog the object in the managed system before storing it.
*COMPRESS
Store the object in a compressed format at the managed system. When this value is specified, the compression algorithm must also be specified. If the object is already compressed when it arrives at the managed system, store the object as received. Otherwise, compress the object using the compression algorithm before storing it.

Note: CPRSTGSTT is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

Compression transfer state (CPRTFRSTT)

Specifies whether or not the object should be transferred to the managed system in compressed format.

*NONE
No compression transfer state is specified.
*DECOMPRESS
Transfer the object in decompressed format to the managed system. If already decompressed at the source, transfer the object as stored. Otherwise decompress the object using the compression method used to catalog the object in the managed system before sending it.
*COMPRESS
Compress the object using the compression algorithm and transfer the object in compressed format to the managed system. When this value is specified, the compression algorithm must also be specified. If the object is already compressed using a different algorithm at the source, decompress the object using the compression method used to catalog the object in the managed system before compressing and transferring it.

Note: CPRTFRSTT is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

Activation use on install (ACTUSEINS)

Specifies whether the component to be altered by the installation process will be trial version or production version. If activation use on install is *TRIAL, it means the object should be installed in the trial area to be tested. Removability must then be *YES.

*PROD
Production version only.
*TRIAL
Trial version only.

Note: ACTUSEINS is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Alter active components (ALTACTCOMP)

Specifies whether or not the managed system is allowed to apply the component alterations to the active system. If alterations cannot be applied, then such action is to be deferred until the next activation. This parameter is only allowed for *SNDINS action.

*NONE
No alter active component is specified.
*ALLOWED
Managed system is allowed to apply the component alterations to the active system.
*NOTALLOWED
Managed system is not allowed to apply the component alterations to the active system.

Note: ALTACTCOMP is valid only when ACTION(*INS), ACTION(*SNDINS), ACTION(*RMV), or ACTION(*UNINS) is specified.

Auto accept (AUTOACP)

Specifies whether the managed system accepts objects automatically if installation and any tests performed are successful, in order to release resources required to maintain removability as soon as possible. Like a separate accept request, the managed system deletes the objects after successful automatic acceptance.

*NONE
No auto accept is specified.
*NO
Do not perform automatic acceptance.
auto accept
Auto acceptance possible values:
*YES
Perform automatic acceptance.
*DESIRED
Perform automatic acceptance, if the specified managed system supports it.

The possible values are:

delay
Specifies the number of days the entry point is expected to wait before accepting the object automatically.
delay-days
Valid range of days is 0-255.

Note: AUTOACP is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Auto remove (AUTORMV)

Specifies whether or not the managed system removes the object automatically if failure by either installation or a test.

*NONE
No auto remove is specified.
*DESIRED
Perform automatic removal if the specified managed system supports it.
*YES
Perform automatic removal.
*NO
Do not perform automatic removal.

Note: AUTORMV is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Pre test (PRETEST)

Specifies whether or not the entry point is to perform a test on the objects prior to installing them.

*DESIRED
Perform a pretest if the specified managed system supports it.
*YES
Perform a pretest.
*NO
Do not perform a pretest.

Note: PRETEST is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Post test (POSTTEST)

Specifies whether or not the entry point is to perform a test on the objects after installing or removing them.

*DESIRED
Perform a posttest if the specified managed system supports it.
*YES
Perform a posttest.
*NO
Do not perform a posttest.

Note: POSTTEST is valid only when ACTION(*INS), ACTION(*SNDINS) or ACTION(*RMV) is specified.

Allow remove (ALWRMV)

Specifies whether or not objects are to be installed in a removable manner (so that a subsequent remove action can be issued against the objects).

*YES
Install the object in a removable manner.
*DESIRED
Install the object in a removable manner if the specified managed system supports it.
*NO
Do not install the object in a removable manner.

Note: ALWRMV is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Initiate parameters (PARM)

Specifies the parameters to be passed to the program to be run.

parameter data
Specifies the parameters to be passed when starting the program. Each parameter is a 1 to 253 character. The initial display allows 25 characters to be typed. By typing an & in position 1, the field expands to accommodate longer parameters. If the parameters include blanks or special characters, enclose them in apostrophes.

Note: PARM is valid only when ACTION(*RUN) or ACTION(*SNDRUN) is specified.

Keep object (KEEPOBJ)

Specifies whether or not the object should be kept or deleted after the function has been successfully performed.

*NONE
No keep object is specified.
*YES
The object should be kept after performing the function.
*NO
The object should be deleted after performing the function.

Note: KEEPOBJ is valid only when ACTION(*RUN), ACTION(*INS), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

Corequisite change name list (COREQCHGNL)

Specifies a list of SNA/file services (SNA/FS) global names identifying the names of objects that are to be installed by the entry point as a part of the installation of the object to be retrieved. A maximum of six corequisite change names are allowed. The global name is a unique name you assign to the object so that it is not confused with any other object in a network. The global name represents the name that will be used to locate the appropriate catalog entry on both the central site and managed systems.

*NONE
No corequisite change name list is specified.
global-name-token
One of a series of 1-16 character tokens that uniquely identify the object on which the action is to be performed. Characters A through Z and 0 through 9 may be used. Other special values (@, #, and $) may be used for tokens that represent network IDs and system names.

Note: COREQCHGNL is valid only when ACTION(*INS) or ACTION(*SNDINS) is specified.

Replace object (REPLACE)

Specifies whether the object should be replaced if it already exists.

*NO
The object must be added.
*YES
The object must be replaced.
*ALLOWED
The object should be replaced or added.

Note: REPLACE is valid only when ACTION(*RTV), ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.

To be deleted name (TODLTNAME)

Specifies the name of the object, at the managed system location, that is to be deleted.

Special values in a token position indicate how to search for the object. By specifying *ANY in a token position, the token is ignored when searching for the correct object.

*NONE
No to be deleted name is specified.

The special values allowed for the first token are: *NETID, *SERVER, *TARGET, *MDDATE, and *MDTIME.

Element 1: Token 1

The possible values are:

*NETID
The first global name token value is a network ID generated by the command from the network attributes. The network ID is determined by the current value of the LCLNETID network attribute value.
*SERVER:
This token is stored within the change request activity with the value &SERVER, and is replaced by the short name of the change control server when the object is deleted.
*TARGET:
This token is stored within the change request activity with the value &TARGET, and is replaced by the short name of the target when the object is deleted.
*MDDATE:
This token is stored within the change request activity with the value &DATE, and is replaced by the date the object was last modified.
*MDTIME:
This token is stored within the change request activity with the value &TIME, and is replaced by the time the object was last modified.
global-name-token-1
Specify the first token of the global name. The first token is recommended to be the registered enterprise ID or network ID.

Element 2-10: Token 2-10

*ANY
Any token value matches when searching for the object where the action is to be performed.
*HIGHEST
The object with the highest token value has the action performed on it. The token must be ordered. This is useful when a token in a global name is used to indicate a different version of the object and you need to manipulate the object with the highest version level.
*LOWEST
The object with the lowest token value has the action performed on it. The token must be ordered. This is useful when a token in a global name is used to indicate a different version of the object and you need to manipulate the object with the lowest version level.
*NETID
The network ID of this system is used. The network ID is determined by the current value of the LCLNETID network attribute value.
*CPNAME
The control point name of this system is used. The control point name is determined by the current value of the LCLCPNAME network attribute value.
*SERVER:
This token is stored within the change request activity with the value &SERVER, and is replaced by the short name of the change control server when the object is deleted.
*TARGET:
This token is stored within the change request activity with the value &TARGET, and is replaced by the short name of the target when the object is deleted.
*MDDATE:
This token is stored within the change request activity with the value &DATE, and is replaced when distributed by the date the object was last deleted.
*MDTIME:
This token is stored within the change request activity with the value &TIME, and is replaced when distributed by the time the object was last deleted.
global-name-token-n
Specify one of a series of 1 to 16 character tokens that uniquely identify the object on which the action is to be performed. Characters A through Z and 0 through 9 can be used. Other special values (@, #, and $) can be used for tokens that represent network IDs and system names.

Notes:

  1. TODLTNAME is valid only when ACTION(*SND), ACTION(*SNDRUN) or ACTION(*SNDINS) is specified.
  2. The number of tokens specified in the TODLTNAME parameter must match the number of tokens specified in the GLBNAME parameter.
  3. TODLTNAME cannot be specified if the REPLACE value is *NO.

Refresh level (REFLVL)

Specifies the level of the software component to be uninstalled.

*NONE
No refresh level is specified.
refresh level
Specify a numeric character string of up to 16 digits.

Note: REFLVL is valid only when ACTION(*UNINS) is specified.

Force uninstall (FRCUNINS)

Specifies whether to perform the uninstallation even if the software component includes an object that is waiting to be installed or an object that is currently being installed.

*NO
Do not allow uninstallation if there are objects, for the software component, waiting to be installed.
*YES
Allow uninstallation even if there are objects, for the software component, waiting to be installed.

Note: FRCUNINS is valid only when ACTION(*UNINS) is specified.

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 next date values are determined when the activity begins running at the central site system based on the central site date and time.

Single value:

*NONE
No start time on the managed system is specified.

Element 1: Time Zone

The time zone of the remote start time.

The possible values are:

*LCLSYS
The remote start time is specified in the time zone of the central site system. The start time is converted to Greenwich Mean Time.
*MGDSYS
The remote start time is specified in the time zone of the managed system.

Element 2: Start After Time

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 central site system on the date specified in element 2.
start-after-time
Specify the time 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).

Element 3: Start After Date

*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.

Notes:

  1. The special values *CURRENT and *NEXT cannot be specified for the date and the time when the time zone value *MGDSYS is specified.
  2. This parameter is valid only when these actions are specified: *ACP, *ACT, *RUN, *INS, *RMV, *SNDRUN, *SNDINS, or *UNINS.

Activity conditions (COND)

Specifies which conditions must be met before this activity can be performed. Each condition identifies an activity that 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.

Element 1: Conditioning Activity

The activity that must be run before this activity.

The possible values are:

*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 the activity that must be 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 that must be run before this activity.

Element 2: Relational Operator

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

Element 3: Condition Code

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:
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 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

Element 4: Condition Mode

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 runs.
*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 cannot have completed for 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.
*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.

Element 1: Start After Time

The possible 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).

Element 2: Start After Date

*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 when the change request is submitted.
start-after-date
Specify the date after which this activity can start. The date must be specified in the job date format.

Element 3: Start Before Time

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 when the change request was submitted on the date specified on the start before data element.
start-before-time
Specify the time before 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 such as a colon (:). With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

Element 4: Start Before Date

*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 cannot be started by this date, it never starts. The date must be specified in the job date format.

Hold activity (HOLD)

Hold the activity when the change request is submitted.

*NO
The activity is not held and will run when all conditions are met.
*YES
The activity is held for all nodes when the change request is submitted. It must be released by you before it runs.

Examples

The following examples illustrate how to use the ADDCRQA command to schedule activities to be performed on managed systems controlled by a NetView Distribution Manager/6000 change control server. The examples shown here are grouped according to their activity action:

Example 1: Accept Actions

The examples shown here match those shown for the install examples and demonstrate how some of the installed objects can be accepted.

Example 2: Activate Actions

Example 3: Delete Actions

Example 4: Run Actions

Example 5: Install Actions

The first four examples shown here match those shown for the accept and remove examples.

Example 6: Remove Actions

The examples shown here match those shown for the install examples and demonstrate how the installed objects can be removed.

Example 7: Retrieve Actions

Example 8: Send, Send and Run, and Send and Install Actions

Example 9: Uninstall Actions

Error messages

None