本文へジャンプします。

ニフクラ APIリファレンス

nifty-reboot-vpn-gateways

処理概要

API「NiftyRebootVpnGateways」が実行されます。
指定したVPNゲートウェイを再起動します。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイの再起動には、時間がかかることがあります。VPNゲートウェイのステータスは、API「DescribeVpnGateways」のレスポンス値「state」で確認できます。

コマンド構文

nifty-reboot-vpn-gateways [オプション]

オプション

オプション 短縮 説明 必須
--vpn-gateways "gateway-id=value, gateway-name=value, force", [ --vpn-gateways "gateway-id=value, gateway-name=value, force " ]   再起動するVPNゲートウェイユニークID、VPNゲートウェイ名、強制再起動を指定します。
(gateway-idとgateway-nameはどちらか1つを指定します。)
  • gateway-id
    VPNゲートウェイユニークIDを指定します。
  • gateway-name
    VPNゲートウェイ名を指定します。
  • force
    指定した場合、強制的にサーバーを再起動します。

出力要素

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

  • VPNGATEWAY / gatewayId or gatewayName

実行サンプル

PROMPT>nifty-reboot-vpn-gateways --vpn-gateways "gateway-id=vgw-8db04f81"
VPNGATEWAY vgw-8db04f81

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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