5.2.16 Virtual server information list
Function
This plugin outputs an information list of instances managed in an Amazon EC2 environment to a CSV file on an AWS control server (execution target server).
The character encoding of the output file is the default encoding of the system on the AWS control server (execution target server).
This plugin assumes the following server:
- AWS control server (execution target server)
A server on which AWS Tools for Windows PowerShell (abbreviated hereafter to "AWS Tools") is installed. AWS Tools transfers the plugin to, and executes it on, this server.
- Instance
A standard virtual server, with a virtual host in an Amazon EC2 environment
The script within this plugin executes the following AWS Tools commandlet:
- Get-EC2Instance
For details about AWS Tools commandlets, see the AWS document "AWS Tools for Windows PowerShell Cmdlet Reference".
The items in a CSV file that is output are shown below.
Each item is output, separated by a comma.
(a) VPC ID (Header name: VPCID)
(b) Instance ID (Header name: InstanceID)
(c) AMI ID (Header name: AMIID)
(d) Instance state (Header name: State)
(e) Instance type (Header name: InstanceType)
Use situation
This plugin can be used to obtain information about instances managed in an Amazon EC2 environment.
Prerequisites
For the latest support information about [Required product for the system], [Required products for the service template execution server], and [Prerequisite OS for the required products for the service template execution server], see the Release Notes.
[Required product for the system]
- JP1/Automatic Operation 11-00 or later
[Required products for the service template execution server]
- AWS Tools for Windows PowerShell
- Microsoft .Net Framework 3.5 or later
[Prerequisite OS for the required products for the service template execution server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Note that this does not apply to environments in which Server Core is installed.
Cautions
(1) Do not specify character strings containing double quotation marks (") or single quotation marks (') in the properties of this plugin.
(2) If the file specified in the AWS.vmInfoListOutputFileName property (the output file name of an instance information list) already exists, the existing file will be overwritten. Therefore, make sure that the specified file name is correct.
(3) Create any missing folders that are included in the path to the file to be created.
(4) For other notes, see the notes in the AWS document "AWS Tools for Windows PowerShell Cmdlet Reference".
Execution privilege
(1) Policies must be set up so that IAM users logging in to AWS can perform the following action:
- Obtaining instance information
Version
02.01.00
Plug-in tags
Gather VM information,AWS
Plug-in name displayed in the task log
awsOutputVmSpec
Return code
0: Normal
12: Error (User error) Invalid property
23: Error (Invalid environment) Required environment is invalid
27: Error (Check task logs for the nature of error)
41: Error (Error detected in plugin) Missing property (Error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
AWS.accessKeyId |
Access key ID |
Specify the access key ID for connecting to AWS. |
-- |
Input |
R |
|
AWS.secretAccessKey |
Secret access key |
Specify the secret access key for connecting to AWS. |
-- |
Input |
R |
|
AWS.region |
Region |
Specify an AWS region that is a connection destination. |
-- |
Input |
R |
|
AWS.vmInfoListOutputFileName |
Instance information listing file name |
Specify a file, as a full path name, where instance information is to be listed. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |