Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getSmbShareSettings
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.getSmbShareSettings

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/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.

    Using getSmbShareSettings

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSmbShareSettings(args: GetSmbShareSettingsArgs, opts?: InvokeOptions): Promise<GetSmbShareSettingsResult>
function getSmbShareSettingsOutput(args: GetSmbShareSettingsOutputArgs, opts?: InvokeOptions): Output<GetSmbShareSettingsResult>
    def get_smb_share_settings(filter: Optional[GetSmbShareSettingsFilter] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSmbShareSettingsResult
def get_smb_share_settings_output(filter: Optional[pulumi.Input[GetSmbShareSettingsFilterArgs]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSmbShareSettingsResult]
    func LookupSmbShareSettings(ctx *Context, args *LookupSmbShareSettingsArgs, opts ...InvokeOption) (*LookupSmbShareSettingsResult, error)
func LookupSmbShareSettingsOutput(ctx *Context, args *LookupSmbShareSettingsOutputArgs, opts ...InvokeOption) LookupSmbShareSettingsResultOutput

    > Note: This function is named LookupSmbShareSettings in the Go SDK.

    public static class GetSmbShareSettings 
{
    public static Task<GetSmbShareSettingsResult> InvokeAsync(GetSmbShareSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetSmbShareSettingsResult> Invoke(GetSmbShareSettingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSmbShareSettingsResult> getSmbShareSettings(GetSmbShareSettingsArgs args, InvokeOptions options)
public static Output<GetSmbShareSettingsResult> getSmbShareSettings(GetSmbShareSettingsArgs args, InvokeOptions options)

    fn::invoke:
  function: powerscale:index/getSmbShareSettings:getSmbShareSettings
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getSmbShareSettings Result

    The following output properties are available:

    Supporting Types

    GetSmbShareSettingsFilter

    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.
    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.
    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.
    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.
    scope str
    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 str
    Specifies which access zone to use.
    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.

    GetSmbShareSettingsSmbShareSettings

    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    CaTimeout double
    Persistent open timeout for the share.
    CaWriteIntegrity string
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    ChangeNotify string
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    ContinuouslyAvailable bool
    Specify if persistent opens are allowed on the share.
    CreatePermissions string
    Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
    CscPolicy string
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    DirectoryCreateMask double
    Unix umask or mode bits.
    DirectoryCreateMode double
    Unix umask or mode bits.
    FileCreateMask double
    Unix umask or mode bits.
    FileCreateMode double
    Unix umask or mode bits.
    FileFilterExtensions List<string>
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on the share.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls List<string>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    ImpersonateUser string
    User account to be used as guest account.
    MangleByteStart double
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps List<string>
    Character mangle map.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Allow oplock requests.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zone string
    Name of the access zone in which to update settings
    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    CaTimeout float64
    Persistent open timeout for the share.
    CaWriteIntegrity string
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    ChangeNotify string
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    ContinuouslyAvailable bool
    Specify if persistent opens are allowed on the share.
    CreatePermissions string
    Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
    CscPolicy string
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    DirectoryCreateMask float64
    Unix umask or mode bits.
    DirectoryCreateMode float64
    Unix umask or mode bits.
    FileCreateMask float64
    Unix umask or mode bits.
    FileCreateMode float64
    Unix umask or mode bits.
    FileFilterExtensions []string
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on the share.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls []string
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    ImpersonateUser string
    User account to be used as guest account.
    MangleByteStart float64
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps []string
    Character mangle map.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Allow oplock requests.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zone string
    Name of the access zone in which to update settings
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    caTimeout Double
    Persistent open timeout for the share.
    caWriteIntegrity String
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    changeNotify String
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    continuouslyAvailable Boolean
    Specify if persistent opens are allowed on the share.
    createPermissions String
    Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
    cscPolicy String
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    directoryCreateMask Double
    Unix umask or mode bits.
    directoryCreateMode Double
    Unix umask or mode bits.
    fileCreateMask Double
    Unix umask or mode bits.
    fileCreateMode Double
    Unix umask or mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on the share.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    impersonateUser String
    User account to be used as guest account.
    mangleByteStart Double
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    ntfsAclSupport Boolean
    Support NTFS ACLs on files and directories.
    oplocks Boolean
    Allow oplock requests.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone String
    Name of the access zone in which to update settings
    accessBasedEnumeration boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways boolean
    Allows users to execute files they have read rights for.
    caTimeout number
    Persistent open timeout for the share.
    caWriteIntegrity string
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    changeNotify string
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    continuouslyAvailable boolean
    Specify if persistent opens are allowed on the share.
    createPermissions string
    Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
    cscPolicy string
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    directoryCreateMask number
    Unix umask or mode bits.
    directoryCreateMode number
    Unix umask or mode bits.
    fileCreateMask number
    Unix umask or mode bits.
    fileCreateMode number
    Unix umask or mode bits.
    fileFilterExtensions string[]
    Specifies the list of file extensions.
    fileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled boolean
    Enables file filtering on the share.
    hideDotFiles boolean
    Hide files and directories that begin with a period '.'.
    hostAcls string[]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest string
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    impersonateUser string
    User account to be used as guest account.
    mangleByteStart number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps string[]
    Character mangle map.
    ntfsAclSupport boolean
    Support NTFS ACLs on files and directories.
    oplocks boolean
    Allow oplock requests.
    smb3EncryptionEnabled boolean
    Enables SMB3 encryption for the share.
    sparseFile boolean
    Enables sparse file.
    strictCaLockout boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush boolean
    Handle SMB flush operations.
    strictLocking boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone string
    Name of the access zone in which to update settings
    access_based_enumeration bool
    Only enumerate files and folders the requesting user has access to.
    access_based_enumeration_root_only bool
    Access-based enumeration on only the root directory of the share.
    allow_delete_readonly bool
    Allow deletion of read-only files in the share.
    allow_execute_always bool
    Allows users to execute files they have read rights for.
    ca_timeout float
    Persistent open timeout for the share.
    ca_write_integrity str
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    change_notify str
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    continuously_available bool
    Specify if persistent opens are allowed on the share.
    create_permissions str
    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 str
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    directory_create_mask float
    Unix umask or mode bits.
    directory_create_mode float
    Unix umask or mode bits.
    file_create_mask float
    Unix umask or mode bits.
    file_create_mode float
    Unix umask or mode bits.
    file_filter_extensions Sequence[str]
    Specifies the list of file extensions.
    file_filter_type str
    Specifies if filter list is for deny or allow. Default is deny.
    file_filtering_enabled bool
    Enables file filtering on the share.
    hide_dot_files bool
    Hide files and directories that begin with a period '.'.
    host_acls Sequence[str]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonate_guest str
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    impersonate_user str
    User account to be used as guest account.
    mangle_byte_start float
    Specifies the wchar_t starting point for automatic byte mangling.
    mangle_maps Sequence[str]
    Character mangle map.
    ntfs_acl_support bool
    Support NTFS ACLs on files and directories.
    oplocks bool
    Allow oplock requests.
    smb3_encryption_enabled bool
    Enables SMB3 encryption for the share.
    sparse_file bool
    Enables sparse file.
    strict_ca_lockout bool
    Specifies if persistent opens would do strict lockout on the share.
    strict_flush bool
    Handle SMB flush operations.
    strict_locking bool
    Specifies whether byte range locks contend against SMB I/O.
    zone str
    Name of the access zone in which to update settings
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    caTimeout Number
    Persistent open timeout for the share.
    caWriteIntegrity String
    Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
    changeNotify String
    Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
    continuouslyAvailable Boolean
    Specify if persistent opens are allowed on the share.
    createPermissions String
    Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
    cscPolicy String
    Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
    directoryCreateMask Number
    Unix umask or mode bits.
    directoryCreateMode Number
    Unix umask or mode bits.
    fileCreateMask Number
    Unix umask or mode bits.
    fileCreateMode Number
    Unix umask or mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on the share.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
    impersonateUser String
    User account to be used as guest account.
    mangleByteStart Number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    ntfsAclSupport Boolean
    Support NTFS ACLs on files and directories.
    oplocks Boolean
    Allow oplock requests.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone String
    Name of the access zone in which to update settings

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale