Description
This operation component connects to the virtual environment management product and obtains detailed information about a virtual server.
The component establishes connection by using the information registered in the CMDB.
Options
Basic Options
Name of the virtual server for which the detailed information is to be obtained.
Specifies the name of the virtual server registered with the virtual environment management product.
If managing a virtual environment with ServerView Resource Orchestrator, specify "L-Server".
An argument error occurs if the virtual server name is omitted.
The maximum length of the virtual server name is 1,024 characters. An argument error occurs if this is exceeded.
Advanced Options
Specify whether all the detailed information managed by the virtual server management product will be output.
Specify "on" to add the management product output information to the list information.
Specify "off" if you do not want the output information to be added.
The default value is "off". This option is not case sensitive.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it doesn't reach the specified retry count. The return values of the operation components become the value executed at the end.
For example: When retries are to be performed twice: 2
This is the retry interval (seconds) for operation components.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 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 components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | Obtaining detailed information about the virtual server was successful. |
| Failure | 161 | Connection error occurred between the virtual environment management server. Retried if a retry count has been specified. |
171 | Authentication failed to connect the virtual environment management server. | ||
172 | Failed to Obtain detailed information about the virtual server. | ||
188 | Connection to the virtual environment management server failed during execution. | ||
189 | An attempt to connect to the virtual environment management server has failed. | ||
197 | There is an error in the option content. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation Server environment. | ||
205 | The operation component was not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation components were not executed. There is a possibility that the operation components are not registered in 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 detailed information for virtual servers is obtained successfully. The operation component was successful. If an attempt to obtain detailed information for virtual servers fails, the content of the error will be set as a string. |
server_detail | This variable is set to detailed information for virtual servers that has been obtained. |
returnCode | This variable is set to the return value. |
Output the list in the form of the following.
<?xml version="1.0" encoding="UTF-8"?> <Resources> <VirtualServerName>[Virtual Server name]</VirtualServerName> <OSType>[OS Type]</OSType> <PowerStatus>[Power Status]</PowerStatus> <Processor> <ProcessorArch>[Processor Architecture]</ProcessorArch> <ProcessorSpeed>[Processor Speed]</ProcessorSpeed> <NumOfProcessors>[Number of Processors]</NumOfProcessors> </Processor> <Memory> <MemorySize>[Memory Size]</MemorySize> </Memory> <Disks> <Disk> <DiskSize>[Disk Size]</DiskSize> </Disk> ... (Output it repeating each disk) </Disks> <Networks> <Network> <MacAddress>[MAC Address]</MacAddress> <IpAddress>[IP Address]</IpAddress> </Network> ... (Output it repeating each connected network card) </Networks> </Resources>
If specify "on" for the detail parameter, output the output information on the management product of the virtual environment following the above-mentioned network information.
<?xml version="1.0" encoding="UTF-8"?> <Resources> ... </Networks> <AdditionalInfomation> <Software>[ServerView Resource Orchestrator]</Software> <OutputData> [Output information of ServerView Resource Orchestrator] </OutputData> </AdditionalInfomation> </Resources>
Return Values
If manage a virtual environment by ServerView Resource Orchestrator, management product information and authentication information of the management server need to register to the Configuration Management Database (CMDB) before use this operation component. Refer to "3.18 Information Registration to CMDB (Management Product of Virtual Environment)" on how to register information.
These operational components are relevant to the systems in which Systemwalker Software Configuration Manager is not installed.
Confirm the return values with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of management server (when the management server is Windows(R))
System log of management server (when the management server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
This operation component relevants following middleware.
ServerView Resource Orchestrator V2.2.0 to V3.1.1
Relevant virtualization software is VMware and Hyper-V.
