Skip to content

Latest commit

 

History

History
133 lines (107 loc) · 6.5 KB

smb_share_settings.md

File metadata and controls

133 lines (107 loc) · 6.5 KB
Raw
title linkTitle page_title subcategory description
powerscale_smb_share_settings data source
powerscale_smb_share_settings
powerscale_smb_share_settings Data Source - terraform-provider-powerscale
This datasource is used to query the existing SMB shares settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale SMB shares settings provide clients network access to file system resources on the cluster.

powerscale_smb_share_settings (Data Source)

This datasource is used to query the existing SMB shares settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale SMB shares settings provide clients network access to file system resources on the cluster.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SMB shares settings provide clients network access to file system resources on the cluster

# Returns PowerScale SMB shares settings based on scope or zone filter
data "powerscale_smb_share_settings" "test" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API
    scope = "effective"
    zone  = "tfaccAccessZone"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share_settings.test
output "powerscale_smb_share_settings" {
  value = data.powerscale_smb_share_settings.test
}

# Returns all of the PowerScale SMB shares settings in default zone
data "powerscale_smb_share_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share_settings.all
output "powerscale_smb_share_settings_data_all" {
  value = data.powerscale_smb_share_settings.all
}

Schema

Optional

Read-Only

Nested Schema for filter

Optional:

  • scope (String) If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
  • zone (String) Specifies which access zone to use.

Nested Schema for smb_share_settings

Read-Only:

  • access_based_enumeration (Boolean) Only enumerate files and folders the requesting user has access to.
  • access_based_enumeration_root_only (Boolean) Access-based enumeration on only the root directory of the share.
  • allow_delete_readonly (Boolean) Allow deletion of read-only files in the share.
  • allow_execute_always (Boolean) Allows users to execute files they have read rights for.
  • ca_timeout (Number) Persistent open timeout for the share.
  • ca_write_integrity (String) Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
  • change_notify (String) Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
  • continuously_available (Boolean) Specify if persistent opens are allowed on the share.
  • create_permissions (String) Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
  • csc_policy (String) Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
  • directory_create_mask (Number) Unix umask or mode bits.
  • directory_create_mode (Number) Unix umask or mode bits.
  • file_create_mask (Number) Unix umask or mode bits.
  • file_create_mode (Number) Unix umask or mode bits.
  • file_filter_extensions (List of String) Specifies the list of file extensions.
  • file_filter_type (String) Specifies if filter list is for deny or allow. Default is deny.
  • file_filtering_enabled (Boolean) Enables file filtering on the share.
  • hide_dot_files (Boolean) Hide files and directories that begin with a period '.'.
  • host_acl (List of String) An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
  • impersonate_guest (String) Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
  • impersonate_user (String) User account to be used as guest account.
  • mangle_byte_start (Number) Specifies the wchar_t starting point for automatic byte mangling.
  • mangle_map (List of String) Character mangle map.
  • ntfs_acl_support (Boolean) Support NTFS ACLs on files and directories.
  • oplocks (Boolean) Allow oplock requests.
  • smb3_encryption_enabled (Boolean) Enables SMB3 encryption for the share.
  • sparse_file (Boolean) Enables sparse file.
  • strict_ca_lockout (Boolean) Specifies if persistent opens would do strict lockout on the share.
  • strict_flush (Boolean) Handle SMB flush operations.
  • strict_locking (Boolean) Specifies whether byte range locks contend against SMB I/O.
  • zone (String) Name of the access zone in which to update settings