Configuring service operations

A service operation specifies the type of service operation to be carried out according to the specified operations. Operations are encapsulated in the <serviceOperation> and </serviceOperation> elements.

About this task

There are two types of service operations: CREATE and DELETE. The operations themselves are encapsulated in <operation> and </operation> elements. Each service operation requires the type attribute. This type attribute currently supports two types: CREATE, which sets up a service and DELETE, which tears down a service. An optional name attribute can be specified to identify a service operation.

An <operation> element includes a name attribute. It also includes the parameter list that is used when the service is submitted for execution and other attributes. The NSM service designer uses this parameter list to verify that the required parameters are specified in the NSM service template during its creation. The NSM service designer also uses this parameter list to filter parameters so that only the required ones are submitted to execute the service.

Procedure

As the NSM service designer use the following example as a guide to configuring service operations and operations. The example presents a configured operation for creating zones for a firewall.

<serviceOperations>
 <serviceOperation name="createOperation" type="CREATE">
   <operations>
    <operation name="ITNCM/FirewallCreateZones-Cisco-Router" rollback="true" type="COMMANDSET">
     <parameters>
      <parameter name="VIRTUALROUTERNAME"/>
      <parameter name="NAME"/>
      <parameter name="SOURCEROUTETABLE"/>
      <parameter name="TARGETROUTETABLE"/>
      <parameter name="ZONEID"/>
     </parameters>
    </operation>
   </operations>
 </serviceOperation>
</serviceOperations>

Specify values for the <serviceOperation> element as follows:
1. (Optional) Enter the name of the service operation in the name attribute. In the example, the service operation name is createOperation.
2. Enter the service operation type in the type attribute. In the example, the service operation type specified is CREATE, which specifies a create service.
Specify values for the <operation> element as follows:
1. Enter the name of the operation in the name attribute. In the example, the operation name is ITNCM/FirewallCreateZones-Cisco-Router, which is the fully qualified name of the command set on Netcool Configuration Manager.
2. Set the value for rollback in the rollback attribute to either true or false. In the example, the rollback is set to true.
  If an operation fails while it is being executed and rollback is set to "true", the operation is reverted and the device is returned to its original configuration before the operation started. If rollback is set to "false", then rollback is not configured and the operation is not reverted to its original configuration.
3. Enter the operation type in the type attribute. In the example, the operation type is COMMANDSET.
  Valid values for the type attribute are: COMMANDSET, EXTRACTION, DEVICESYNC, IMPORT, DISCOVER, and REMOVE.
Populate the parameters list with the required parameters for the NSM service designer to be used in service execution.
If the operation type is COMMANDSET, the parameters specified in the name attributes must match the parameters that are required in the command set configured on the Netcool Configuration Manager presentation server.

Note: For a client parameter list to specify the parameters to be used within an operation, the name attribute of the <clientParameterList> element must be used to link the client parameter list to the operation.

For example:
```
<clientParameterLists>
<clientParameterList name="CPL_NAME">
<parameter name="SOURCEROUTETABLE"/>
<parameter name="TARGETROUTETABLE"/>
<parameter name="VIRTUALROUTERNAME"/>
</clientParameterList>
</clientParameterLists>
.
.
.
<serviceOperations>
<serviceOperation name="createOperation" type="CREATE">
<operations>
<operation name="ITNCM/FirewallCreateZones-Cisco-Router" rollback="true" type="COMMANDSET">
<parameters>
<parameter name="CPL_NAME"/>
</parameters>
</operation>
</operations>
</serviceOperation>
</serviceOperations>
```