-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #154 from NetApp/28-new-data-source-protocolscifss…
…hares Add new data source for cifs share and shares
- Loading branch information
Showing
16 changed files
with
1,081 additions
and
4 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
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,101 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "netapp-ontap_protocols_cifs_share_data_source Data Source - terraform-provider-netapp-ontap" | ||
| subcategory: "nas" | ||
| description: |- | ||
| ProtocolsCIFSShare data source | ||
| --- | ||
|
|
||
| # netapp-ontap_protocols_cifs_share_data_source (Data Source) | ||
|
|
||
| Retrieves the details of a cifs share | ||
|
|
||
| ### Related ONTAP commands | ||
| * vserver cifs share show | ||
| * vserver cifs share properties show | ||
|
|
||
| ## Example Usage | ||
| ```terraform | ||
| data "netapp-ontap_protocols_cifs_share_data_source" "protocols_cifs_share" { | ||
| # required to know which system to interface with | ||
| cx_profile_name = "cluster5" | ||
| name = "cifs_share" | ||
| svm_name = "testSVM" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `cx_profile_name` (String) Connection profile name | ||
| - `name` (String) Specifies the name of the CIFS share that you want to create. If this | ||
| is a home directory share then the share name includes the pattern as | ||
| %w (Windows user name), %u (UNIX user name) and %d (Windows domain name) | ||
| variables in any combination with this parameter to generate shares dynamically. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `svm_name` (String) IPInterface svm name | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `acls` (Attributes Set) The permissions that users and groups have on a CIFS share. (see [below for nested schema](#nestedatt--acls)) | ||
| - `change_notify` (Boolean) Specifies whether CIFS clients can request for change notifications for directories on this share. | ||
| - `comment` (String) Specify the CIFS share descriptions. | ||
| - `continuously_available` (Boolean) Specifies whether or not the clients connecting to this share can open files in a persistent manner.Files opened in this way are protected from disruptive events, such as, failover and giveback. | ||
| - `dir_umask` (Number) Directory Mode Creation Mask to be viewed as an octal number. | ||
| - `encryption` (Boolean) Specifies that SMB encryption must be used when accessing this share. Clients that do not support encryption are not able to access this share. | ||
| - `file_umask` (Number) File Mode Creation Mask to be viewed as an octal number. | ||
| - `force_group_for_create` (String) Specifies that all files that CIFS users create in a specific share belong to the same group | ||
| (also called the force-group). The force-group must be a predefined group in the UNIX group | ||
| database. This setting has no effect unless the security style of the volume is UNIX or mixed | ||
| security style. | ||
| - `home_directory` (Boolean) Specifies whether or not the share is a home directory share, where the share and path names are dynamic. | ||
| ONTAP home directory functionality automatically offer each user a dynamic share to their home directory without creating an | ||
| individual SMB share for each user. | ||
| The ONTAP CIFS home directory feature enable us to configure a share that maps to | ||
| different directories based on the user that connects to it. Instead of creating a separate shares for each user, | ||
| a single share with a home directory parameters can be created. | ||
| In a home directory share, ONTAP dynamically generates the share-name and share-path by substituting | ||
| %w, %u, and %d variables with the corresponding Windows user name, UNIX user name, and domain name, respectively. | ||
| - `namespace_caching` (Boolean) Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration | ||
| results returned by the CIFS servers. | ||
| - `no_strict_security` (Boolean) Specifies whether or not CIFS clients can follow a unix symlinks outside the share boundaries. | ||
| - `offline_files` (String) Offline Files. The supported values are: | ||
| none - Clients are not permitted to cache files for offline access. | ||
| manual - Clients may cache files that are explicitly selected by the user for offline access. | ||
| documents - Clients may automatically cache files that are used by the user for offline access. | ||
| programs - Clients may automatically cache files that are used by the user for offline access | ||
| and may use those files in an offline mode even if the share is available. | ||
| - `oplocks` (Boolean) Specify whether opportunistic locks are enabled on this share. "Oplocks" allow clients to lock files and cache content locally, | ||
| which can increase performance for file operations. | ||
| - `path` (String) The fully-qualified pathname in the owning SVM namespace that is shared through this share. | ||
| If this is a home directory share then the path should be dynamic by specifying the pattern | ||
| %w (Windows user name), %u (UNIX user name), or %d (domain name) variables in any combination. | ||
| ONTAP generates the path dynamically for the connected user and this path is appended to each | ||
| search path to find the full Home Directory path. | ||
| - `show_snapshot` (Boolean) Specifies whether or not the Snapshot copies can be viewed and traversed by clients. | ||
| - `unix_symlink` (String) Controls the access of UNIX symbolic links to CIFS clients. | ||
| The supported values are: | ||
| * local - Enables only local symbolic links which is within the same CIFS share. | ||
| * widelink - Enables both local symlinks and widelinks. | ||
| * disable - Disables local symlinks and widelinks. | ||
| - `vscan_profile` (String) Vscan File-Operations Profile | ||
| The supported values are: | ||
| no_scan - Virus scans are never triggered for accesses to this share. | ||
| standard - Virus scans can be triggered by open, close, and rename operations. | ||
| strict - Virus scans can be triggered by open, read, close, and rename operations. | ||
| writes_only - Virus scans can be triggered only when a file that has been modified is closed. | ||
|
|
||
| <a id="nestedatt--acls"></a> | ||
| ### Nested Schema for `acls` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `permission` (String) Specifies the access rights that a user or group has on the defined CIFS Share. | ||
| - `type` (String) string Specifies the type of the user or group to add to the access control list of a CIFS share. | ||
| - `user_or_group` (String) Specifies the user or group name to add to the access control list of a CIFS share. | ||
|
|
||
|
|
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,127 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "netapp-ontap_protocols_cifs_shares_data_source Data Source - terraform-provider-netapp-ontap" | ||
| subcategory: "nas" | ||
| description: |- | ||
| ProtocolsCIFSShares data source | ||
| --- | ||
|
|
||
| # netapp-ontap_protocols_cifs_shares_data_source (Data Source) | ||
|
|
||
| Retrieves the details of one or more cifs shares by filter | ||
|
|
||
| ### Related ONTAP commands | ||
| * vserver cifs share show | ||
| * vserver cifs share properties show | ||
|
|
||
| ## Example Usage | ||
| ```terraform | ||
| data "netapp-ontap_protocols_cifs_shares_data_source" "protocols_cifs_shares" { | ||
| # required to know which system to interface with | ||
| cx_profile_name = "cluster5" | ||
| filter = { | ||
| svm_name = "testSVM" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| <!-- 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_shares` (Attributes List) (see [below for nested schema](#nestedatt--protocols_cifs_shares)) | ||
|
|
||
| <a id="nestedatt--filter"></a> | ||
| ### Nested Schema for `filter` | ||
|
|
||
| Optional: | ||
|
|
||
| - `name` (String) ProtocolsCIFSShare name | ||
| - `svm_name` (String) ProtocolsCIFSShare svm name | ||
|
|
||
|
|
||
| <a id="nestedatt--protocols_cifs_shares"></a> | ||
| ### Nested Schema for `protocols_cifs_shares` | ||
|
|
||
| Required: | ||
|
|
||
| - `cx_profile_name` (String) Connection profile name | ||
| - `name` (String) Specifies the name of the CIFS share that you want to create. If this | ||
| is a home directory share then the share name includes the pattern as | ||
| %w (Windows user name), %u (UNIX user name) and %d (Windows domain name) | ||
| variables in any combination with this parameter to generate shares dynamically. | ||
|
|
||
| Optional: | ||
|
|
||
| - `svm_name` (String) IPInterface svm name | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `acls` (Attributes Set) The permissions that users and groups have on a CIFS share. (see [below for nested schema](#nestedatt--protocols_cifs_shares--acls)) | ||
| - `change_notify` (Boolean) Specifies whether CIFS clients can request for change notifications for directories on this share. | ||
| - `comment` (String) Specify the CIFS share descriptions. | ||
| - `continuously_available` (Boolean) Specifies whether or not the clients connecting to this share can open files in a persistent manner.Files opened in this way are protected from disruptive events, such as, failover and giveback. | ||
| - `dir_umask` (Number) Directory Mode Creation Mask to be viewed as an octal number. | ||
| - `encryption` (Boolean) Specifies that SMB encryption must be used when accessing this share. Clients that do not support encryption are not able to access this share. | ||
| - `file_umask` (Number) File Mode Creation Mask to be viewed as an octal number. | ||
| - `force_group_for_create` (String) Specifies that all files that CIFS users create in a specific share belong to the same group | ||
| (also called the force-group). The force-group must be a predefined group in the UNIX group | ||
| database. This setting has no effect unless the security style of the volume is UNIX or mixed | ||
| security style. | ||
| - `home_directory` (Boolean) Specifies whether or not the share is a home directory share, where the share and path names are dynamic. | ||
| ONTAP home directory functionality automatically offer each user a dynamic share to their home directory without creating an | ||
| individual SMB share for each user. | ||
| The ONTAP CIFS home directory feature enable us to configure a share that maps to | ||
| different directories based on the user that connects to it. Instead of creating a separate shares for each user, | ||
| a single share with a home directory parameters can be created. | ||
| In a home directory share, ONTAP dynamically generates the share-name and share-path by substituting | ||
| %w, %u, and %d variables with the corresponding Windows user name, UNIX user name, and domain name, respectively. | ||
| - `namespace_caching` (Boolean) Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration | ||
| results returned by the CIFS servers. | ||
| - `no_strict_security` (Boolean) Specifies whether or not CIFS clients can follow a unix symlinks outside the share boundaries. | ||
| - `offline_files` (String) Offline Files. The supported values are: | ||
| none - Clients are not permitted to cache files for offline access. | ||
| manual - Clients may cache files that are explicitly selected by the user for offline access. | ||
| documents - Clients may automatically cache files that are used by the user for offline access. | ||
| programs - Clients may automatically cache files that are used by the user for offline access | ||
| and may use those files in an offline mode even if the share is available. | ||
| - `oplocks` (Boolean) Specify whether opportunistic locks are enabled on this share. "Oplocks" allow clients to lock files and cache content locally, | ||
| which can increase performance for file operations. | ||
| - `path` (String) The fully-qualified pathname in the owning SVM namespace that is shared through this share. | ||
| If this is a home directory share then the path should be dynamic by specifying the pattern | ||
| %w (Windows user name), %u (UNIX user name), or %d (domain name) variables in any combination. | ||
| ONTAP generates the path dynamically for the connected user and this path is appended to each | ||
| search path to find the full Home Directory path. | ||
| - `show_snapshot` (Boolean) Specifies whether or not the Snapshot copies can be viewed and traversed by clients. | ||
| - `unix_symlink` (String) Controls the access of UNIX symbolic links to CIFS clients. | ||
| The supported values are: | ||
| * local - Enables only local symbolic links which is within the same CIFS share. | ||
| * widelink - Enables both local symlinks and widelinks. | ||
| * disable - Disables local symlinks and widelinks. | ||
| - `vscan_profile` (String) Vscan File-Operations Profile | ||
| The supported values are: | ||
| no_scan - Virus scans are never triggered for accesses to this share. | ||
| standard - Virus scans can be triggered by open, close, and rename operations. | ||
| strict - Virus scans can be triggered by open, read, close, and rename operations. | ||
| writes_only - Virus scans can be triggered only when a file that has been modified is closed. | ||
|
|
||
| <a id="nestedatt--protocols_cifs_shares--acls"></a> | ||
| ### Nested Schema for `protocols_cifs_shares.acls` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `permission` (String) Specifies the access rights that a user or group has on the defined CIFS Share. | ||
| - `type` (String) string Specifies the type of the user or group to add to the access control list of a CIFS share. | ||
| - `user_or_group` (String) Specifies the user or group name to add to the access control list of a CIFS share. | ||
|
|
||
|
|
6 changes: 6 additions & 0 deletions
6
examples/data-sources/netapp-ontap_protocols_cifs_share/data-source.tf
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,6 @@ | ||
| data "netapp-ontap_protocols_cifs_share_data_source" "protocols_cifs_share" { | ||
| # required to know which system to interface with | ||
| cx_profile_name = "cluster5" | ||
| name = "share1" | ||
| svm_name = "testSVM" | ||
| } |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_share/provider.tf
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 @@ | ||
| ../../provider/provider.tf |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_share/terraform.tfvars
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 @@ | ||
| ../../provider/terraform.tfvars |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_share/variables.tf
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 @@ | ||
| ../../provider/variables.tf |
7 changes: 7 additions & 0 deletions
7
examples/data-sources/netapp-ontap_protocols_cifs_shares/data-source.tf
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,7 @@ | ||
| data "netapp-ontap_protocols_cifs_shares_data_source" "protocols_cifs_shares" { | ||
| # required to know which system to interface with | ||
| cx_profile_name = "cluster5" | ||
| filter = { | ||
| svm_name = "testSVM" | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_shares/provider.tf
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 @@ | ||
| ../../provider/provider.tf |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_shares/terraform.tfvars
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 @@ | ||
| ../../provider/terraform.tfvars |
1 change: 1 addition & 0 deletions
1
examples/data-sources/netapp-ontap_protocols_cifs_shares/variables.tf
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 @@ | ||
| ../../provider/variables.tf |
Oops, something went wrong.