Description
This operation component connects to the virtual environment management product and stops a virtual server.
The component establishes connection by using the information registered in the Configuration Management Database (CMDB).
Options
Basic Options
Name of the virtual server to be stopped. Specify the virtual server name that is registered in the Virtual Environment Management Server.
Multiple names can be specified for the name of the server to be restarted.
If the virtual environment is managed by ServerView Resource Orchestrator, specify the L-Server name.
An argument error occurs if the virtual server name is omitted.
The maximum allowable server names is 100. An argument error will occur if this limit is exceeded.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
Advanced Options
Virtual server stop operation force option.
Specify "on" to stop the virtual server forcibly, without using virtual server OS shutdown processing.
Specify "off" if you do not want forced stop to be used.
If the stop mode is omitted, "off" is set. This option is not case sensitive.
Specify the execution multiplicity for stopping virtual servers.
Values between 1 and 100 can be specified.
If a value greater than the number of server names specified for the "servername" option is used, the operation component runs as though the "servername" value has been specified for "multiplicity".
If this option is omitted, the operation component will run as though "10" has been specified.
If a large value is specified for this option, there may be a burden on the managed product in the virtual environment.
Specify the parts movement mode for when multiple servers to be stopped are specified.
The valid values are below, and these option are not case sensitive. :
continue : Execute to the end of the specified host.
abort : Suspend processing in the host where the error was discovered.
If omitted or some other value than the options listed above is specified, "continue" is used by default.
If "abort" is specified and a multiplicity of 2 or higher is specified, the component will not be interrupted until the server processing that is executing at the time the error is detected completes.
This will be ignored if only one server will be stopped.
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
Note that the specification for this option is ignored if multiple server names have been specified.
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 timeout, retry and retry interval are omitted, and the value beyond the limits 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 | Virtual server stop was successful. |
173 | The virtual server is already stopped. | ||
| Failure | 161 | Connection error occurred between the Virtual Environment Management Server. Retried if a retry count has been specified. If multiple server names have been specified, retries will not be performed. |
171 | Authentication failed to connect the Virtual Environment Management Server. | ||
172 | Failed to stop the virtual server. | ||
180 | Multiple operations failed. For the return values for the operations on each server, check the "Return_code" column in output information "server_stop_result". | ||
188 | Connection to the Virtual Environment Management Server failed during execution. | ||
189 | An attempt to connect to the Virtual Environment Management Server has failed. If the virtual environment is not being managed by ServerView Resource Orchestrator, an error will occur in the communication process with the server (file transfer infrastructure) if an operation component executes an operation to a server that has an agent installed. In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
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 |
|
server_stop_result | This variable is set to the result of executing the stop request on the specified server. |
server_stop_list | This variable is set to a list of servers that stopped successfully. This specification is in the CSV format. |
server_stop_fault_list | This variable is set to a list of servers that failed to stop. This specification is in the CSV format. |
returnCode | This variable is set to the return value. |
The output format for the "server_stop_result" variable is as follows:
[hostname],[return value],[output data],[message]
For [output data], one of the following will be output:
If the servers are stopped successfully, the names of the servers that have been stopped will be output.
If the servers fail to stop, nothing will be output.
For [message], one of the following will be output:
If the servers are stopped successfully, the string "Success" will be output.
If the servers fail to stop, the content of the error will be output as a string.
<Example>
If "server1,server2,server3" has been specified for the "servername" option, and server "server3" has failed to stop.
"servername",Return_code,"Output","Message"
"server1",0,"server1","The virtual server termination processing has been completed.
VirtualServerName=<server1>"
"server2",0,"server2","The virtual server termination processing has been completed.
VirtualServerName=<server2>"
"server3",161,"","Error occurred. VirtualServerName=<server3> detail=<Message='Invalid servername specified
or information registered in CMDB is wrong.'>"
Note: This example has been split over multiple lines to make it easier to read, but information for a single server will be output on a single line.
In the example above, the following will be output to the "message" variable.
<Example>
"servername",Return_code,"Output","Message"
"server3",161,"","Error occurred. VirtualServerName=<server3> detail=<Message='Invalid servername specified
or information registered in CMDB is wrong.'>"
Note: This example has been split over multiple lines to make it easier to read, but information for a single server will be output on a single line.
Notes
With this operation component, it is necessary to register the managed product information or the managed product's Management Server authentication information with CMDB beforehand.
If the virtual environment is being managed by ServerView Resource Orchestrator, register the ServerView Resource Orchestrator information.
If not managing the virtual environment with ServerView Resource Orchestrator, register the virtualization software information. Refer to "3.18 Information Registration to CMDB (Management Product of Virtual Environment)" for information on registration
If information for both the ServerView Resource Orchestrator and the virtualization software are registered in CMDB, first check whether the specified virtual server name is being managed by ServerView Resource Orchestrator.
If not managing the virtual environment with ServerView Resource Orchestrator, an agent must be installed on the vCenter Server in order to display the VM host operations using this operation component. The following software is required for vCenter Server:
VMware vSphere Power CLI
Windows PowerShell
On vCenter Server, environment settings to use the above software are required. Refer to "3.19 vCenter Server Settings" for details.
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 and virtualization software.
ServerView Resource Orchestrator V2.2.0 to V3.1.1
Relevant virtualization software is VMware and Hyper-V.
VMware vSphere 4.0, 4.1, 5.0, or 5.1.
