-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for dhcp_host and dhcp_fixed_address (#28)
* Support for dhcp_host and dhcp_fixed_address * adding generated files * Addressing review comments. * Addressing review comments. * updated doc file. * updating MatchType and MatchValue UT for Fixed Address Resource. * Merged FA MatchType and MatchValue into single UT. * sorting imports * sorting imports and unit test fixes.
- Loading branch information
Showing
18 changed files
with
2,435 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,195 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "bloxone_dhcp_fixed_addresses Data Source - terraform-provider-bloxone" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# bloxone_dhcp_fixed_addresses (Data Source) | ||
|
||
|
||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Get DHCP fixed address filtered by an attribute | ||
data "bloxone_dhcp_fixed_addresses" "example_by_attribute" { | ||
filters = { | ||
name = "example_fixed_address" | ||
} | ||
} | ||
# Get DHCP fixed address by tag | ||
data "bloxone_dhcp_fixed_addresses" "example_by_tag" { | ||
tag_filters = { | ||
location = "site1" | ||
} | ||
} | ||
# Get all fixed address | ||
data "bloxone_dhcp_fixed_addresses" "example_all" {} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `filters` (Map of String) Filter are used to return a more specific list of results. Filters can be used to match resources by specific attributes, e.g. name. If you specify multiple filters, the results returned will have only resources that match all the specified filters. | ||
- `tag_filters` (Map of String) Tag Filters are used to return a more specific list of results filtered by tags. If you specify multiple filters, the results returned will have only resources that match all the specified filters. | ||
|
||
### Read-Only | ||
|
||
- `results` (Attributes List) (see [below for nested schema](#nestedatt--results)) | ||
|
||
<a id="nestedatt--results"></a> | ||
### Nested Schema for `results` | ||
|
||
Required: | ||
|
||
- `address` (String) The reserved address. | ||
- `match_type` (String) Indicates how to match the client: * _mac_: match the client MAC address for both IPv4 and IPv6, * _client_text_ or _client_hex_: match the client identifier for IPv4 only, * _relay_text_ or _relay_hex_: match the circuit ID or remote ID in the DHCP relay agent option (82) for IPv4 only, * _duid_: match the DHCP unique identifier, currently match only for IPv6 protocol. | ||
- `match_value` (String) The value to match. | ||
|
||
Optional: | ||
|
||
- `comment` (String) The description for the fixed address. May contain 0 to 1024 characters. Can include UTF-8. | ||
- `dhcp_options` (Attributes List) The list of DHCP options. May be either a specific option or a group of options. (see [below for nested schema](#nestedatt--results--dhcp_options)) | ||
- `disable_dhcp` (Boolean) Optional. _true_ to disable object. The fixed address is converted to an exclusion when generating configuration. Defaults to _false_. | ||
- `header_option_filename` (String) The configuration for header option filename field. | ||
- `header_option_server_address` (String) The configuration for header option server address field. | ||
- `header_option_server_name` (String) The configuration for header option server name field. | ||
- `hostname` (String) The DHCP host name associated with this fixed address. It is of FQDN type and it defaults to empty. | ||
- `inheritance_parent` (String) The resource identifier. | ||
- `inheritance_sources` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources)) | ||
- `ip_space` (String) The resource identifier. | ||
- `name` (String) The name of the fixed address. May contain 1 to 256 characters. Can include UTF-8. | ||
- `tags` (Map of String) The tags for the fixed address in JSON format. | ||
|
||
Read-Only: | ||
|
||
- `created_at` (String) Time when the object has been created. | ||
- `id` (String) The resource identifier. | ||
- `inheritance_assigned_hosts` (Attributes List) The list of the inheritance assigned hosts of the object. (see [below for nested schema](#nestedatt--results--inheritance_assigned_hosts)) | ||
- `parent` (String) The resource identifier. | ||
- `updated_at` (String) Time when the object has been updated. Equals to _created_at_ if not updated after creation. | ||
|
||
<a id="nestedatt--results--dhcp_options"></a> | ||
### Nested Schema for `results.dhcp_options` | ||
|
||
Optional: | ||
|
||
- `group` (String) The resource identifier. | ||
- `option_code` (String) The resource identifier. | ||
- `option_value` (String) The option value. | ||
- `type` (String) The type of item. Valid values are: * _group_ * _option_ | ||
|
||
|
||
<a id="nestedatt--results--inheritance_sources"></a> | ||
### Nested Schema for `results.inheritance_sources` | ||
|
||
Optional: | ||
|
||
- `dhcp_options` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--dhcp_options)) | ||
- `header_option_filename` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--header_option_filename)) | ||
- `header_option_server_address` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--header_option_server_address)) | ||
- `header_option_server_name` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--header_option_server_name)) | ||
|
||
<a id="nestedatt--results--inheritance_sources--dhcp_options"></a> | ||
### Nested Schema for `results.inheritance_sources.dhcp_options` | ||
|
||
Optional: | ||
|
||
- `action` (String) The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _block_: Don't use the inherited value. Defaults to _inherit_. | ||
- `value` (Attributes List) The inherited DHCP option values. (see [below for nested schema](#nestedatt--results--inheritance_sources--dhcp_options--value)) | ||
|
||
<a id="nestedatt--results--inheritance_sources--dhcp_options--value"></a> | ||
### Nested Schema for `results.inheritance_sources.dhcp_options.value` | ||
|
||
Optional: | ||
|
||
- `action` (String) The inheritance setting. Valid values are: * _inherit_: Use the inherited value. * _block_: Don't use the inherited value. Defaults to _inherit_. | ||
- `source` (String) The resource identifier. | ||
- `value` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--dhcp_options--value--value)) | ||
|
||
Read-Only: | ||
|
||
- `display_name` (String) The human-readable display name for the object referred to by _source_. | ||
|
||
<a id="nestedatt--results--inheritance_sources--dhcp_options--value--value"></a> | ||
### Nested Schema for `results.inheritance_sources.dhcp_options.value.value` | ||
|
||
Optional: | ||
|
||
- `option` (Attributes) (see [below for nested schema](#nestedatt--results--inheritance_sources--dhcp_options--value--value--option)) | ||
- `overriding_group` (String) The resource identifier. | ||
|
||
<a id="nestedatt--results--inheritance_sources--dhcp_options--value--value--option"></a> | ||
### Nested Schema for `results.inheritance_sources.dhcp_options.value.value.overriding_group` | ||
|
||
Optional: | ||
|
||
- `group` (String) The resource identifier. | ||
- `option_code` (String) The resource identifier. | ||
- `option_value` (String) The option value. | ||
- `type` (String) The type of item. Valid values are: * _group_ * _option_ | ||
|
||
|
||
|
||
|
||
|
||
<a id="nestedatt--results--inheritance_sources--header_option_filename"></a> | ||
### Nested Schema for `results.inheritance_sources.header_option_filename` | ||
|
||
Optional: | ||
|
||
- `action` (String) The inheritance setting for a field. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | ||
- `source` (String) The resource identifier. | ||
|
||
Read-Only: | ||
|
||
- `display_name` (String) The human-readable display name for the object referred to by _source_. | ||
- `value` (String) The inherited value. | ||
|
||
|
||
<a id="nestedatt--results--inheritance_sources--header_option_server_address"></a> | ||
### Nested Schema for `results.inheritance_sources.header_option_server_address` | ||
|
||
Optional: | ||
|
||
- `action` (String) The inheritance setting for a field. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | ||
- `source` (String) The resource identifier. | ||
|
||
Read-Only: | ||
|
||
- `display_name` (String) The human-readable display name for the object referred to by _source_. | ||
- `value` (String) The inherited value. | ||
|
||
|
||
<a id="nestedatt--results--inheritance_sources--header_option_server_name"></a> | ||
### Nested Schema for `results.inheritance_sources.header_option_server_name` | ||
|
||
Optional: | ||
|
||
- `action` (String) The inheritance setting for a field. Valid values are: * _inherit_: Use the inherited value. * _override_: Use the value set in the object. Defaults to _inherit_. | ||
- `source` (String) The resource identifier. | ||
|
||
Read-Only: | ||
|
||
- `display_name` (String) The human-readable display name for the object referred to by _source_. | ||
- `value` (String) The inherited value. | ||
|
||
|
||
|
||
<a id="nestedatt--results--inheritance_assigned_hosts"></a> | ||
### Nested Schema for `results.inheritance_assigned_hosts` | ||
|
||
Optional: | ||
|
||
- `host` (String) The resource identifier. | ||
|
||
Read-Only: | ||
|
||
- `display_name` (String) The human-readable display name for the host referred to by _ophid_. | ||
- `ophid` (String) The on-prem host ID. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "bloxone_dhcp_hosts Data Source - terraform-provider-bloxone" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# bloxone_dhcp_hosts (Data Source) | ||
|
||
|
||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Get DHCP Host filtered by an attribute | ||
data "bloxone_dhcp_hosts" "example_by_name" { | ||
filters = { | ||
name = "example-host" | ||
} | ||
} | ||
# Get DHCP Host by tag | ||
data "bloxone_dhcp_hosts" "example_by_tag" { | ||
tag_filters = { | ||
location = "site1" | ||
} | ||
} | ||
# Get all DHCP hosts | ||
data "bloxone_dhcp_hosts" "example_all" {} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `filters` (Map of String) Filter are used to return a more specific list of results. Filters can be used to match resources by specific attributes, e.g. name. If you specify multiple filters, the results returned will have only resources that match all the specified filters. | ||
- `tag_filters` (Map of String) Tag Filters are used to return a more specific list of results filtered by tags. If you specify multiple filters, the results returned will have only resources that match all the specified filters. | ||
|
||
### Read-Only | ||
|
||
- `results` (Attributes List) (see [below for nested schema](#nestedatt--results)) | ||
|
||
<a id="nestedatt--results"></a> | ||
### Nested Schema for `results` | ||
|
||
Optional: | ||
|
||
- `associated_server` (Attributes) The DHCP Config Profile for the on-prem host. (see [below for nested schema](#nestedatt--results--associated_server)) | ||
- `ip_space` (String) The resource identifier. | ||
- `server` (String) The resource identifier. | ||
- `tags` (Map of String) The tags of the on-prem host in JSON format. | ||
|
||
Read-Only: | ||
|
||
- `address` (String) The primary IP address of the on-prem host. | ||
- `anycast_addresses` (List of String) Anycast address configured to the host. Order is not significant. | ||
- `comment` (String) The description for the on-prem host. | ||
- `current_version` (String) Current dhcp application version of the host. | ||
- `id` (String) The resource identifier. | ||
- `name` (String) The display name of the on-prem host. | ||
- `ophid` (String) The on-prem host ID. | ||
- `provider_id` (String) External provider identifier. | ||
- `type` (String) Defines the type of host. Allowed values: * _bloxone_ddi_: host type is BloxOne DDI, * _microsoft_azure_: host type is Microsoft Azure, * _amazon_web_service_: host type is Amazon Web Services. * _microsoft_active_directory_: host type is Microsoft Active Directory. | ||
|
||
<a id="nestedatt--results--associated_server"></a> | ||
### Nested Schema for `results.associated_server` | ||
|
||
Read-Only: | ||
|
||
- `id` (String) The resource identifier. | ||
- `name` (String) The DHCP Config Profile name. |
Oops, something went wrong.