| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
ec2-describe-dhcp-options
Description
Describes one or more of your sets of DHCP options.
For more information about DHCP options sets, see Using DHCP Options with Your VPC in the Amazon Virtual Private Cloud User Guide.
The short version of this command is ec2ddopt.
Syntax
ec2-describe-dhcp-options [
dhcp_options_id
... ]
[[--filter "name=value"] ...]
Options
| Name | Description |
|---|---|
|
|
The IDs of one or more sets of DHCP options. Type: String Default: Describes all your sets of DHCP options. Required: No Example: dopt-7a8b9c2d |
|
|
A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value"). Type: String Default: Describes all your DHCP options. Required: No Example: --filter "tag-key=Production" |
Supported Filters
You can specify filters so that the response includes information for only certain sets of DHCP options.
For example, you can use a filter to specify that you're interested in sets of DHCP options with a
particular value for the domain-name option. You can specify multiple values for a filter.
The response includes information for a set of DHCP options only if it matches at least one of the filter
values that you specified.
You can specify multiple filters; for example, specify sets of DHCP options that have a
specific value for the domain-name option and a specific tag. The response includes information for
a set of DHCP options only if it matches all the filters that you specified.
If there's no match, no special message is returned, the response is simply empty.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.
dhcp-options-idThe ID of a set of DHCP options.
Type: String
keyThe key for one of the options (for example,
domain-name).Type: String
valueThe value for one of the options.
Type: String
tag-keyThe key of a tag assigned to the resource. This filter is independent of the
tag-valuefilter. 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 keyPurpose(regardless of what the tag's value is), and the tag valueX(regardless of what the tag's key is). If you want to list only resources where Purpose is X, see thetag:filter.keyFor more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
Type: String
tag-valueThe value of a tag assigned to the resource. This filter is independent of the
tag-keyfilter.Type: String
tag:keyFilters the response based on a specific tag/value combination.
Example: To list just the resources that have been assigned tag Purpose=X, specify:
--filter tag:Purpose=XExample: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:
--filter tag:Purpose=X --filter tag:Purpose=Y
Common Options
| Option | Description |
|---|---|
|
|
Overrides the region specified by the Default: The value of the Example: |
|
|
The uniform resource locator (URL) of the Amazon EC2 web service entry point. Default: The value of the Example: |
|
|
The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are. Default: The value of the Example: |
|
|
The X.509 certificate that identifies you to Amazon EC2. Default: The value of the Example: |
|
|
The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The secret access key associated with your AWS account. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The AWS delegation token. Default: The value of the environment variable (if set). |
|
|
The connection timeout, in seconds. Example: |
|
|
The request timeout, in seconds. Example: |
|
|
Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API. |
|
|
Includes column headers in the command output. |
|
|
Shows empty columns as |
|
|
Omits tags for tagged resources. |
|
|
Displays internal debugging information. This can assist us when helping you troubleshooting problems. |
|
|
Displays usage information for the command. |
|
|
Reads arguments from standard input. This is useful when piping the output from one command to the input of another. Example: |
Deprecated Options
For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.
| Option | Description |
|---|---|
|
|
The private key to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the Example: |
Output
This command returns a table that contains the following information:
The DHCPOPTIONS identifier
The ID of the DHCP options set
The name and values for each option in the set
Any tags assigned to the set
Amazon EC2 command line tools display errors on stderr.
Examples
Example Request
This example gives a description of the DHCP options set with ID dopt-7a8b9c2d.
PROMPT>ec2-describe-dhcp-options dopt-7a8b9c2dDHCPOPTIONS dopt-7a8b9c2d OPTION domain-name mydomain.com OPTION domain-name-servers 10.2.5.1,10.2.5.2
Example Request
This example uses filters to give a description of any DHCP options set that
includes a domain-name option whose value includes the string
example.
PROMPT> ec2-describe-dhcp-options --filter "key=domain-name" --filter "value=*example*" 
