Skip to content

Commit

Permalink
fix typo and markdown format
Browse files Browse the repository at this point in the history
  • Loading branch information
chuyich committed Nov 20, 2024
1 parent 4eafb25 commit bf1ddae
Show file tree
Hide file tree
Showing 112 changed files with 1,174 additions and 570 deletions.
22 changes: 16 additions & 6 deletions docs/data-sources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,23 @@ description: |-
Cluster data source
---

# Data Source cluster
# Data Source cluster

Retrieve the details of a cluster data source

### Related ONTAP commands
cluster show
## Related ONTAP commands

```commandline
* cluster show
```

## Supported Platforms
* On-perm ONTAP system 9.6 or higher

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster" "cluster" {
# required to know which system to interface with
Expand Down Expand Up @@ -46,14 +52,15 @@ data "netapp-ontap_cluster" "cluster" {
- `version` (Attributes) ONTAP software version (see [below for nested schema](#nestedatt--version))

<a id="nestedatt--certificate"></a>

### Nested Schema for `certificate`

Read-Only:

- `id` (String)


<a id="nestedatt--management_interfaces"></a>

### Nested Schema for `management_interfaces`

Read-Only:
Expand All @@ -63,6 +70,7 @@ Read-Only:
- `name` (String) Name

<a id="nestedatt--management_interfaces--ip"></a>

### Nested Schema for `management_interfaces.ip`

Read-Only:
Expand All @@ -72,6 +80,7 @@ Read-Only:


<a id="nestedatt--nodes"></a>

### Nested Schema for `nodes`

Read-Only:
Expand All @@ -81,6 +90,7 @@ Read-Only:


<a id="nestedatt--time_zone"></a>

### Nested Schema for `time_zone`

Read-Only:
Expand All @@ -89,9 +99,9 @@ Read-Only:


<a id="nestedatt--version"></a>

### Nested Schema for `version`

Read-Only:

- `full` (String) ONTAP software version

10 changes: 6 additions & 4 deletions docs/data-sources/cluster_licensing_license_data_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ description: |-
---

# Data Source cluster licensing license

Retrieves Cluster Licensing License

## Supported Platforms
* On-perm ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster_licensing_license" "cluster_licensing_license" {
# required to know which system to interface with
Expand All @@ -37,6 +39,7 @@ data "netapp-ontap_cluster_licensing_license" "cluster_licensing_license" {
- `state` (String) State of the license

<a id="nestedatt--licenses"></a>

### Nested Schema for `licenses`

Read-Only:
Expand All @@ -49,10 +52,9 @@ Read-Only:
- `serial_number` (String) Serial Number of the license

<a id="nestedatt--licenses--compliance"></a>

### Nested Schema for `licenses.compliance`

Read-Only:

- `state` (String) state of the license


13 changes: 8 additions & 5 deletions docs/data-sources/cluster_licensing_licenses_data_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ description: |-
---

# Data Source cluster licensing licenses

Retrieves Cluster Licensing Licenses

## Supported Platforms
* On-perm ONTAP system 9.6 or higher

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster_licensing_licenses" "cluster_licensing_licenses" {
# required to know which system to interface with
Expand All @@ -24,7 +27,6 @@ data "netapp-ontap_cluster_licensing_licenses" "cluster_licensing_licenses" {
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required
Expand All @@ -40,14 +42,15 @@ data "netapp-ontap_cluster_licensing_licenses" "cluster_licensing_licenses" {
- `cluster_licensing_licenses` (Attributes List) (see [below for nested schema](#nestedatt--cluster_licensing_licenses))

<a id="nestedatt--filter"></a>

### Nested Schema for `filter`

Optional:

- `name` (String) ClusterLicensingLicense name


<a id="nestedatt--cluster_licensing_licenses"></a>

### Nested Schema for `cluster_licensing_licenses`

Required:
Expand All @@ -62,6 +65,7 @@ Read-Only:
- `state` (String) State of the license

<a id="nestedatt--cluster_licensing_licenses--licenses"></a>

### Nested Schema for `cluster_licensing_licenses.licenses`

Read-Only:
Expand All @@ -74,10 +78,9 @@ Read-Only:
- `serial_number` (String) Serial Number of the license

<a id="nestedatt--cluster_licensing_licenses--licenses--compliance"></a>

### Nested Schema for `cluster_licensing_licenses.licenses.compliance`

Read-Only:

- `state` (String) state of the license


11 changes: 8 additions & 3 deletions docs/data-sources/cluster_peer_data_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ description: |-
---

# Data Source cluster peer

Retrieves an existing cluster_peer

## Supported Platforms
* On-perm ONTAP system 9.6 or higher

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster_peer" "cluster_peer" {
# required to know which system to interface with
Expand Down Expand Up @@ -41,6 +44,7 @@ data "netapp-ontap_cluster_peer" "cluster_peer" {
- `status` (Attributes) Status of cluster peer (see [below for nested schema](#nestedatt--status))

<a id="nestedatt--encryption"></a>

### Nested Schema for `encryption`

Read-Only:
Expand All @@ -50,6 +54,7 @@ Read-Only:


<a id="nestedatt--ipspace"></a>

### Nested Schema for `ipspace`

Read-Only:
Expand All @@ -58,6 +63,7 @@ Read-Only:


<a id="nestedatt--remote"></a>

### Nested Schema for `remote`

Read-Only:
Expand All @@ -67,10 +73,9 @@ Read-Only:


<a id="nestedatt--status"></a>

### Nested Schema for `status`

Read-Only:

- `state` (String) State of cluster peer


14 changes: 10 additions & 4 deletions docs/data-sources/cluster_peers_data_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ description: |-
---

# Data Source cluster peers

Retrieves existing cluster_peers

## Supported Platforms
* On-perm ONTAP system 9.6 or higher

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster_peers" "cluster_peers" {
# required to know which system to interface with
Expand All @@ -24,7 +27,6 @@ data "netapp-ontap_cluster_peers" "cluster_peers" {
}
```


<!-- schema generated by tfplugindocs -->
## Schema

Expand All @@ -41,6 +43,7 @@ data "netapp-ontap_cluster_peers" "cluster_peers" {
- `cluster_peers` (Attributes List) (see [below for nested schema](#nestedatt--cluster_peers))

<a id="nestedatt--filter"></a>

### Nested Schema for `filter`

Optional:
Expand All @@ -49,6 +52,7 @@ Optional:


<a id="nestedatt--cluster_peers"></a>

### Nested Schema for `cluster_peers`

Required:
Expand All @@ -67,6 +71,7 @@ Read-Only:
- `status` (Attributes) Status of cluster peer (see [below for nested schema](#nestedatt--cluster_peers--status))

<a id="nestedatt--cluster_peers--encryption"></a>

### Nested Schema for `cluster_peers.encryption`

Read-Only:
Expand All @@ -76,6 +81,7 @@ Read-Only:


<a id="nestedatt--cluster_peers--ipspace"></a>

### Nested Schema for `cluster_peers.ipspace`

Read-Only:
Expand All @@ -84,6 +90,7 @@ Read-Only:


<a id="nestedatt--cluster_peers--remote"></a>

### Nested Schema for `cluster_peers.remote`

Read-Only:
Expand All @@ -93,10 +100,9 @@ Read-Only:


<a id="nestedatt--cluster_peers--status"></a>

### Nested Schema for `cluster_peers.status`

Read-Only:

- `state` (String) State of cluster peer


9 changes: 5 additions & 4 deletions docs/data-sources/cluster_schedule_data_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ description: |-
---

# Data Source cluster schedule

Retrieves Cluster Schedule configuration of SVMs.

## Supported Platforms
* On-perm ONTAP system 9.6 or higher

* On-prem ONTAP system 9.6 or higher
* Amazon FSx for NetApp ONTAP

## Example Usage

```terraform
data "netapp-ontap_cluster_schedule" "cluster_schedule" {
cx_profile_name = "cluster4"
Expand All @@ -22,7 +25,6 @@ data "netapp-ontap_cluster_schedule" "cluster_schedule" {
}
```


<!-- schema generated by tfplugindocs -->
## Schema

Expand All @@ -40,6 +42,7 @@ data "netapp-ontap_cluster_schedule" "cluster_schedule" {
- `id` (String) Cluster schedule UUID

<a id="nestedatt--cron"></a>

### Nested Schema for `cron`

Read-Only:
Expand All @@ -49,5 +52,3 @@ Read-Only:
- `minutes` (List of Number) List of cluster schedule minutes
- `months` (List of Number) List of cluster schedule months
- `weekdays` (List of Number) List of cluster schedule weekdays


Loading

0 comments on commit bf1ddae

Please sign in to comment.