From f793c58faf8349101fbf644da93dfd03e82df069 Mon Sep 17 00:00:00 2001 From: Chuyi Ching Date: Wed, 6 Dec 2023 15:21:47 -0800 Subject: [PATCH] add document of the data source --- ...p_protocols_cifs_local_user_data_source.md | 47 ++++++++++++ ..._protocols_cifs_local_users_data_source.md | 72 +++++++++++++++++++ scripts/generate_docs.py | 1 + 3 files changed, 120 insertions(+) create mode 100644 docs/data-sources/netapp-ontap_protocols_cifs_local_user_data_source.md create mode 100644 docs/data-sources/netapp-ontap_protocols_cifs_local_users_data_source.md diff --git a/docs/data-sources/netapp-ontap_protocols_cifs_local_user_data_source.md b/docs/data-sources/netapp-ontap_protocols_cifs_local_user_data_source.md new file mode 100644 index 00000000..2d33649b --- /dev/null +++ b/docs/data-sources/netapp-ontap_protocols_cifs_local_user_data_source.md @@ -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 + +### 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)) + + +### Nested Schema for `membership` + +Read-Only: + +- `name` (String) CifsLocalUser membership name + + diff --git a/docs/data-sources/netapp-ontap_protocols_cifs_local_users_data_source.md b/docs/data-sources/netapp-ontap_protocols_cifs_local_users_data_source.md new file mode 100644 index 00000000..50641eff --- /dev/null +++ b/docs/data-sources/netapp-ontap_protocols_cifs_local_users_data_source.md @@ -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 + +### 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)) + + +### Nested Schema for `filter` + +Optional: + +- `name` (String) CifsLocalUser name +- `svm_name` (String) CifsLocalUser svm name + + + +### 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 + + +### Nested Schema for `protocols_cifs_local_users.membership` + +Read-Only: + +- `name` (String) CifsLocalUser membership name + + diff --git a/scripts/generate_docs.py b/scripts/generate_docs.py index b88020d4..2e597f54 100755 --- a/scripts/generate_docs.py +++ b/scripts/generate_docs.py @@ -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",