Operation attributes and types

The <operation> element can include the following attributes. Each operation can be one of the following types: COMMANDSET, EXTRACTION, DEVICESYNC, DISCOVER, IMPORT, and REMOVE. NSM service designers define <operation> elements to use one of these types.

Table 1. Operation attributes
Attribute name Description
name A mandatory attribute that specifies the operation name. The value of the name depends on the type of operation that is specified.
description An optional attribute that includes a description of the operation.
rollback An optional attribute that specifies whether an operation should be reverted if the operation fails. The default value is false. If it is set to true, the operation is reverted when a failure occurs. The rollback optional attribute is only applicable to operations of type COMMANDSET.
type A mandatory attribute that specifies the type of the operation. The types are: COMMANDSET, EXTRACTION, DEVICESYNC, DISCOVER, IMPORT, and REMOVE.
order

An optional attribute that specifies the order that operations are executed. For example, if one operation has order 1 and another operation has order 2, the operation with order 1 is executed first, the operation with order 2 is executed next. The order must be ascending and order numbers can be repeated. For example, 1, 1, 1, 2, 2, 3,3 means all operations with order 1 will get executed first, then operations with order 2, and so on. Ordered and unordered operations cannot be mixed.
parameters An optional element that includes a list of parameters that the operation uses during its execution. For operations of type COMMANDSET, all Netcool Configuration Manager command set parameters must be listed here.
Table 2. Operation types
Operation type Description
COMMANDSET Runs a Netcool Configuration Manager command set on a target device. This command set is either NATIVE, SMARTMODEL, or COMMANDSET GROUP.
EXTRACTION

Runs a Netcool Configuration Manager device configuration extraction on a target device.

The following example shows an EXTRACTION operation:

<operation name="ITNCM/ExtractZones" type="EXTRACTION">
<parameters>
<parameter name="ZONENAME"/>
</parameters>
</operation>
DEVICESYNC

Runs a Netcool Configuration Manager function to synchronize the latest configuration from the target device and return it to Netcool Configuration Manager.

The following example shows a DEVICESYNC operation:

<operation name="DEVICESYNC" type="DEVICESYNC">
</operation>
DISCOVER
Runs a Netcool Configuration Manager function to discover a device.
Note: This function will only discover and create the device, but not import it.
The following example shows an DISCOVER operation: 
<operation name="IMPORT" type="IMPORT">
</operation>
IMPORT
Runs a Netcool Configuration Manager function to import the configuration from a device.
Note: This function will also create the device in Netcool Configuration Manager if requested to do so.
The following example shows an IMPORT operation: 
<operation name="DISCOVER" type="DISCOVER">
</operation>
REMOVE

Runs a Netcool Configuration Manager function to remove the target device.

The following example shows an REMOVE operation: 
<operation name="REMOVE" type="REMOVE">
</operation>

Depending on the type of operation that is defined by the NSM service designer in the operation, the attributes that the designer can include in the operation varies.

For an operation that has a COMMANDSET type configured, the name attribute is mandatory and it specifies the fully qualified name of the Netcool Configuration Manager command. Any parameters that are required by the command set must be named in the parameter list of the operation. The values of these parameters are evaluated at service execution time and supplied to the command set before execution in Netcool Configuration Manager.

For an operation that has an EXTRACTION type configured, the name attribute is mandatory and it specifies the fully qualified name of the Netcool Configuration Manager extraction that is executed. All other attributes are optional for this type. The rollback attribute is not used by the EXTRACTION type. Any parameters that are required by the extraction must be named in the parameter list of the operation. The values of these parameters are evaluated at service execution time and supplied to the extraction before execution in Netcool Configuration Manager.

For an operation that has a DEVICESYNC type configured, the name attribute is mandatory and must be specified as DEVICESYNC. All other attributes are optional for this type. The rollback and the parameter attributes are not used by the DEVICESYNC type.

For an operation that has a IMPORT type configured, the name attribute is mandatory and must be specified as IMPORT. All other attributes are optional for this type. The rollback and the parameter attributes are not used by the IMPORT type.

For an operation that has a DISCOVER type configured, the name attribute is mandatory and must be specified as DISCOVER. All other attributes are optional for this type. The rollback and the parameter attributes are not used by the DISCOVER type.

For an operation that has a REMOVE type configured, the name attribute is mandatory and must be specified as REMOVE. All other attributes are optional for this type. The rollback and the parameter attributes are not used by the REMOVE type.