本文へジャンプします。

ニフクラ APIリファレンス

nifty-describe-vpn-connections

処理概要

API「DescribeVpnConnections」が実行されます。
指定されたVPNコネクションの情報を取得します。
VPNコネクションを指定するためには、VPNコネクションユニークIDが必要です。削除済みのVPNコネクションを指定した、管理外のVPNコネクションを指定したなど、無効なVPNコネクションを指定した場合は、エラーが返されます。
VPNコネクションを指定しない場合、取得できるすべてのVPNコネクション情報を取得します。

絞り込み条件の項目の値を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「*」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字(「\*nifty\?\\ 」は「*nifty?\」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、customer-gateway-configuration、nifty-customer-gateway-name、route.destination-cidr-block、nifty-vpn-gateway-name、nifty-vpn-connection-descriptionになります。

コマンド構文

nifty-describe-vpn-connections [VPNコネクションユニークID [VPNコネクションユニークID […]]] [オプション]

オプション

オプション 短縮 説明 必須
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...]   絞り込み条件を指定します。
"customer-gateway-configuration=値1,値2,..." : カスタマーゲートウェイに設定する情報による絞り込み
"customer-gateway-id=値1,値2,..." : カスタマーゲートウェイユニークIDによる絞り込み
"nifty-customer-gateway-name=値1,値2,..." : カスタマーゲートウェイ名による絞り込み
"state=値1,値2,..." : VPNコネクションステータスによる絞り込み
"route.destination-cidr-block=値1,値2,..." : 宛先CIDRブロックによる絞り込み
"type=値1,値2,..." : VPNコネクションタイプによる絞り込み
"vpn-connection-id=値1,値2,..." : VPNコネクションユニークIDによる絞り込み
"vpn-gateway-id=値1,値2,..." : VPNゲートウェイユニークIDによる絞り込み
"nifty-vpn-gateway-name=値1,値2,..." : VPNゲートウェイ名による絞り込み
"nifty-vpn-connection-description=値1,値2,..." : VPNコネクションメモによる絞り込み
"nifty-internet-key-exchange=値1,値2,..." : IKEプロトコルによる絞り込み
 

出力要素

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

  • VPNCONNECTION / vpnConnectionId
  • VPNCONNECTION / state
  • VPNCONNECTION / type
  • VPNCONNECTION / vpnGatewayId
  • VPNCONNECTION / niftyVpnGatewayName
  • VPNCONNECTION / customerGatewayId
  • VPNCONNECTION / niftyCustomerGatewayName
  • VPNCONNECTION / niftyVpnConnectionDescription
  • VPNCONNECTION / createdTime
  • CUSTOMERGATEWAY_CONFIGURATION / customerGatewayConfiguration
  • VGWTELEMETRY / outsideIpAddress
  • VGWTELEMETRY / status
  • VGWTELEMETRY / lastStatusChange
  • VGWTELEMETRY / statusMessage
  • VGWTELEMETRY / acceptedRouteCount
  • ROUTES / destinationCidrBlock
  • ROUTES / source
  • ROUTES / state
  • TUNNEL / type
  • TUNNEL / mode
  • TUNNEL / encapsulation
  • TUNNEL / tunnelId
  • TUNNEL / peerTunnelId
  • TUNNEL / sessionId
  • TUNNEL / peerSessionId
  • TUNNEL / sourcePort
  • TUNNEL / destinationPort
  • IPSEC_CONFIGURATION / encryptionAlgorithm
  • IPSEC_CONFIGURATION / hashingAlgorithm
  • IPSEC_CONFIGURATION / preSharedKey
  • IPSEC_CONFIGURATION / internetKeyExchange
  • IPSEC_CONFIGURATION / mtu

実行サンプル

PROMPT>nifty-describe-vpn-connections --filter "state=available"
VPNCONNECTION vpn-44a8938f available IPsec vgw-8db04f81 vpngw1 cgw-b4dc3961 customergw1
IPSEC_CONFIGURATION 3DES MD5 IKEv1
VPNCONNECTION vpn-8db04f81 available IPsec vgw-8db04f81 vpngw1 cgw-b4dc3961 customergw1
IPSEC_CONFIGURATION 3DES MD5 IKEv1

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

APIメニュー

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

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