DescribeDhcpOptions

GET /?Action=DescribeDhcpOptions
Description

Retrieves information about the content of one or more DHCP options sets.
You can use the Filter.N parameter to filter the described DHCP options sets on the following properties:

  • dhcp-options-id: The ID of a set of DHCP options.

  • key: The key for one of the options (for example, domain-name).

  • value: The value for one of the options.

  • 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.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeDhcpOptionsRequest

Name Description Required Schema Default Example

DhcpOptionsId.N

One or more IDs of DHCP options sets.
If you do not specify any ID, this action describes all your DHCP options sets.

false

string

Filter.N

One or more filters. Example:
osc-cli fcu DescribeDhcpOptions \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeDhcpOptionsResult

Response 200

Response 200

Name Description Required Schema Default Example

dhcpOptionsSet.N

Information about one or more DHCP options sets.

false

DhcpOptions

requestId

The ID of the request.

false

string