euca-describe-customer-gateways

Syntax

euca-describe-customer-gateways [--show-empty-fields] [-U URL]
	[--region USER@REGION] [-I KEY_ID] [-S KEY]
	[--security-token TOKEN] [--filter NAME=VALUE]
	[--debug] [--debugger] [--version] [-h]
	[VPC [VPC ...]]

Options

Option	Description	Required
`gateway_ID [gateway_ID ...]`	Limit results to one or more supplied customer gateway IDs.	No
`-F, --filter name=value`	Filter for limiting the results. See the table in the Available Filters section for a list of filters. Use quotation marks if the value has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value ("name=value").	No

Available Filters

You can add filters to your request so that the response includes information for only certain customer gateways. For example, you can use a filter to return only the customer gateway that has a specific ID. Some tips for using filters with this command:

You can use multiple values for a filter. Eucalyptus responds with information for a customer gateway only if it matches at least one of the filter values that you specified.
You can use multiple filters. For example, you can specify customer gateways that have a specific tag. Eucalyptus responds with the information for a customer gateway only if it matches all the filters that you specified. If there is no match, Eucalyptus returns an empty response.
You can use wildcards in a filter value. Use an asterisk (*) to match zero or more characters. Use a question mark (?) to match exactly one character. To escape special characters, use a backslash (\) before the character. For example, a value of \*eucalyptus\?\\ searches for the literal string *eucalyptus?\.

The following are the available filters for euca-describe-customer-gateways:

Filter	Description
`bgp-asn`	BGP AS number in use
`customer-gateway-id`	customer gateway-id ID
`ip-address`	ID of the customer gateway's cloud-facing interface
`state`	The state of the customer gateway
`tag-key`	key of a tag assigned to the customer gateway
`tag-value`	value of a tag assigned to the customer gateway
`tag:KEY`	specific tag key/value combination
`type`	type of the customer gateway

Common Options

Option	Description
`--show-empty-fields`	Show empty fields using `(nil)` as a placeholder to indicate that this data was not requested. Empty fields are not shown by default.
`--region value`	Specify region value as the cloud region to use. You can set this by using the environment variable AWS_DEFAULT_REGION.
`-U,--url value`	Overrides the URL for the service call with the value entered. You can set this by using the environment variable `AWS_AUTOSCALING_URL`.
`-I, --access-key-id value`	User's access key ID
`-S, --secret-key value`	User's AWS secret Key to use.
`--debug`	Prints what the command sends to the server and what it receives from the server. Use when you're trying to debug Euca2ools.
`--debugger`	Enable interactive debugger on error.
`--version`	Display the version of this tool.
`-h,--help`	Display the manual page for the command.

Example

The following example describes all customer gateways for an account.

euca-describe-customer-gateways

This command will return output similar to the following:

CUSTOMERGATEWAY	cgw-a16d0fff
ATTACHMENT	vpc-aa87a81b	available
CUSTOMERGATEWAY	cgw-a5f11fff
ATTACHMENT	vpc-72ad7f86	available