nifty-modify-vpn-gateway-attribute
処理概要
API「NiftyModifyVpnGatewayAttribute」が実行されます。
指定されたVPNゲートウェイの詳細情報を更新します。1回のリクエストで、1つのVPNゲートウェイの情報を更新できます。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイ名、VPNゲートウェイタイプの更新時、VPNゲートウェイがバックアップを保持している場合は、オプション「--agreement」を指定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-modify-vpn-gateway-attribute [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --vpn-gateway-id ID | -g | VPNゲートウェイユニークIDを指定します。 | ○ (VPNゲートウェイ名といずれか) |
| --vpn-gateway-name NAME | -G | VPNゲートウェイ名を指定します。 | ○ (VPNゲートウェイユニークIDといずれか) |
| --vpn-gateway-name-update NAME | VPNゲートウェイ名を更新します。 | ||
| ---type TYPE | VPNゲートウェイのタイプを更新します。 small | medium | large |
||
| --accounting-type ACTYPE | 利用料金タイプを更新します。 1 (月額課金) | 2 (従量課金) |
||
| --description DESCRIPTION | VPNゲートウェイのメモを更新します。 | ||
| --agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します。 | ○ (バックアップを保持する場合のみ) |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- vpnGatewayId or vpnGatewayName
- 属性名（指定したパラメーターによって異なります）
- value
実行サンプル
PROMPT>nifty-modify-vpn-gateway-attribute -g vgw-8db04f81 -accounting-type1
vgw-8db04f81 accountingType 1
