5.2.7 Acquiring a list of information about snapshots
Function
This plug-in outputs a list of snapshots managed in the Amazon EBS environment to the AWS operating server (execution target server) in CSV format.
The encoding format for output files is the default encoding for the AWS operating server (execution target server) system.
The prerequisite server for this plug-in is as follows:
- AWS operating server (execution target server)
AWS Tools for Windows PowerShell (AWS Tools below) is installed on this server. This product transfers plug-ins to this server for execution.
Scripts in this plug-in execute the following AWS Tools commandlet.
- Get-EC2Snapshot
For details of the AWS Tools commandlets, see the AWS document AWS Tools for Windows PowerShell Cmdlet Reference.
The following CSV file items are output. Items are delimited with a comma.
(a) Volume ID (header name: VolumeId)
(b) Snapshot start time (header name: StartTime)
(c) Snapshot ID (header name: SnapshotId)
(d) Snapshot state (header name: State)
(e) Snapshot description (header name: Description)
Use situation
This plug-in can be used to acquire information about a snapshot managed in the Amazon EBS environment.
Prerequisites
For the latest support status of the following items, see the Release notes: Prerequisite products within the system, prerequisite products on the execution target server, and running OS for prerequisite products on the execution target server.
Prerequisite product within the system:
- JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution target server:
- AWS Tools for Windows PowerShell
- Microsoft .Net Framework 3.5 or later
Running OS for prerequisite products on the execution target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
However, a Server Core installation environment is excluded.
Cautions
(1) Do not use a character string containing a double quotation mark (") or single quotation mark (') in a plug-in property.
(2) For other cautions, see the descriptions about cautions in the AWS document AWS Tools for Windows PowerShell Cmdlet Reference.
(3) If a file is already specified for the file name (common.fileName-property), that file is overwritten. Therefore, make sure that the specified file name is correct.
(4) If no folder exists in the path of the file to be created, that folder is created.
Execution privilege
(1) A policy setting is required so that an IAM user who logs in to AWS can perform the following action:
- Referencing a snapshot
Version
02.00.00
Plug-in tags
Gather VM information,AWS
Plug-in name displayed in the task log
awsOutputSnapshotSpec
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component 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 |
|
common.fileName |
File name |
Specify the file name of the file that outputs the snapshot list, by using a full path. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |