5.2.7 スナップショットの情報一覧取得
機能
この部品は，Amazon EBS環境で管理されているスナップショット一覧をCSV形式で，AWS操作サーバ(実行対象サーバ)のファイルに出力します。
出力ファイルのエンコード形式は，AWS操作サーバ(実行対象サーバ)のシステムのデフォルトエンコーディングです。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。
この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。
・Get-EC2Snapshot
AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a)ボリュームID(ヘッダー名：VolumeId)
(b)スナップショット開始時間(ヘッダー名：StartTime)
(c)スナップショットID(ヘッダー名：SnapshotId)
(d)スナップショットの状態(ヘッダー名：State)
(e)スナップショットの説明(ヘッダー名：Description)
利用場面
この部品は，Amazon EBS環境で管理されているスナップショットの情報を取得する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
・AWS Tools for Windows PowerShell
・Microsoft .Net Framework 3.5以降
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
ただし，Server Coreインストール環境は除く。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
(3)ファイル名(common.fileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。
(4)作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。
実行権限
(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。
・スナップショットの参照
バージョン
02.00.00
部品のタグ
Gather VM information,AWS
タスクログに表示される部品の名称
awsOutputSnapshotSpec
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
|
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
|
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
|
common.fileName |
ファイル名 |
スナップショット一覧を出力するファイルのファイル名をフルパスで指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |