nifty-associate-route-table-with-vpn-gateway
処理概要
API「NiftyAssociateRouteTableWithVpnGateway」が実行されます。
指定したVPNゲートウェイへルートテーブル設定する。
ルートテーブルを指定するためには、ルートテーブルIDが必要です。VPNゲートウェイに設定済のルートテーブルを指定した、管理外のルートテーブルを指定したなど、無効なルートテーブルを指定した場合は、エラーが返されます。
またVPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイがバックアップを保持している場合は、オプション「--agreement」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-associate-route-table-with-vpn-gateway ルートテーブルID [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --vpn-gateway-id ID | -g | VPNゲートウェイユニークIDを指定します。 | ○ (VPNゲートウェイ名といずれか) |
| --vpn-gateway-name NAME | -G | VPNゲートウェイ名を指定します。 | ○ （VPNゲートウェイユニークIDといずれか） |
| --agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します。 | ○ （バックアップを保持する場合のみ） |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- VPNGATEWAY / associationId
実行サンプル
PROMPT>nifty-associate-route-table-with-vpn-gateway rtb-e4ad488d -g vgw-8db04f81
VPNGATEWAY natassoc-12ad487b
