3.5.1 Start virtual servers

Function

This service template can start instances in an Amazon EC2 environment.

The required server is shown as follows:

- AWS control server (execution-target server)

This is a server on which AWS Tools for Windows PowerShell (hereinafter referred to as "AWS Tools") is installed. This product can forward plugins to the server to be executed.

- Instance

This is a regular virtual server in an Amazon EC2 environment.

General processing is as follows:

(1) Obtain the instance status.

(2) Start the instance if the instance is stopped. If the instance is already running, skip the processing for starting the instance.

Perform the above processing in parallel with the instances specified to the instance IDs (the aws.foreachInstanceId property).

Notes on property settings are described as follows:

(1) To start an instance, wait for the seconds specified in the aws.checkInstanceEnabledInterval property that indicates an interval for checking the completion of starting an instance, and then repeat the number of times specified in the aws.checkInstanceEnabledCount property that indicates how many checks are performed for the completion of starting the instance. If necessary, modify the property values to adjust your system environment.

Prerequisites

For the most recent information about the prerequisite product in the system, prerequisite products on the execution-target server for the service templates, supported OSs for the prerequisite products on the execution-target server for the service templates, and prerequisite products on the execution-target system for the service templates, see the Release Notes.

Prerequisite product in the system:

JP1/Automatic Operation 12-00 or later

Prerequisite products on the execution-target server for the service template:

- AWS Tools for Windows PowerShell

- Microsoft .Net Framework 3.5 or later

Supported OSs for the prerequisite products on the execution-target server for the service template:

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

Note: A Server Core installation environment is out of scope.

Prerequisite products in the execution-target system for the service template:

(1) Prerequisite OSs for an instance

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

- Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)

- Red Hat Enterprise Linux Server 7 (64-bit x86_64)

- Red Hat Enterprise Linux Server 8 (64-bit x86_64)

Conditions for using the prerequisite products in the execution-target system for the service template:

(1) Conditions for this product

- To execute this service, the execution-target server must have been set as the agentless connection destination. If you use a local server as the execution-target server, you need to specify a loopback address that can be resolved by "localhost".

Execution privilege

(1) The policy must be set to allow an IAM user to log in to AWS to perform the following actions:

- Starting instances and obtaining instance statuses

Version

02.00.00

Tags

Control VM,AWS

Property list

The following shows the list of the property groups set in the property:

Property group	Description	Initial display
Virtual system environment information	Specify the AWS information.	Y
Instance information	Specify the information about the instance to be started.	Y
Execute option	This property checks the instance status when starting instances. If necessary, modify the property.	N

The following shows the list of the properties to be displayed in the "Service Definition" window:

(Legend)

R: The property must be specified.

O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.

Property key	Property name	Description	I/O type	Shared	Required	Property group
aws.targetHost	Host name of the AWS control server	Specify the host name or IP address of the AWS control server. IPv6 address is not supported.	Input	Disabled	R	Virtual system environment information
aws.accessKeyId	Access key ID	Specify the access key ID for connecting to AWS.	Input	Disabled	R	Virtual system environment information
aws.secretAccessKey	Secret access key	Specify the secret access key for connecting to AWS.	Input	Disabled	R	Virtual system environment information
aws.region	Region	Specify an AWS region that is a connection destination.	Input	Disabled	R	Virtual system environment information
aws.checkInstanceEnabledCount	Instance status (started) check count	Specify the number of times to check for instance start. The maximum waiting time is determined by combining this count and the instance status (started) check interval.	Input	Disabled	R	Execute option
aws.checkInstanceEnabledInterval	Instance status (started) check interval	Specify the interval (in seconds) to check for instance start.	Input	Disabled	R	Execute option

The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
aws.foreachInstanceId	Instance ID (multiple selection allowed)	Specify an instance ID or instance IDs. To specify multiple IDs, separate them by using a comma. Up to 99 IDs can be specified.	Input	Disabled	R	Instance information

The following shows the list of the properties to be displayed in the "Task Details" window only:

Property key	Property name	Description	I/O type	Shared
common.taskResult	Results of repeating tasks	This property contains the results of each task (as "true" or "false"), in a comma-delimited format.	Output	Disabled

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

Property key	Characters that can be input
aws.targetHost	No more than 256 single-byte alphanumeric characters, periods (.), or hyphens (-).
aws.accessKeyId	No more than 64 single-byte alphanumeric characters or single-byte symbols (excluding the following symbols: <, >, |, ", ', ;, and &).
aws.secretAccessKey	No more than 128 single-byte alphanumeric characters or single-byte symbols (excluding the following symbols: <, >, |, ", ', ;, and &).
aws.region	No more than 32 single-byte alphanumeric characters or hyphens (-).
aws.checkInstanceEnabledCount	An integer from 1 to 2,147,483,647.
aws.checkInstanceEnabledInterval	An integer from 1 to 60.

The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Characters that can be input
aws.foreachInstanceId	No more than 1,024 single-byte alphanumeric characters, hyphens (-), or commas (,).

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
		Plug-in name	Description	Error recovery method
1	powerOnVMAws	powerOnVMAws	Repeats start processing as many times as the number of specified instances.	After removing the cause of the error, run the service again.

To Page Top