nifty-update-router-network-interfaces
処理概要
API「NiftyUpdateRouterNetworkInterfaces」が実行されます。
指定したルーターのネットワークの割り当てを変更します。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
またルーターに割り当てるネットワークを指定するためには、ネットワークIDまたはネットワーク名が必要です。削除済みのネットワークを指定した、管理外のネットワークを指定したなど、無効なネットワークを指定した場合は、エラーが返されます。
ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-update-router-network-interfaces [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --router-id ID | -r | ルーターユニークIDを指定します。 | ○ (ルーター名といずれか) |
| --router-name NAME | -R | ルーター名を指定します。 | ○ (ルーターユニークIDといずれか) |
| --network "network-id=value, network-name=value,ip-address=value[, dhcp], dhcp-options-id=value,dhcp-config-id=value",[ --network "network-id=value,network-name=value,ip-address=value[,dhcp],dhcp-options-id=value,dhcp-config-id=value"] | -n | ルーターに設定するネットワークID、ネットワーク名、IPアドレス、dhcp設定フラグ、dhcpオプションID、dhcpコンフィグIDを指定します。 （network-idとnetwork-nameはどちらか１つを指定します。）
|
○ |
| --reboot REBOOT | 再起動オプションを指定します。 force（強制再起動） | true（通常再起動） |
(ルーターユニークIDといずれか) |
|
| --agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します。 | ○ （バックアップを保持する場合のみ） |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- ROUTER / routerId or routerName
実行サンプル
PROMPT>nifty-update-router-network-interfaces --router-name router1 --network “network-name=network1”
ROUTER router1
