Skip to content

Commit

Permalink
add document of the data source
Browse files Browse the repository at this point in the history
  • Loading branch information
chuyich committed Dec 6, 2023
1 parent 06ad417 commit f793c58
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "netapp-ontap_protocols_cifs_local_user_data_source Data Source - terraform-provider-netapp-ontap"
subcategory: "nas"
description: |-
Retrieve CifsLocalUser data source
---

# Data Source netapp-ontap_protocols_cifs_local_user

Retreives protocols cifs local user configuration

## Example Usage
```terraform
data "netapp-ontap_protocols_cifs_local_user_data_source" "local_user" {
# required to know which system to interface with
cx_profile_name = "cluster4"
svm_name = "svm3"
name = "test"
}
```

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

### Required

- `cx_profile_name` (String) Connection profile name
- `name` (String) CifsLocalUser name
- `svm_name` (String) IPInterface svm name

### Read-Only

- `account_disabled` (Boolean) CifsLocalUser account disabled
- `description` (String) CifsLocalUser description
- `full_name` (String) CifsLocalUser full name
- `id` (String) CifsLocalUser id
- `membership` (Attributes List) CifsLocalUser membership (see [below for nested schema](#nestedatt--membership))

<a id="nestedatt--membership"></a>
### Nested Schema for `membership`

Read-Only:

- `name` (String) CifsLocalUser membership name


Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "netapp-ontap_protocols_cifs_local_users_data_source Data Source - terraform-provider-netapp-ontap"
subcategory: ""
description: |-
Retrieves list of Cifs Local Users.
---

# Data Source protocols_cifs_local_users

Retrieves a list of Cifs Local Users.

## Example Usage
```terraform
data "netapp-ontap_protocols_cifs_local_users_data_source" "protocols_cifs_local_users" {
# required to know which system to interface with
cx_profile_name = "cluster4"
filter = {
svm_name = "svm*"
}
}
```

<!-- 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

- `protocols_cifs_local_users` (Attributes List) Protocols CIFS local users (see [below for nested schema](#nestedatt--protocols_cifs_local_users))

<a id="nestedatt--filter"></a>
### Nested Schema for `filter`

Optional:

- `name` (String) CifsLocalUser name
- `svm_name` (String) CifsLocalUser svm name


<a id="nestedatt--protocols_cifs_local_users"></a>
### Nested Schema for `protocols_cifs_local_users`

Required:

- `cx_profile_name` (String) Connection profile name
- `name` (String) CifsLocalUser name

Read-Only:

- `account_disabled` (Boolean) CifsLocalUser account disabled
- `description` (String) CifsLocalUser description
- `full_name` (String) CifsLocalUser full name
- `id` (String) CifsLocalUser id
- `membership` (Attributes List) CifsLocalUser membership (see [below for nested schema](#nestedatt--protocols_cifs_local_users--membership))
- `svm_name` (String) CifsLocalUser svm name

<a id="nestedatt--protocols_cifs_local_users--membership"></a>
### Nested Schema for `protocols_cifs_local_users.membership`

Read-Only:

- `name` (String) CifsLocalUser membership name


1 change: 1 addition & 0 deletions scripts/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"cluster_schedule_resource.md",
"cluster_licensing_license_resource.md"],
'nas': [
"protocols_cifs_local_user_data_source.md",
"protocols_nfs_service_data_source.md",
"protocols_nfs_service_resource.md",
"protocols_nfs_export_policy_resource.md",
Expand Down

0 comments on commit f793c58

Please sign in to comment.