<action> element

The <action> element contains details of an action to be performed by a CICS management client interface PUT request on the resources specified by the URI.

Contained by:

Attributes

name="action_name"
The <action> element must contain only one name attribute identifying the action to be performed.

You must enclose action_name in matching single or double quotes. As is the convention in coding XML, you can use escape sequences to replace certain special characters such as &, <, and >. If the action has any parameters associated with it, you must specify them as child elements of <action> using the <parameter> element.

If you specify the <action> element in the HTTP body, you must not include an <attributes> element in the same request.

Contains:

The <action> element can contain one or more child <parameter> elements.

Examples

The following example shows an install for the BAS resource with name ABCD.
PUT http://exampledomain.com:12345/CICSSystemManagement/<RESOURCE NAME>/<CONTEXT>/?CRITERIA=NAME%3DABCD

   <request>
      <action name="INSTALL">
         <parameter name="TARGET" value="SYSTEM1"/>
         <parameter name="USAGE" value="LOCAL"/>
      </action>
   </request>

The following example shows a CSDADD action where the CSD group, GROUP4, is added to the CSD list, LIST2, after the CSD group, GROUP3.

The parameters that are specified for the CSDADD action are: TO_CSDLIST, ADD_CSDGROUP, and ADD_LOCATION.
  • TO_CSDLIST specifies which CSD list to add the CSD group to.
  • ADD_CSDGROUP specifies which CSD group to add the supplied CSD group next to in the CSD list.
  • ADD_LOCATION specifies whether to add the supplied CSD group "BEFORE" or "AFTER" the existing CSD group in the CSD list.
PUT http://exampledomain.com:12345/CICSSystemManagement/CICSCSDGroup/<CONTEXT>/<SCOPE>/?CRITERIA=NAME%3DGROUP4

   <request>
      <action name="CSDADD">
         <parameter name="TO_CSDLIST" value="LIST2"/>
         <parameter name="ADD_CSDGROUP" value="GROUP3"/>
         <parameter name="ADD_LOCATION" value="AFTER"/>
      </action>
   </request>
The following example shows a DISABLE action on the CICS operational resource, RESOURCE. Note that the type of resource is included in the URI, in this case the resource is of type CICSAtomService.
PUT http://exampledomain.com:12345/CICSSystemManagement/CICSAtomService/<CONTEXT>/<SCOPE>/?CRITERIA=NAME%3DRESOURCE

   <request>
      <action name="DISABLE"/>
   </request>