DescribeVpnConnections#

Description#

Describes one or more of your VPN connections.

Request Parameters#

  • Filter.N — One or more filters.

    • Type: List of Filter objects

    • Required: No

  • VpnConnectionId.N — IDs of VPN connections.

    • Type: String

    • Default: List of all VPN connections

Supported Filters#

  • customer-gateway-id — The ID of the customer gateway of the VPN connection.

  • state — The state of the VPN connection (pending | available | deleting).

  • tag-key — The tag key. Such a filter allows you to get resources with the specified key and any value.

  • tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.

  • type — The type of the VPN connection (ipsec.1 | ipsec.legacy).

  • vpn-connection-id — The ID of the VPN connection.

  • vpn-gateway-id — The ID of the VPN gateway at the CROC Cloud side of the VPN connection.

Response Elements#

  • requestId — The request ID.

    • Type: String

  • vpnConnectionSet — Information about one or more VPN connections.

Examples#

c2-ec2 DescribeVpnConnections

c2-ec2 DescribeVpnConnections VpnConnectionId.1 <vpn_id>

c2-ec2 DescribeVpnConnections Filter.1.Name state Filter.1.Value.1 available

c2-ec2 DescribeVpnConnections Filter.1.Name vpn-gateway-id Filter.1.Value.1 <vgw_id>

c2-ec2 DescribeVpnConnections Filter.1.Name tag:<tag-key> Filter.1.Value <tag-value>

c2-ec2 DescribeVpnConnections Filter.1.Name tag-key Filter.1.Value <tag-key>