Using CMCI to perform actions on a resource definition

Perform actions on a BAS or CSD resource definition using the CICS Management Client Interface (CMCI).

Before you begin

You must have a connection with the CMCI. For more information, see Setting up CMCI.

About this task

Use a PUT request to perform actions on a resource definition. For the request, specify the URI and an XML body containing the parameters and attributes for the resource, as instructed in the Procedure below.

For information about PUT requests, see CMCI PUT requests.

Procedure

  1. Specify the URI for the request, following the instructions in CMCI PUT request URI.
    Note:
    • If you are performing actions on a BAS resource, the SCOPE parameter, if specified in the URI, is ignored.
    • If you are performing actions on a CSD resource, you must specify the SCOPE and PARAMETER=CSDGROUP(value) in the URI.

      The SCOPE must be the CICS system in which you are performing actions on the resource. The CSDGROUP parameter is passed to instruct CICSPlex SM to search in the CSD groups in the specified system.

  2. Add an XML body containing the parameters and attributes for the resource. Specify the action that you want to perform.
    The XML body comprises an <action name="action_name"> element inside a <request> element. If the action requires parameters, you must specify these in <parameter> elements inside the <action> element.

    Each resource table includes a list of the actions that you can perform.

    For information about CMCI XML elements, see CMCI XML.

Example

The following example shows an INSTALL request that is applied to all BAS transaction definitions in the scope that have a name starting with AA.
PUT http://exampledomain.com:12345/CICSSystemManagement/
    CICSDefinitionTransaction/<CONTEXT>/
    ?CRITERIA=NAME%3DAA*

<request>
   <action name="INSTALL">
      <parameter name="FORCEINS" value="NO"/>
      <parameter name="USAGE" value="LOCAL"/>
   </action>
</request>
The following example shows how to specify a CSDINSTALL action request. This request installs all CSD transactions that have a name starting with AA in CSD group GRP1 in a CICS region named MYREGION. Note that SCOPE specifies MYREGION and that PARAMETER=CSDGROUP(GRP1) is specified in the URI. The parameters that you can specify for an action on a CSD resource are listed in the command description.
PUT http://exampledomain.com:12345/CICSSystemManagement/
    CICSDefinitionTransaction/<CONTEXT>/MYREGION/
    ?CRITERIA=NAME%3DAA*&PARAMETER=CSDGROUP%28GRP1%29 

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