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