nifty-describe-customer-gateways
処理概要
API「DescribeCustomerGateways」が実行されます。
指定したカスタマーゲートウェイの情報を取得します。
カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。削除済みのカスタマーゲートウェイを指定した、管理外のカスタマーゲートウェイを指定したなど、無効なカスタマーゲートウェイを指定した場合は、エラーが返されます。
カスタマーゲートウェイを指定しない場合、取得できるすべてのカスタマーゲートウェイ情報を取得します。
絞り込み条件の項目の値を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「*」は0個以上任意文字、 「?」は1個任意文字、「\」はエスケープ変換文字（「\*nifty\?\\ 」は「*nifty?\」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、ip-address、nifty-customer-gateway-name、nifty-customer-gateway-descriptionになります。
コマンド構文
nifty-describe-customer-gateways [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --customer-gateway-ids ID1 [,ID2 ,...] | カスタマーゲートウェイユニークIDを指定します。 | ||
| --customer-gateway-names NAME1 [,NAME2 ,...] | カスタマーゲートウェイ名を指定します。 | ||
| ---filter “[ATTRIBUTE1=VALUE1[,VALUE2,…]” [--filter “ATTRIBUTE2=VALUE1[,VALUE2,…]”] […] | 絞り込み条件を指定します。 “customer-gateway-id =値1,値2,…” : カスタマーゲートウェイユニークIDによる絞り込み “nifty-customer-gateway-name =値1,値2,…” : カスタマーゲートウェイ名による絞り込み “ip-address=値1,値2,…” : カスタマーゲートウェイのインターネット側IPアドレスによる絞り込み “state=値1,値2,…” : カスタマーゲートウェイステータスによる絞り込み< “nifty-customer-gateway-description=値1,値2,…” :カスタマーゲートウェイメモによる絞り込み |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- CUSTOMERGATEWAY / customerGatewayId
- CUSTOMERGATEWAY / niftyCustomerGatewayName
- CUSTOMERGATEWAY / state
- CUSTOMERGATEWAY / ipAddress
- CUSTOMERGATEWAY / niftyLanSideIpAddress
- CUSTOMERGATEWAY / niftyLanSideCidrBlock
- CUSTOMERGATEWAY / niftyCustomerGatewayDescription
- CUSTOMERGATEWAY / createdTime
実行サンプル
PROMPT>nifty-describe-customer-gateways --cutomer-gateway-ids cgw-8db04f81 --filter “state=available”
CUSTOMERGATEWAY cgw-8db04f81 cgw1 available IPsec 12.1.2.3 2015-10-28T10:16:38+09:00
