nifty-create-router
処理概要
API「NiftyCreateRouter」が実行されます。
ルーターを新規作成します。
ルーターに割り当てるネットワークを指定するためには、ネットワークIDまたはネットワーク名が必要です。削除済みのネットワークを指定した、管理外のネットワークを指定したなど、無効なネットワークを指定した場合は、エラーが返されます。同様に、ルーターのタイプに規定外の値を指定した、すでに存在するルーター名を指定した、利用料金タイプに無効な値を指定したなどの場合は、エラーが返されます。
作成したルーターのゾーンは指定したネットワークと同一のゾーンになります。
コマンド構文
nifty-create-router [オプション]
オプション
オプション | 短縮 | 説明 | 必須 |
---|---|---|---|
--router-name NAME | ルーター名を指定します。 | ||
--availability-zone ZONE | ゾーン名を指定します。 | ||
--accounting-type ACTYPE | 利用料金タイプを指定します。 1 (月額課金) | 2 (従量課金) |
||
--description DESCRIPTION | メモを指定します。 | ||
--type TYPE | ルーターのタイプを指定します。 small | medium | large |
||
--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はどちらか1つを指定します。)
|
○ |
--security-group GROUP1 [,GROUP2 ,...] | ファイアウォールグループ名を指定します。 |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- ROUTER / routerId
- ROUTER / routerName
- ROUTER / state
- ROUTER / availabilityZone
- ROUTER / accountingType
- ROUTER / nextMonthAccountingType
- ROUTER / description
- ROUTER / routeTableId
- ROUTER / routeTableAssociationId
- ROUTER / natTableId
- ROUTER / natTableAssociationId
- ROUTER / type
- ROUTER / createdTime
- VERSION_INFORMATION / isLatest
- VERSION_INFORMATION / version
- NETWORK_INTERFACE / networkId
- NETWORK_INTERFACE / networkName
- NETWORK_INTERFACE / deviceIndex
- NETWORK_INTERFACE / ipAddress
- NETWORK_INTERFACE / cidrBlock
- NETWORK_INTERFACE / dhcp
- NETWORK_INTERFACE / dhcpOptionsId
- NETWORK_INTERFACE / dhcpConfigId
- NETWORK_INTERFACE / description
- BACKUP_INFORMATION / isBackup
- BACKUP_INFORMATION / expirationDate
- GROUP / groupId
実行サンプル
PROMPT>nifty-create-router --router-name router1 --availability-zone east-12 --accounting-type 2 --description memo --type small --network “network-id=net-COMMON_GLOBAL” --network ”network-id=net-ea2432dw,ip-address=192.168.0.1,dhcp,dhcp-options-id=dopt-df45dsvd,dhcp-config-id=dconf-0k87jhf0”
ROUTER rt-8db04f81 router1 pending east-12 2 2 memo small
VERSION_INFORMATION true vyos 1.1.5
NETWORK_INTERFACE net-COMMON_GLOBAL false
NETWORK_INTERFACE net-ea2432dw true 192.168.0.1 dconf-0k87jhf0
BACKUP_INFORMATION false