-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
broadcast_domain
documentation
Signed-off-by: Achim Christ <[email protected]>
- Loading branch information
Showing
3 changed files
with
214 additions
and
0 deletions.
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
docs/data-sources/networking_broadcast_domain_data_source .md
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,43 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "netapp-ontap_network_broadcast_domain Data Source - terraform-provider-netapp-ontap" | ||
subcategory: "Networking" | ||
description: |- | ||
Retrieves details of a broadcast domain. | ||
--- | ||
|
||
# Data Source network_broadcast_domain | ||
|
||
Retrieves details of a broadcast domain. | ||
|
||
## Supported Platforms | ||
|
||
- On-prem ONTAP system 9.6 or higher | ||
- Amazon FSx for NetApp ONTAP | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "netapp-ontap_network_broadcast_domain" "example" { | ||
# required to know which system to interface with | ||
cx_profile_name = "cluster4" | ||
ipspace = "Default" | ||
name = "Default" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
|
||
## Schema | ||
|
||
### Required | ||
|
||
- `cx_profile_name` (String) Connection profile name | ||
- `ipspace` (String) Name of the IPspace the broadcast domain belongs to | ||
- `name` (String) Name of the broadcast domain, scoped to its IPspace | ||
|
||
### Read-Only | ||
|
||
- `mtu` (Number) Maximum transmission unit, largest packet size on this network | ||
- `ports` (Set of String) Ports that belong to the broadcast domain | ||
- `id` (String) Broadcast domain UUID |
67 changes: 67 additions & 0 deletions
67
docs/data-sources/networking_broadcast_domains_data_source.md
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,67 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "netapp-ontap_network_broadcast_domains Data Source - terraform-provider-netapp-ontap" | ||
subcategory: "Networking" | ||
description: |- | ||
Retrieves a collection of broadcast domains for the entire cluster. | ||
--- | ||
|
||
# Data Source network_broadcast_domains | ||
|
||
Retrieves a collection of broadcast domains for the entire cluster. | ||
|
||
## Supported Platforms | ||
|
||
- On-prem ONTAP system 9.6 or higher | ||
- Amazon FSx for NetApp ONTAP | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "netapp-ontap_network_broadcast_domains" "example" { | ||
# required to know which system to interface with | ||
cx_profile_name = "cluster4" | ||
filter = { | ||
ipspace = "Default" | ||
name = "*" | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
|
||
## Schema | ||
|
||
### Required | ||
|
||
- `cx_profile_name` (String) Connection profile name | ||
|
||
### Optional | ||
|
||
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter)) | ||
|
||
### Read-Only | ||
|
||
- `broadcast_domains` (Attributes List) (see [below for nested schema](#nestedatt--broadcast_domains)) | ||
|
||
<a id="nestedatt--filter"></a> | ||
|
||
### Nested Schema for `filter` | ||
|
||
Optional: | ||
|
||
- `ipspace` (String) Name of the IPspace the broadcast domain belongs to | ||
- `name` (String) Name of the broadcast domain, scoped to its IPspace | ||
|
||
<a id="nestedatt--broadcast_domains"></a> | ||
|
||
### Nested Schema for `broadcast_domains` | ||
|
||
Read-Only: | ||
|
||
- `cx_profile_name` (String) Connection profile name | ||
- `ipspace` (String) Name of the IPspace the broadcast domain belongs to | ||
- `name` (String) Name of the broadcast domain, scoped to its IPspace | ||
- `mtu` (String) Maximum transmission unit, largest packet size on this network | ||
- `ports` (String) Ports that belong to the broadcast domain | ||
- `id` (String) Broadcast domain UUID |
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,104 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ONTAP: Broadcast domain" | ||
subcategory: "Networking" | ||
description: |- | ||
Broadcast Domain resource | ||
--- | ||
|
||
# Resource Broadcast Domain | ||
|
||
Create/Update/Delete a broadcast domain. | ||
|
||
## Related ONTAP commands | ||
|
||
```commandline | ||
* network port broadcast-domain create | ||
* network port broadcast-domain modify | ||
* network port broadcast-domain delete | ||
``` | ||
|
||
## Supported Platforms | ||
|
||
- On-prem ONTAP system 9.6 or higher | ||
- Amazon FSx for NetApp ONTAP | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "netapp-ontap_network_broadcast_domain" "example" { | ||
# required to know which system to interface with | ||
cx_profile_name = "cluster4" | ||
ipspace = "Default" | ||
mtu = 1500 | ||
name = "bd1" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
|
||
## Argument Reference | ||
|
||
### Required | ||
|
||
- `cx_profile_name` (String) Connection profile name | ||
- `name` (String) Name of the broadcast domain, scoped to its IPspace | ||
- `mtu` (Number) Maximum transmission unit, largest packet size on this network | ||
|
||
### Optional | ||
|
||
- `ipspace` (String) Name of the IPspace the broadcast domain belongs to | ||
|
||
### Read-Only | ||
|
||
- `ports` (Set of String) Ports that belong to the broadcast domain | ||
- `id` (String) Broadcast domain UUID | ||
|
||
## Import | ||
|
||
This Resource supports import, which allows you to import existing network broadcast domain into the state of this resource. | ||
Import require a unique ID composed of the connection profile, ipspace name, broadcast domain name, separated by a comma. | ||
id = `cx_profile_name`,`ipspace`,`name` | ||
|
||
### Terraform Import | ||
|
||
For example | ||
|
||
```shell | ||
terraform import netapp-ontap_network_broadcast_domain.example cluster4,Default,bd1 | ||
``` | ||
|
||
!> The terraform import CLI command can only import resources into the state. Importing via the CLI does not generate configuration. If you want to generate the accompanying configuration for imported resources, use the import block instead. | ||
|
||
### Terraform Import Block | ||
|
||
This requires Terraform 1.5 or higher, and will auto create the configuration for you | ||
|
||
First create the block | ||
|
||
```terraform | ||
import { | ||
to = netapp-ontap_network_broadcast_domain.bd_import | ||
id = "cluster4,Default,bd1" | ||
} | ||
``` | ||
|
||
Next run, this will auto create the configuration for you | ||
|
||
```shell | ||
terraform plan -generate-config-out=generated.tf | ||
``` | ||
|
||
This will generate a file called generated.tf, which will contain the configuration for the imported resource | ||
|
||
```terraform | ||
# __generated__ by Terraform | ||
# Please review these resources and move them into your main configuration files. | ||
# __generated__ by Terraform from "cluster4,Default,bd1" | ||
resource "netapp-ontap_network_broadcast_domain" "bd_import" { | ||
cx_profile_name = "cluster4" | ||
ipspace = "Default" | ||
mtu = 1500 | ||
name = "bd1" | ||
} | ||
``` |