create-vpn-connection

Description

VPNコネクションを新規作成します。

拠点間VPN設定（拠点間VPNゲートウェイとカスタマーゲートウェイ間）を行います。

トンネルモードを「Managed」に指定した場合、以下の項目は指定ができません。

  • NiftyTunnel.TunnelId、NiftyTunnel.PeerTunnelId、NiftyTunnel.SessionId、NiftyTunnel.PeerSessionId、NiftyTunnel.SourcePort、NiftyTunnel.DestinationPort

またトンネルモードが「Unmanaged」でかつカプセル化が「IP」の場合は、以下の項目は指定ができません。

  • NiftyTunnel.SourcePort、NiftyTunnel.DestinationPort

またトンネルタイプが設定されていない場合は、MTUサイズは指定ができません。

指定した拠点間VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

See also: NIFCLOUD API Documentation

Synopsis

  create-vpn-connection
[--agreement | --no-agreement]
[--customer-gateway-id <value>]
[--nifty-customer-gateway-name <value>]
[--nifty-ipsec-configuration <value>]
[--nifty-tunnel <value>]
[--nifty-vpn-connection-description <value>]
[--nifty-vpn-connection-mtu <value>]
[--nifty-vpn-gateway-name <value>]
--type <value>
[--vpn-gateway-id <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--agreement | --no-agreement (boolean)

--customer-gateway-id (string)

--nifty-customer-gateway-name (string)

--nifty-ipsec-configuration (structure) DiffieHellmanGroup -> (integer)

EncapsulatingSecurityPayloadLifetime -> (integer)

EncryptionAlgorithm -> (string)

HashAlgorithm -> (string)

InternetKeyExchange -> (string)

InternetKeyExchangeLifetime -> (integer)

PreSharedKey -> (string)

Shorthand Syntax:

DiffieHellmanGroup=integer,EncapsulatingSecurityPayloadLifetime=integer,EncryptionAlgorithm=string,HashAlgorithm=string,InternetKeyExchange=string,InternetKeyExchangeLifetime=integer,PreSharedKey=string

JSON Syntax:

{
  "DiffieHellmanGroup": integer,
  "EncapsulatingSecurityPayloadLifetime": integer,
  "EncryptionAlgorithm": "AES128"|"AES256"|"3DES",
  "HashAlgorithm": "SHA1"|"MD5"|"SHA256"|"SHA384"|"SHA512",
  "InternetKeyExchange": "IKEv1"|"IKEv2",
  "InternetKeyExchangeLifetime": integer,
  "PreSharedKey": "string"
}

--nifty-tunnel (structure) DestinationPort -> (string)

Encapsulation -> (string)

Mode -> (string)

PeerSessionId -> (string)

PeerTunnelId -> (string)

SessionId -> (string)

SourcePort -> (string)

TunnelId -> (string)

Type -> (string)

Shorthand Syntax:

DestinationPort=string,Encapsulation=string,Mode=string,PeerSessionId=string,PeerTunnelId=string,SessionId=string,SourcePort=string,TunnelId=string,Type=string

JSON Syntax:

{
  "DestinationPort": "string",
  "Encapsulation": "IP"|"UDP",
  "Mode": "Unmanaged"|"Managed",
  "PeerSessionId": "string",
  "PeerTunnelId": "string",
  "SessionId": "string",
  "SourcePort": "string",
  "TunnelId": "string",
  "Type": "L2TPv3"
}

--nifty-vpn-connection-description (string)

--nifty-vpn-connection-mtu (string)

--nifty-vpn-gateway-name (string)

--type (string)

Possible values:

  • IPsec

  • L2TPv3 / IPsec

  • IPsec VTI

--vpn-gateway-id (string)

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

RequestId -> (string)

VpnConnection -> (structure)

CreatedTime -> (timestamp)

CustomerGatewayId -> (string)

NiftyCustomerGatewayName -> (string)

NiftyIpsecConfiguration -> (structure)

DiffieHellmanGroup -> (integer)

EncapsulatingSecurityPayloadLifetime -> (integer)

EncryptionAlgorithm -> (string)

HashingAlgorithm -> (string)

InternetKeyExchange -> (string)

InternetKeyExchangeLifetime -> (integer)

Mtu -> (string)

PreSharedKey -> (string)

NiftyTunnel -> (structure)

DestinationPort -> (string)

Encapsulation -> (string)

Mode -> (string)

PeerSessionId -> (string)

PeerTunnelId -> (string)

SessionId -> (string)

SourcePort -> (string)

TunnelId -> (string)

Type -> (string)

NiftyVpnConnectionDescription -> (string)

NiftyVpnGatewayName -> (string)

State -> (string)

TagSet -> (list)

(structure)

Key -> (string)

Value -> (string)

Type -> (string)

VgwTelemetry -> (list)

(structure)

AcceptedRouteCount -> (integer)

LastStatusChange -> (timestamp)

OutsideIpAddress -> (string)

Status -> (string)

StatusMessage -> (string)

VpnConnectionId -> (string)

VpnGatewayId -> (string)