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