Getting Information About Your Client Gateways

You can get information about one or more client gateways.

By default, this action describes all your client gateways.

Getting Information About Your Client Gateways Using Cockpit v2

See the Client Gateways dashboard.

Getting Information About Your Client Gateways Using OSC CLI

The ReadClientGateways command lists one or more of your client gateways.

Request sample

$ osc-cli api ReadClientGateways --profile "default" \
    --Filters '{
        "ClientGatewayIds": ["cgw-12345678"]
      }'

Request sample

$ osc-cli api ReadClientGateways --profile "default" \
    --Filters '{
        "BgpAsns": [65000],
        "PublicIps": ["192.0.2.0", "198.51.100.0"]
      }'

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Filters: (optional) One or more filters.
- BgpAsns: (optional) The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
- ClientGatewayIds: (optional) The IDs of the client gateways.
- ConnectionTypes: (optional) The types of communication tunnels used by the client gateways (always ipsec.1).
- PublicIps: (optional) The public IPv4 addresses of the client gateways.
- States: (optional) The states of the client gateways (pending | available | deleting | deleted).
- TagKeys: (optional) The keys of the tags associated with the client gateways.
- TagValues: (optional) The values of the tags associated with the client gateways.
- Tags: (optional) The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.
ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadClientGateways command returns the following elements:

ClientGateways: Information about one or more client gateways.
- BgpAsn: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- ClientGatewayId: The ID of the client gateway.
- ConnectionType: The type of communication tunnel used by the client gateway (always ipsec.1).
- PublicIp: The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- State: The state of the client gateway (pending | available | deleting | deleted).
- Tags: One or more tags associated with the client gateway.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
NextPageToken: The token to request the next page of results. Each token refers to a specific page.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "ClientGateways": [
    {
      "State": "available",
      "BgpAsn": 65000,
      "Tags": [],
      "ClientGatewayId": "cgw-12345678",
      "ConnectionType": "ipsec.1",
      "PublicIp": "192.0.2.0"
    }
  ]
}

Getting Information About Your Client Gateways Using oapi-cli

The ReadClientGateways command lists one or more of your client gateways.

Request sample

$ oapi-cli --profile "default" ReadClientGateways \
    --Filters '{
        "ClientGatewayIds": ["cgw-12345678"]
      }'

Request sample

$ oapi-cli --profile "default" ReadClientGateways \
    --Filters '{
        "BgpAsns": [65000],
        "PublicIps": ["192.0.2.0", "198.51.100.0"]
      }'

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Filters: (optional) One or more filters.
- BgpAsns: (optional) The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
- ClientGatewayIds: (optional) The IDs of the client gateways.
- ConnectionTypes: (optional) The types of communication tunnels used by the client gateways (always ipsec.1).
- PublicIps: (optional) The public IPv4 addresses of the client gateways.
- States: (optional) The states of the client gateways (pending | available | deleting | deleted).
- TagKeys: (optional) The keys of the tags associated with the client gateways.
- TagValues: (optional) The values of the tags associated with the client gateways.
- Tags: (optional) The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.
ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadClientGateways command returns the following elements:

ClientGateways: Information about one or more client gateways.
- BgpAsn: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- ClientGatewayId: The ID of the client gateway.
- ConnectionType: The type of communication tunnel used by the client gateway (always ipsec.1).
- PublicIp: The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- State: The state of the client gateway (pending | available | deleting | deleted).
- Tags: One or more tags associated with the client gateway.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
NextPageToken: The token to request the next page of results. Each token refers to a specific page.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "ClientGateways": [
    {
      "State": "available",
      "BgpAsn": 65000,
      "Tags": [],
      "ClientGatewayId": "cgw-12345678",
      "ConnectionType": "ipsec.1",
      "PublicIp": "192.0.2.0"
    }
  ]
}

Getting Information About Your Customer Gateways Using AWS CLI

Before you begin: Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.

To get information about one or more customer gateways, use the describe-customer-gateways command following this syntax:

Request sample

$ aws ec2 describe-customer-gateways \
    --profile YOUR_PROFILE \
    --filters Name=X,Values=Y \
    --endpoint https://fcu.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
(optional) customer-gateway-ids: The ID of one or more customer gateways you want to get information about.

(optional) filters: One or more filters, in the "Name=X,Values=Y" format.

You can specify several values for a same filter using the "Name=X,Values=Y, Z" format.

The following filters are available:

state: The state of the customer gateways (pending | available | deleting | deleted). For more information, see About Client Gateways.
customer-gateway-id: The ID of the customer gateway.
ip-address: The public IP of the customer gateway.
bgp-asn: An Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet. For more information, see About Client Gateways.
type: The type of VPN connection the customer gateway supports (always ipsec.1).

tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.

tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

To filter a tag whose key is XXXX and value is YYYY, you can therefore use either of the following two formats:

--filters Name=tag-key,Values=XXXX Name=tag-value,Values=YYYY
--filters Name=tag:XXXX,Values=YYYY

endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The describe-customer-gateways command returns the following elements:

CustomerGateway: Information about one or more customer gateways. This element contains the following information:
Tags: One or more tags associated with the customer gateway. This element contains the following information:
- Key: The key of the tag.
- Value: The value of the tag.
Type: The type of VPN connection the customer gateway supports (always ipsec.1).
State: The state of the customer gateway (pending | available | deleting | deleted). For more information, see About Client Gateways.
CustomerGatewayId: The ID of the customer gateway.
BgpAsn: An Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet. For more information, see About Client Gateways.
IpAddress: The public IP of the customer gateway.

Result sample

{
    "CustomerGateways": [
        {
            "Tags": [],
            "Type": "ipsec.1",
            "State": "available",
            "CustomerGatewayId": "cgw-73a7fba3",
            "BgpAsn": "65000",
            "IpAddress": "198.18.7.207"
        }
    ]
}

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.