本文へジャンプします。

ニフクラ APIリファレンス

nifty-create-vpn-gateway

処理概要

API「CreateVpnGateway」が実行されます。
VPNゲートウェイを新規作成します。

コマンド構文

nifty-create-vpn-gateway [オプション]

オプション

オプション 短縮 説明 必須
--vpn-gateway-name GATEWAYNAME   VPNゲートウェイ名を指定します。  
--vpn-gateway-type GATEWAYTYPE   VPNゲートウェイのタイプを指定します。
small | medium | large
 
--redundancy   冗長化オプションを指定します。  
--availability-zone ZONE   ゾーン名を指定します。  
--accounting-type TYPE   利用料金タイプを指定します。
1 (月額課金) | 2 (従量課金)
 
--vpn-gateway-description DESCRIPTION   メモを指定します。  
--network-id NETWORKID -n プライベート側ネットワークIDを指定します。
(プライベート側ネットワーク名といずれか)
--network-name NETWORKNAME -N プライベート側ネットワーク名を指定します。
(プライベート側ネットワークIDといずれか)
--network-ip-address IPADDRESS   プライベート側IPアドレス(IPv4)を指定します。  
--security-group GROUP 1 [ ,GROUP,… ]   ファイアウォールグループ名を指定します。  

出力要素

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

  • VPNGATEWAY / vpnGatewayId
  • VPNGATEWAY / niftyVpnGatewayName
  • VPNGATEWAY / state
  • VPNGATEWAY / availabilityZone
  • VPNGATEWAY / niftyVpnGatewayType
  • VPNGATEWAY / niftyRedundancy
  • VPNGATEWAY / niftyVpnGatewayDescription
  • VPNGATEWAY / accountingType
  • VPNGATEWAY / nextMonthAccountingType
  • VPNGATEWAY / routeTableId
  • VPNGATEWAY / routeTableAssociationId
  • VPNGATEWAY / createdTime
  • VERSION_INFORMATION / isLatest
  • VERSION_INFORMATION / version
  • NETWORK_INTERFACE / networkId
  • NETWORK_INTERFACE / networkName
  • NETWORK_INTERFACE / deviceIndex
  • NETWORK_INTERFACE / ipAddress
  • NETWORK_INTERFACE / cidrBlock
  • NETWORK_INTERFACE / description
  • BACKUP_INFORMATION / isBackup
  • BACKUP_INFORMATION / expirationDate
  • GROUP / groupId

実行サンプル

PROMPT>nifty-create-vpn-gateway --nifty-vpn-gateway-name vpn1 --nifty-vpn-gateway-type small --availability-zone east-11 --nifty-network-name priNw1 --nifty-network-ip-address 192.168.0.1
VPNGATEWAY vgw-8db04f81 vpn1 pending east-11 small false 2
VERSION_INFORMATION true vyos 1.1.5
NETWORK_INTERFACE priNw1l 192.168.0.1
BACKUP_INFORMATION false

ニフクラ サイト内検索

APIメニュー

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

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