Gives you information about one or more sets of DHCP options. You can specify one or more DHCP
options set IDs, or no IDs (to describe all your sets of DHCP options). The returned
information consists of:
- The DHCP options set ID
- The options
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
DhcpOptionsId - string|array - Optional - Pass a string for a single value, or an indexed array for multiple values.Filter - array - Optional - A list of filters used to match properties for DhcpOptions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. x - array - Optional - This represents a simple array index. Name - string - Optional - Specifies the name of the filter.Value - string|array - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values.
curlopts - array - Optional - A set of values to pass directly into curl_setopt() , where the key is a pre-defined CURLOPT_* constant.returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests. |
Returns
Examples
Describe all VPC DHCP options.
$ec2 = new AmazonEC2();
$response = $ec2->describe_dhcp_options();
var_dump($response->isOK());
Result:
bool(true)
Filter VPC DHCP options by tags matching multiple values.
$ec2 = new AmazonEC2();
$response = $ec2->describe_dhcp_options(array(
'Filter' => array(
array('Name' => 'tag:Purpose', 'Value' => array('X', 'Y')),
),
));
var_dump($response->isOK());
Result:
bool(true)
Related Methods
Source
Method defined in services/ec2.class.php | Toggle source view (24 lines) | View on GitHub
public function describe_dhcp_options($opt = null)
{
if (!$opt) $opt = array();
// Optional list (non-map)
if (isset($opt['DhcpOptionsId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'DhcpOptionsId' => (is_array($opt['DhcpOptionsId']) ? $opt['DhcpOptionsId'] : array($opt['DhcpOptionsId']))
)));
unset($opt['DhcpOptionsId']);
}
// Optional list + map
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeDhcpOptions', $opt);
}