5.2.17 仮想サーバの状態取得
機能
この部品は,Amazon EC2環境でインスタンスの状態を取得します。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降,「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され,実行されます。
・インスタンス
Amazon EC2環境の仮想ホストのことで,一般的な仮想サーバのことです。
この部品内のスクリプトでは,次に示すAWS Toolsのコマンドレットを実行します。
・Get-EC2Instance -Instance "インスタンスID(AWS.instanceIdプロパティ)の値"
上記のコマンドレットの実行結果からInstances.State.Name.Valueプロパティの値を取得して「インスタンスの状態(AWS.instanceStateプロパティ)」に格納します。
このプロパティに格納される値とその意味を次に示します。
値 意味
pending 起動処理中
running 起動中
shutting-down 終了処理中
stopped 停止中
stopping 停止処理中
terminated 終了中
AWS Toolsのコマンドレットの詳細については,AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は,Amazon EC2環境でインスタンスの状態を取得する場合に使用します。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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) インスタンスの前提OS
・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)
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については,AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが,次に示すアクションを行えるようにポリシー設定されている必要があります。
・インスタンスの状態取得
バージョン
02.00.00
部品のタグ
Gather VM information,AWS
タスクログに表示される部品の名称
awsGetVMState
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
AWS.instanceId |
インスタンスID |
インスタンスのIDを指定します。 |
− |
入力 |
○ |
AWS.instanceState |
インスタンスの状態 |
インスタンスの状態が格納されます。 |
− |
出力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |