nifty-create-vpn-connection
処理概要
VPNコネクションを新規作成します。
拠点間VPN設定（VPNゲートウェイとカスタマーゲートウェイ間）を行います。
トンネルモードを「Managed」に指定した場合、以下の項目は指定ができません。
- --tunnel-tunnel-id、--tunnel-peer-tunnel-id、--tunnel-session-id、--tunnel-peer-session-id、--tunnel-source-port、
--tunnel-destination-port
またトンネルモードが「Unmanaged」でかつカプセル化が「IP」の場合は、以下の項目は指定ができません。
- --tunnel-source-port、-tunnel-destination-port
またトンネルタイプが設定されていない場合は、MTUサイズは指定ができません。
指定したVPNゲートウェイがバックアップを保持している場合は、オプション「--agreement」を指定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
コマンド構文
nifty-create-vpn-connection [オプション]
オプション
| オプション | 短縮 | 説明 | 必須 |
|---|---|---|---|
| --type TYPE | -t | VPNコネクションタイプを指定します。 IPsec | L2TPv3 / IPsec | VTI / IPsec |
○ |
| --vpn-gateway-id ID | -g | VPNゲートウェイユニークIDを指定します。 | ○ (VPNゲートウェイ名といずれか) |
| --vpn-gateway-name NAME | -G | VPNゲートウェイ名を指定します。 | ○ (VPNゲートウェイユニークIDといずれか) |
| --customer-gateway-id ID | -c | カスタマーゲートウェイユニークIDを指定します。 | ○ (カスタマーゲートウェイ名といずれか) |
| --customer-gateway-name NAME | -C | カスタマーゲートウェイ名を指定します。 | ○ (カスタマーゲートウェイユニークIDといずれか) |
| --tunnel-type TUNNELTYPE | トンネルタイプを指定します。 L2TPv3 |
○ TYPEがL2TPv3 / IPsecの場合 |
|
| --tunnel-mode TUNNELMODE | トンネルモードを指定します。 Unmanaged | Managed |
○ TUNNELTYPEが設定されている場合 |
|
| --tunnel-encapsulation ENCAPSULATION | カプセル化を指定します。 IP（TUNNELMODEがUnmanagedの場合のみ指定可） | UDP |
○ TUNNELTYPEが設定されている場合 |
|
| --tunnel-tunnel-id TUNNELID | VPNゲートウェイ側トンネルIDを指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --tunnel-peer-tunnel-id PEERTUNNELID | カスタマーゲートウェイ側トンネルIDを指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --tunnel-session-id SESSIONID | VPNゲートウェイ側セッションIDを指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --tunnel-peer-session-id PEERSESSIONID | カスタマーゲートウェイ側セッションIDを指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --tunnel-source-port SOURCEPORT | 送信元ポート（VPNゲートウェイ側ポート）を指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --tunnel-destination-port DESTINATIONPORT | 送信先ポート（カスタマーゲートウェイ側ポート）を指定します。 | ○ TUNNELMODEがUnmanagedの場合 |
|
| --ipsec-conf-encrypt-algorithm ENCRYPTALGORITHM | 暗号化アルゴリズムを指定します。 AES128 | AES256 | 3DES デフォルト: AES128 |
||
| --ipsec-conf-hash-algorithm HASHALGORITHM | 認証アルゴリズムを指定します。 SHA1 | MD5 デフォルト: SHA1 |
||
| --ipsec-conf-mtu MTU | MTUサイズを指定します。 デフォルト: 1500 |
||
| --ipsec-conf-preshared-key PRESHAREDKEY | 事前共有鍵を指定します。 | ||
| --ipsec-conf-internet-key-exchange INTERNETKEYEXCHANGE | IKEプロトコルを指定します。 IKEv1 | IKEv2 デフォルト: IKEv1 |
||
| --description DESCRIPTION | VPNコネクションのメモを指定します。 | ||
| --agreement | version up実施したのち、バックアップ状態を解除する事項への同意を指定します。 | ○ バックアップを保持する場合のみ |
出力要素
※ニフクラ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-create-vpn-connection --type IPsec --vpn-gateway-id vgw-8db04f81 --customer-gateway-id cgw-b4dc3961
VPNCONNECTION vpn-44a8938f pending IPsec vgw-8db04f81 vpngw1 cgw-b4dc3961 customergw1
IPSEC_CONFIGURATION 3DES MD5
