nifty-replace-router-latest-version
処理概要
API「NiftyReplaceRouterLatestVersion」が実行されます。
指定したルーターを最新バージョンに入れ替えます。
入替前のルーターは、バックアップとして一定期間保持されます。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定した、既に最新バージョンのルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターが既にバックアップを保持している場合は、オプション「--agreement」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-replace-router-latest-version [オプション]
オプション
オプション | 短縮 | 説明 | 必須 |
---|---|---|---|
--router-id | -r | ルーターユニークIDを指定します。 | ○ (ルーター名といずれか) |
--router-name | -R | ルーター名を指定します。 | ○ (ルーターユニークIDといずれか) |
--agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します Default:false |
○ (バックアップを保持する場合のみ) |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- ROUTER / routerId or routerName
実行サンプル
PROMPT>nifty-replace-router-latest-version -R router1 --agreement
ROUTER router1