Stop virtual server

Operation Name

Stop virtual server

Function Overview

Stop specified virtual server.

Data Model

XML type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. [Add]: Adds a new global resource. [Edit list]: Enables to edit the global resource settings in the "Edit resource list".
Virtual server list	Required	-	Specify multiple stopping virtual server. Each column can be operated by following buttons. [Add]: Adds a column. [Up]: Moves the order of the selected column upwards by one. [Down]: Moves the order of the selected column downwards by one. [Delete]: Deletes a column.
Virtual server list/Virtual server ID (Name)	Required	Available	Enter or select the ID for stopping virtual server.	During initial display, nothing will be displayed in item selection. If [Obtain virtual server list] is pushed down, virtual server created in [Destination] will be displayed in item selection.
Stand by until termination	Optional	Not available	Select whether to stand by until virtual server stop is completed. [Checked]:(Default) Stands by until virtual server stop is completed. [Not checked]: If stop request is sent to virtual server, it will not stand by and proceed to following process.	If [Checked], it will continue to confirm virtual server status until the value entered in [Timeout] of the global resource specified in [Destination] after process started. After confirming that virtual server stop has completed, it will proceed to following process. If completion of virtual server stop cannot be confirmed by milliseconds enter in [Timeout], an error will occure.

Property action

Item name	Description	Remarks
Get virtual server list	Obtain virtual server information created in [Destination], and select from [Virtual server list/Virtual server ID (Name)].

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input schema

None.

Output schema

<?xml version="1.0"?>
<instances>
  <instance instanceId="" instanceState="" />
</instances>

Element name	Attribute name	Description
instances	-
instance	-	It will appear in every virtual server specified in [Virtual server list/Virtual server ID (Name)].
	instanceId	Outputs virtual server ID.
	instanceState	Outputs the ID of the virtual server. [Running]: Virtual server is launched. [Starting]: Virtual server is in the process of being launched. [Stopped]: Virtual server is stopped. [Stopping]: Virtual server is in the process of being stopped. [Destroyed]: Virtual server is destroyed.

Loading Schema on Mapper

Schema is loaded automatically.

For more details, refer to "Edut schema".

Mass Data Processing

Mass Data Processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
message_category	Stores the category of message code corresponding to the occured error.	Default value is null.
message_code	Stores the code of message code corresponding to the occured error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occured error.	Default value is null.
error_type	Stores the error type of occured error.	Default value is null. Error is represented in the format depicted below. Example:"java.io.FileNotFoundException" The message may vary depending on the DataSpider Servista version.
error_message	Stores the error message of occured error.	Default value is null. The message may vary depending on the DataSpider Servista version.
error_trace	Stores the trace information of occured error.	Default value is null. The message may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

If one or more virtual server succeeds in stop request while terminating multiple virtual server, error will not occure and terminate normally.

If virtual server which stop requested is deleted(Destroyed), Even if [Stand by the stop completion] is checked stand by process for this virtual server will not be executed.

If "NttcomCloudnTimeoutException :<Timeout>Virtual server status did not change within millisecond" occures, virtual server stop request is completed. It will be execution error, but virtual server stop process will be executed.

Main Exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition could not be found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition could not be found. Name:[<Name of global resources>]	Resource definition selected in [Destination] cannot not be found.	Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is not set up.	[<Property name>] is not set up.	Set up [<Property name>].
InvalidPropertyConfigurationException Timeout must be larger than 0.	A numerical value greater than 0 is entered in [Timeout] of the global resource specifed in [Destination].	Enter numerical value greater than 0 in [Timeout] of the global resource specified in [Destination].
InvalidPropertyConfigurationException Enter intergers or variables in a timeout.	A value other than numerical value is entered in [Timeout] of the global resource specifed in [Destination].	Enter numerical value in [Timeout] of the global resource specified in [Destination].
NttcomCloudnClientException Code=401, Message=unable to verify user credentials and/or request signature	There is an error in [API key] or [Secret access key] of the global resource specified in [Destination].	Confirm global resouce setting specifed in [Destination].
NttcomCloudnClientException Code=431, Message=Unable to execute API command startvirtualmachineresponse due to invalid value <Virtual server ID> for parameter id.	Virtual server format entered in [Virtual server list/Virtual server ID (Name)] is incorrect.	Enter correct virtual server ID in [Virtual server list/Virtual server ID (Name)].
NttcomCloudnTimeoutException <Timeout>Server's status did not change within millisecond.	After launch request transmission completed, virtual server stop did not complete within [Timeout] of the global resource specified in [Destination].	Confirm [Timeout] of the global resource specified in [Destination].
NttcomCloudnTimeoutException org.apache.http.conn.ConnectTimeoutException: Connect to <host> timed out.	Timeout occured during connection to the host.	Confirm the network status or confirm [Timeout] of the global resource specified in [Destination].
NttcomCloudnTimeoutException java.net.SocketTimeoutException: Read timed out.	Timeout occured after connecting the host, but before response from the host.	Confirm the host status or confirm [Timeout] of the global resource specified in [Destination].

Note

Data transfer between Cloudn and this adapter is performed over HTTPS.

Termination process only executes when server status is "running".

For more details on trouble and maintenance information for Cloudn, refer to the information of service provider.