nifty-release-vpn-gateway-backup-state
処理概要
API「NiftyReleaseVpnGatewayBackupState」が実行されます。
VPNゲートウェイのバックアップ状態を解除します。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定した、バックアップを保持していないVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-release-vpn-gateway-backup-state [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --vpn-gateway-id ID | -g | VPNゲートウェイユニークIDを指定します。 | ○ (VPNゲートウェイ名といずれか) |
| --vpn-gateway-name NAME | -G | VPNゲートウェイ名を指定します。 | ○ (VPNゲートウェイユニークIDといずれか) |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- VPNGATEWAY / vpnGatewayId or vpnGatewayName
実行サンプル
PROMPT>nifty-describe-vpn-gateway-activities -g vgw-8db04f81
VPNGATEWAY vgw-8db04f81
