Description
This operation component sends a WMI query to a Windows Business Server.
This component can be used only when the Management Server is running on Windows.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
To execute the operation component on the Management Server, specify the following:
For IPv4: 'localhost' or '127.0.0.1'
For IPv6: 'localhost' or '::1'
An argument error occurs if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 characters. An argument error occurs if this is exceeded.
This is the target namespace.
Example: root/cimv2
An argument error occurs if the namespace is omitted.
The maximum length of the namespace is 1,024 characters. An argument error occurs if this is exceeded.
This is the query statement used by the WMI query.
Example: SELECT Freespace,DeviceID FROM Win32_LogicalDisk
An argument error occurs if the query statement is omitted.
The maximum length of the query statement is 1,024 characters. An argument error occurs if this is exceeded.
Advanced Options
Operating system of the host executing the operation component.
Specify Windows. This option is not case sensitive.
If the OS type is omitted, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and Systemwalker Runbook Automation automatically sets the acquired OS type as the value.
The maximum length of the OS type is 1,024 characters. An argument error occurs if this is exceeded.
This is the name of the user that uses WMI to connect to the target host where the operation component is to be executed.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user name as the value.
The maximum length of the connected user name is 1,024 characters. An argument error occurs if this is exceeded.
This is the password of the user that executes the command on the target host where the operation component is to be executed.
If the connected user name and password required for connection are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user password as the value.
The maximum length of the connected user password is 1,024 characters. An argument error occurs if this is exceeded.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
Example) If the completion timeout is 10 minutes: 600
If the operation component has not finished executing even though the specified time has passed, the processing for the operation component will be interrupted with return value 201.
This is the retry count for the execution of operation components.
Specify the number of retry attempts to be used when operation components terminate with return value 161. Values between 0 and 5 can be specified.
If an operation component terminates with a return value other than "161" as a result of being re-executed from a retry, execution of the operation component will terminate even if the specified number of retries has not been reached. The return value for the operation component will be the value from the last time the operation component was executed.
Example) To retry the operation component twice: 2
This is the retry interval (seconds) for operation components.
Specify the time to wait before a retry is attempted if operation components terminate with return value 161. Values between 1 and 14400 can be specified.
Example) To retry at 300 second intervals: 300
If the specification of the timeout, retry and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation componentscomponents definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | A WMI query has executed successfully. |
| Failure | 161 | An attempt to execute a WMI query has failed. If a retry count has been specified, retries will be attempted. |
188 | Network communications with the Business Server have been disconnected. | ||
189 | An attempt to connect to the Business Server via the network failed. | ||
196 | An option that cannot be specified when the Management Server is running on Linux has been specified. | ||
197 | There is an error with the input information. | ||
200 | Execution of a WMI query has terminated abnormally. | ||
- | - | 201 | Execution of the operation component timed out. |
202 | The operation component has not been executed. There is a problem with the settings for executing the operation component. | ||
203 | The operation component has not been executed normally. There is a problem with the Management Server environment. | ||
205 | The operation component has not been executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component has not been executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation component has not been executed. The operation component may not have been registered on the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. | ||
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if a WMI query is executed successfully. The operation component was successful. If a WMI query fails to execute, the content of the error will be output as a string. |
wmi_query_result | This variable is set to the execution results of the WMI query, using the following format. **QueryResult1** <Example> If "root/cimv2" has been specified for the namespace and "SELECT Freespace,DeviceID FROM Win32_LogicalDisk" has been specified for the query statement: **QueryResult1** |
returnCode | This variable is set to the return value. |
Notes
Start the WMI service on the host before executing the WMI query.
Use the Web console to check the return value. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
If a return value between 201 and 208 has been output, the Automated Operation Process will enter an aborted state or an error state, and error messages will be output to the following locations:
Event logs for the Management Server (if the Management Server is running on Windows(R))
syslogs for the Management Server (if the Management Server is running on Linux)
Custom messages for BPMN
Check for messages in these locations and take the appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
