Get virtual server information

Operation Name

Function Overview

Gets all virtual server information on a destination.

Data Model

XML type.

Properties

For usage of variable, refer to "Variable".

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 Global Resources. [Add]: Adds a new global resource. [Edit list]: Enables to edit the global resource settings in the "Edit resource list".

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=""
    name=""
    displayName=""
    account=""
    cpuNumber=""
    cpuSpeed=""
    cpuUsed=""
    created=""
    domain=""
    domainId=""
    forVirtualNetwork=""
    group=""
    groupId=""
    guestOsId=""
    haenable=""
    hostId=""
    hostName=""
    hypervisor=""
    ipAddress=""
    isoDisplayText=""
    isoId=""
    jobId=""
    jobStatus=""
    memory=""
    networkKbsRead=""
    networkKbsWrite=""
    password=""
    passwordEnabled=""
    rootDeviceId=""
    rootDeviceType=""
    serviceOfferingId=""
    serviceOfferingName=""
    templateDisplayText=""
    templateId=""
    templateName=""
    zoneId=""
    zoneName="">
    <nics>
      <nic
        id=""
        broadcastUri=""
        gateway=""
        ipAddress=""
        isDefault=""
        isolationUri=""
        macAddress=""
        netmask=""
        networkId=""
        trafficType=""
        type=""/>
    </nics>
    <securityGroups>
      <securityGroup
        id=""
        account=""
        description=""
        domain=""
        domainId=""
        jobId=""
        jobStatus=""
        name="">
        <ingressRules>
          <ingressRule
            account=""
            cidr=""
            endPort=""
            icmpCode=""
            icmpType=""
            protocol=""
            ruleId=""
            securityGroupName=""
            startPort=""/>
        </ingressRules>
      </securityGroup>
    </securityGroups>
  </instance>
</instances>

Element name	Attribute name	Description
instances	-
instance	-	Appears each created virtual server.
	instanceId	Outputs id of virtual server.
	instanceState	Outputs state of virtual server. [Running]:state of virtual server is running. [Starting]:state of virtual server is starting. [Stopped]:state of virtual server is stopped. [Stopping]:state of virtual server is stopping. [Destroyed]:state of virtual server is destroyed.
	name	Outputs name of virtual server.
	displayName	Outputs display name of virtual server.
	account	Outputs account related to virtual server.
	cpuNumber	Outputs the number of CPU running on virtual server.
	cpuSpeed	Outputs CPU speed of virtual server.
	cpuUsed	Output CPU usage of VM on which virtual server is running.
	created	Outputs the date virtual server was created.
	domain	Outputs domain name in which virtual server exists.
	domainId	Outputs domain id in which virtual server exists.
	forVirtualNetwork	Outputs virtual network for service offering of virtual server.
	group	Outputs group name of virtual server.
	groupId	Outputs group id of virtual server.
	guestOsId	Outputs OS id of virtual server.
	haenable	Outputs whether high availability is enabled. [true]:Enabled [false]:Disabled
	hostId	Outputs host id of virtual server.
	hostName	Outputs host name of virtual server.
	hypervisor	Outputs hypervisor in which template is executed.
	ipAddress	Outputs IP address of virtual server.
	isoDisplayText	Outputs display text of ISO which is connected with virtual server.
	isoId	Output id of ISO which is connected with virtual server.
	jobId	Outputs asynchronous job ID which is being deferred now.
	jobStatus	Outputs asynchronous job status which is being deferred now.
	memory	Outputs memory which is assigned to virtual server.
	networkKbsRead	Outputs network traffic which is calling VM of virtual server.
	networkKbsWrite	Outputs network traffic which is sent from host of virtual server.
	password	Outputs when a password of virtual server exists.
	passwordEnabled	Outputs whether password function of virtual server is enabled. [true]:Enabled [false]:Disabled
	rootDeviceId	Outputs device id of root volume of virtual server.
	rootDeviceType	Outputs device type of root volume of virtual server.
	serviceOfferingId	Outputs service offering id of virtual server.
	serviceOfferingName	Outputs offering name of virtual server.
	templateDisplayText	Outputs display text of template.
	templateId	Outputs template id of virtual server. Outputs -1 when it was created from ISO file.
	templateName	Outputs template name of virtual server.
	zoneId	Outputs zone id which virtual server is using.
	zoneName	Outputs zone name which virtual server is using.
nics	-
nic	-	Outputs by each NIC which is set to virtual server.
	id	Outputs NIC id.
	broadcastUri	Outputs broadcast URI of NIC.
	gateway	Outputs NIC gateway.
	ipAddress	Outputs NIC IP address.
	isDefault	Outputs whether NIC is default. [true]:It shows default. [false]:It shows non-default.
	isolationUri	Outputs isolated URI of NIC.
	macAddress	Outputs MAC address of NIC.
	netmask	Outputs subnet mask of NIC.
	networkId	Outputs id which is corresponded with network.
	trafficType	Outputs NIC traffic type.
	type	Outputs NIC type.
securityGroups	-
securityGroup	-	Outputs by each security group which is set to virtual server.
	id	Output securityGroup id.
	account	Outputs account which has securityGroup.
	description	Outputs description of securityGroup.
	domain	Outputs domain name of securityGroup.
	domainId	Outputs domeanId of securityGroup.
	jobId	Outputs asynchronous job ID which is being deferred.
	jobStatus	Outputs asynchronous job status which is being deferred.
	name	Output securityGroup name.
ingressRules	-
ingressRule	-	Outputs by each ingressRule which is set to securityGroup of virtual server.
	account	Outputs account which has ingressRule.
	cidr	Outputs CIDR expression of base IP address of ingressRule.
	endPort	Outputs finishing Ip of ingressRule.
	icmpCode	Outputs code for responding ICMP message.
	icmpType	Outputs type for responding ICMP message.
	protocol	Outputs protocol of ingressRule.
	ruleId	Outputs id of ingressRule.
	securityGroupName	Outputs securityGroup name.
	startPort	Outputs starting IP of ingressRule.

Loading Schema on Mapper

Schema is loaded automatically.

For details, refer to "Edit Schema".

Mass Data Processing

Mass data processing 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 occurred error.	Default value is null.
message_code	Stores the code of message code corresponding to the occurred error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occurred error.	Default value is null.
error_type	Stores the error type of occurred error.	Default value is null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The value may vary depending on the DataSpider Servista version.
error_message	Stores the error message of occurred error.	Default value is null. The value may vary depending on the DataSpider Servista version.
error_trace	Stores the trace information of occurred error.	Default value is null. The value may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

None.

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:[<Global Resources>]	Resource definition selected in [Destination] is not found.	Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is required.	[<Property name>] is not entered.	Specify [<Property name>].
InvalidPropertyConfigurationException Timeout must be more than 0.	Numerical value which is equal to or less than 0 is entered in [Timeout] of global resource specified in [Destination] .	Enter numerical value which is more than 0 in [Timeout] of global resource specified in [Destination] .
InvalidPropertyConfigurationException Enter integer of variable in Timeout.	Value which is other than numerical value is entered in [Timeout] of global resource specified in [Destination] .	Enter numerical value in [Timeout] of global resource specified in [Destination] .
NttcomCloudnClientException Code=401, Message=unable to verify user credentials and/or request signature	There are something wrong with [API key] or [Secret key] of global resource specified in [Destination].	Confirm settings of global resource specified in [Destination].
NttcomCloudnTimeoutException org.apache.http.conn.ConnectTimeoutException: Connect to <Host> timed out	Timeout has occurred during connecting wih host.	Confirm network condition, or confirm [Timeout] of global resource specified in [Destination].
NttcomCloudnTimeoutException java.net.SocketTimeoutException: Read timed out	Timeout has occurred after connecting with host and until responding from host.	Confirm host condition, or confirm [Timeout] of global resource specified in [Destination].

Notes

HTTPS is used in the communication between Cloudn and this adapter.

For information of trouble and maintenance of Cloudn, refer to information from the service provider.

There are some cases that a part of value of contents which is defined in output schema due to service specification.