ec2-describe-customer-gateways

Description

Gives you information about your customer gateways. You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could get information only about gateways whose state is pending or available. The customer gateway must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name	Description
`bgp-asn`	The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Type: String
`customer-gateway-id`	ID of the customer gateway. Type: String
`ip-address`	The IP address of the customer gateway's Internet-routable external interface (e.g., 12.1.2.3). Type: String
`state`	The state of the customer gateway. Type: String Valid Values: `pending` \| `available` \| `deleting` \| `deleted`
`type`	The type of customer gateway. Currently the only supported type is `ipsec.1`. Type: String Valid Values: `ipsec.1`
`tag-key`	Key of a tag assigned to the resource. This filter is independent of the `tag-value` filter. For example, if you use both the filter `tag-key=Purpose` and the filter `tag-value=X`, you get any resources assigned both the tag key `Purpose` (regardless of what the tag's value is), and the tag value `X` (regardless of what the tag's key is). If you want to list only resources where Purpose=X, see the `tag:key` filter later in this table. For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide. Type: String
`tag-value`	Value of a tag assigned to the resource. This filter is independent of the `tag-key` filter. Type: String
`tag:``key`	Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: `--filter tag:Purpose=X` Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: `--filter tag:Purpose=X --filter tag:Purpose=Y`

For more information about Amazon Virtual Private Cloud and VPN customer gateways, go to Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

The short version of this command is ec2dcgw.

Syntax

ec2-describe-customer-gateways [ customer_gateway_id ... ] [[--filter name=value] ...]

Options

Name Description Required

Name	Description	Required
`customer_gateway_id`	A customer gateway ID. You can specify more than one in the request. Type: String Default: Returns information about all your customer gateways. Example: cgw-b4dc3961	No
`-F, --filter` `name`=`value`	A filter for limiting the results. See the preceding table for a list of allowed filter names and values. You need to use quotation marks if the value string has a space (e.g., "name=value example"). If you're using the command line tools on a Windows system, you might need to use quotation marks, even when there is no space in the value string (e.g., "name=value"). Type: String Default: Describes all customer gateways you own, or only those otherwise specified. Example: --filter "tag-key=Production"	No

customer_gateway_id

A customer gateway ID. You can specify more than one in the request.

Type: String

Default: Returns information about all your customer gateways.

Example: cgw-b4dc3961

No

-F, --filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. You need to use quotation marks if the value string has a space (e.g., "name=value example"). If you're using the command line tools on a Windows system, you might need to use quotation marks, even when there is no space in the value string (e.g., "name=value").

Type: String

Default: Describes all customer gateways you own, or only those otherwise specified.

Example: --filter "tag-key=Production"

No

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

Output type identifier ("CUSTOMERGATEWAY")
Customer gateway ID
State of the customer gateway (pending, available, deleting, deleted)
Type of VPN connection the customer gateway supports
Internet-routable IP address of the customer gateway's outside interface
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN)
Any tags assigned to the customer gateway

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example gives a description of the customer gateway with ID cgw-b4dc3961.

PROMPT> ec2-describe-customer-gateways cgw-b4dc3961 
					CUSTOMERGATEWAY  cgw-b4dc3961   available   ipsec.1  12.1.2.3  65534

Example Request

This example uses filters to give a description of any customer gateway you own whose IP address is 12.1.2.3, and whose state is either pending or available.

PROMPT> ec2-describe-customer-gateways --filter "ip-address=12.1.2.3"  --filter "state=pending" --filter "state=available" 
CUSTOMERGATEWAY  cgw-b4dc3961   available   ipsec.1  12.1.2.3  65534

Description

Syntax

Options

Common Options

Output

Examples

Example Request

Example Request

Related Operations