Configuration Management module search workflows

This section describes the following workflows, contained in the Searches folder, which provide prebuilt workflows that can help you manage configuration.

Get Configuration Item by Configuration Item ID workflow

This workflow finds a configuration item by configuration item ID.

Note

This workflow does not support HP ServiceCenter.

Get Configuration Item by Configuration Item ID workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium	Yes
class name	Specifies the configuration item's class name	Yes
instance id	Specifies the instance ID of the configuration item	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No
dataset id	Specifies the dataset of the configuration item Example: BMC.ASSET	No

Get Configuration Item by Configuration Item ID workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Host Name workflow

This workflow finds a configuration item by host name.

Note

This workflow does not support HP ServiceCenter.

Get Configuration Item by Host Name workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium

Yes

host name

The host name of the configuration item

Example: persius1.calbro.com

Yes

query item

Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries

Sample XML with default values

<query-item>
  <soap>
    <username />              
    <password />				
  </soap>
  <login-info>
    <user-id>Demo</user-id>		
    <password>Demo</password>
    <lang>English</lang>
  </login-info>
  <class-name-id>
    <namespace-name>BMC.CORE</namespace-name>	
    <class-name>BMC_ComputerSystem</class-name>	
  </class-name-id>
  <dataset-id>BMC.ASSET</dataset-id>			
  <get-mask>GET_MASK_NONE</get-mask>          
  <first-retrieve>0</first-retrieve>			
  <max-retrieve>0</max-retrieve>				
  <sort-by>SerialNumber</sort-by>				
  <sort-order>ASCENDING</sort-order>			
</query-item>

No

Get Configuration Item by Host Name workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by MAC Address workflow

This workflow finds a configuration item by the MAC address.

Get Configuration Item by MAC Address workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
mac address	Specifies the MAC address used to perform the search	Yes
class name	Specifies the configuration item's class name Example of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice Example of valid values for BMC_AR_System and BMC_Atrium: BMC_ComputerSystem BMC_Equipment	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No

Get Configuration Item by MAC Address workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Name and Dataset ID workflow

This workflow finds all configuration items by name and dataset ID.

Note

This workflow does not support HP ServiceCenter.

Get Configuration Item by Name and Dataset ID workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium	Yes
class name	Specifies the configuration item's class name Example: BMC_Account, BMC_Activity, BMC_AdminDomain	Yes
name	Specifies the name of the configuration item Example: persius1.calbro.com	Yes
dataset id	Specifies the configuration item's dataset ID Example: BMC.ASSET	Yes

Get Configuration Item by Name and Dataset ID workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Name workflow

This workflow finds all configuration items by name.

Get Configuration Item by Name workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
class name	Specifies the configuration item's class name Example of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice Example of valid values for BMC_AR_System and BMC_Atrium: BMC_ComputerSystem BMC_Equipment	Yes
name	Specifies the value to be used to retrieve a configuration item from the configuration management system	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	No

Get Configuration Item by Name workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Owner workflow

This workflow finds all configuration items by owner.
Get Configuration Item by Owner workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
owner name	Specifies the configuration item owner's name	Yes
class name	Specifies the configuration item's class name Example of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice Example of valid values for BMC_AR_System and BMC_Atrium: BMC_ComputerSystem BMC_Equipment	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No

Get Configuration Item by Owner workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Reconciliation ID workflow

This workflow finds a configuration item by reconciliation ID.

Note

This workflow does not support HP ServiceCenter.

Get Configuration Item by Reconciliation ID workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium	Yes
class name	Specifies the configuration item's class name Example: BMC_ComputerSystem	Yes
reconciliation id	Specifies the reconciliation ID of the configuration item	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No

Get Configuration Item by Reconciliation ID workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Request ID workflow

This workflow finds a configuration item by the request ID.

Note

This workflow does not support HP ServiceCenter.

Get Configuration Item by Request ID workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium	Yes
class name	Specifies the configuration item's class name Example: BMC_ComputerSystem	Yes
request id	Specifies the request ID of the configuration item	Yes

Get Configuration Item by Request ID workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Item by Serial Number workflow

This workflow finds a configuration item by using the serial number.
Get Configuration Item by Serial Number workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
class name	Specifies the configuration item's class name Example of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice Example of valid values for BMC_AR_System and BMC_Atrium: BMC_ComputerSystem BMC_Equipment	Yes
serial	Specifies the serial number of the configuration item	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No

Get Configuration Item by Serial Number workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Get Configuration Items workflow

This workflow finds configuration items for a specified variable. Variables are the elements defined in the Configuration Management concept. BMC_Atrium queries must be formed using the application system source names (such as Status, AccountID, and SerialNumber). Queries are formed by creating a regular expression using the attributes (for example, AccountID!=NULL).
Get Configuration Items workflow inputs

Input	Description	Required
class name	Specifies the configuration item's class name Example of valid values for BMC_AR_System and BMC_Atrium: BMC_Account BMC_Activity BMC_AdminDomain Example of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_Contact HPSC_NetworkDevice	Yes
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
key 1	Contains the name or the ID of the field against which to search	No
value 1	Contains the value of the key1 field on which to search	No
query 1	Contains the query as a string or as an XML document with a root element of `<value>`, depending on the configuration management system BMC Remedy ITSM Configuration Management sample format: `<value> ' key 1 '= " value 1 "</value>` Note Key values are enclosed in single quotes ' '. String values are enclosed in double quotes " ". Numeric values are not enclosed. HP ServiceCenter: For simple queries, this input contains an operator. For Advanced Find queries, this input must contain the field and operator. Valid values: EQUALS, CONTAINS	No
key 2	Specifies a name or ID used for complex queries requiring comparisons between multiple keys and values	No
value 2	Specifies a value used for complex queries requiring comparisons between multiple keys and values	No
query 2	HP_ServiceCenter only: Displays an XML document containing an expression that relates key 1 and value 1 to key 2 and value 2; contains the query operator for simple queries with multiple criteria Example: `<value>' key 1 ' > " value 1 " and ' key 2 ' < " value 2 "</value>` Valid values: EQUALS, CONTAINS	No
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> </class-name-id> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	No

Get Configuration Items workflow output

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a workflow-specific explanation for the value of success status

Back to top

Configuration Management module search workflows

Get Configuration Item by Configuration Item ID workflow

Get Configuration Item by Host Name workflow

Get Configuration Item by MAC Address workflow

Get Configuration Item by Name and Dataset ID workflow

Get Configuration Item by Name workflow

Get Configuration Item by Owner workflow

Get Configuration Item by Reconciliation ID workflow

Get Configuration Item by Request ID workflow

Get Configuration Item by Serial Number workflow

Get Configuration Items workflow

Comments