本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラ CLI>nifty-deregister-vpn-gateways-from-security-group

nifty-deregister-vpn-gateways-from-security-group

処理概要

API「NiftyDeregisterVpnGatewaysFromSecurityGroup」が実行されます。
指定したファイアウォールグループからVPNゲートウェイをはずします。
削除済みグループや管理外のファイアウォールグループなど、無効なファイアウォールグループを指定した場合、エラーが返されます。
ファイアウォールからはずすためには、VPNゲートウェイ名またはVPNゲートウェイユニークIDを指定します。指定したファイアウォールグループに適用されていないVPNゲートウェイなど、無効なVPNゲートウェイを指定した場合、エラーが返されます。
ファイアウォールグループからVPNゲートウェイをはずす処理には、時間がかかる場合があります。「DescribeSecurityGroups」のレスポンス「groupStatus」でファイアウォールグループのステータスを確認することができます。

コマンド構文

nifty-deregister-vpn-gateways-from-security-groupファイアウォールグループ名 [オプション]

オプション

オプション 短縮 説明 必須
--vpn-gateway-ids ID1 [,ID2,...] -g VPNゲートウェイユニークIDを指定します。
(VPNゲートウェイ名といずれか)
--vpn-gateway-names NAME1 [,NAME2,...] -G VPNゲートウェイ名を指定します。
(VPNゲートウェイユニークIDといずれか)

出力要素

※ニフクラAPIの応答フィールド名を記述します。

  • GROUP / groupName
  • VPNGATEWAY / vpnGatewayId
  • VPNGATEWAY / niftyVpnGatewayName

実行サンプル

PROMPT>nifty-deregister-vpn-gateways-from-security-group websrv --vpn-gateway-names “vpngw1, vpngw2”
GROUP websrv
VPNGATEWAY vpngw1
VPNGATEWAY vpngw2

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年3月13日時点の情報です。

推奨画面サイズ 1024×768 以上