nifty-delete-vpn-connection
処理概要
API「DeleteVpnConnection」が実行されます。
指定されたVPNコネクションを削除します。
接続されているVPNゲートウェイがバックアップを保持している場合は、オプション「--agreement」を指定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-delete-vpn-connection VPNコネクションユニークID [オプション]
オプション
オプション | 短縮 | 説明 | 必須 |
---|---|---|---|
--agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します。 | ○ バックアップを保持する場合のみ |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- VPNCONNECTION / vpnConnectionId
実行サンプル
PROMPT>nifty-delete-vpn-connection vpn-44a8938f
VPNCONNECTION vpn-44a8938f