本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラ CLI>nifty-update-vpn-gateway-network-interfaces

nifty-update-vpn-gateway-network-interfaces

処理概要

API「NiftyUpdateVpnGatewayNetworkInterfaces」が実行されます。
VPNゲートウェイのネットワーク設定変更をします。
VPNゲートウェイのユーザ所有ネットワークはIPアドレスが指定できます。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。

VPNゲートウェイがバックアップを保持している場合は、オプション「--agreement」を指定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

コマンド構文

nifty-update-vpn-gateway-network-interfaces [オプション]

オプション

オプション 短縮 説明 必須
--vpn-gateway-id ID -g VPNゲートウェイユニークIDを指定します。
(VPNゲートウェイ名といずれか)
--vpn-gateway-name NAME -G VPNゲートウェイ名を指定します。
(VPNゲートウェイユニークIDといずれか)
--ip-address IPADDRESS   IPアドレスを指定します。  
--force   強制的にサーバーを再起動します。  
--agreement   version up実施したのち、バックアップ状態を解除する事項への同意を指定します。  

出力要素

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

  • VPNGATEWAY / vpnGatewayId or vpngatewayName

実行サンプル

PROMPT>nifty-update-vpn-gateway-network-interfaces -G vpn1 --ip-address 192.168.0.2 --force
VPNGATEWAY vpn1

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

APIメニュー

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

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