nifty-describe-vpn-gateways
処理概要
API「DescribeVpnGateways」が実行されます。
指定したVPNゲートウェイの情報を取得します。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイを指定しない場合、取得できるすべてのVPNゲートウェイ情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「*」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字（「\*nifty\?\\ 」は「*nifty?\」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、nifty-vpn-gateway-name、nifty-vpn-gateway-descriptionになります。
コマンド構文
nifty-describe-vpn-gateways [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --vpn-gateway-ids ID1 [ID2…] | VPNゲートウェイユニークIDを指定します。 | ||
| --vpn-gateway-names NAME1 [,NAME2,…] | VPNゲートウェイ名を指定します。 | ||
| --filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...] | 絞込み条件を指定します。 “availability-zone=値1,値2,…“ : ゾーン情報による絞込み “state=値1,値2,…“ : VPNゲートウェイステータスによる絞込み “vpn-gateway-id=値1,値2,…“ : VPNゲートウェイユニークIDによる絞込み “nifty-vpn-gateway-name=値1,値2,…“ : VPNゲートウェイ名による絞込み “nifty-vpn-gateway-type=値1,値2,…“ : VPNゲートウェイタイプによる絞込み “nifty-vpn-gateway-description=値1,値2,…“ : VPNゲートウェイメモによる絞込み “nifty-vpn-gateway-accountingType=値1,値2,…“ : VPNゲートウェイ利用料金タイプによる絞込み “ip-address=値1,値2,…“ : VPNゲートウェイのIPアドレスによる絞込み “latest-version-information=値1,値2,…“ : VPNゲートウェイのversionの更新情報による絞込み “version=値1,値2,…“ : VPNゲートウェイのversion情報による絞込み |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- VPNGATEWAY / vpnGatewayId
- VPNGATEWAY / niftyVpnGatewayName
- VPNGATEWAY / state
- VPNGATEWAY / availabilityZone
- VPNGATEWAY / niftyVpnGatewayType
- VPNGATEWAY / niftyRedundancy
- VPNGATEWAY / niftyVpnGatewayDescription
- VPNGATEWAY / accountingType
- VPNGATEWAY / nextMonthAccountingType
- VPNGATEWAY / routeTableId
- VPNGATEWAY / routeTableAssociationId
- VPNGATEWAY / createdTime
- VERSION_INFORMATION / isLatest
- VERSION_INFORMATION / version
- NETWORK_INTERFACE / networkId
- NETWORK_INTERFACE / networkName
- NETWORK_INTERFACE / deviceIndex
- NETWORK_INTERFACE / ipAddress
- NETWORK_INTERFACE / cidrBlock
- NETWORK_INTERFACE / description
- BACKUP_INFORMATION / isBackup
- BACKUP_INFORMATION / expirationDate
- GROUP / groupId
実行サンプル
PROMPT>nifty-describe-vpn-gateways --vpn-gateway-ids vgw-8db04f81 --filter “state=available”
VPNGATEWAY vgw-0avs0apm create01 available east-11 medium false 1 1 2 rt-01234567 rtbassoc-01234567 2015-01-15T14:02:21+09:00
VERSION_INFORMATION true vyos 1.1.5
NETWORK_INTERFACE net-COMMON_GLOBAL 0 111.171.134.162
NETWORK_INTERFACE net-0nzh8np7 network6 0 192.168.100.1 192.168.100.0/24 1
BACKUP_INFORMATION true 2015/01/01
GROUP fw01
