powerscale 1.8.0 published on Friday, Aug 29, 2025 by dell
powerscale.getSmbShare
This datasource is used to query the existing SMB shares 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 provide clients network access to file system resources on the cluster.
Using getSmbShare
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 getSmbShare(args: GetSmbShareArgs, opts?: InvokeOptions): Promise<GetSmbShareResult>
function getSmbShareOutput(args: GetSmbShareOutputArgs, opts?: InvokeOptions): Output<GetSmbShareResult>def get_smb_share(filter: Optional[GetSmbShareFilter] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSmbShareResult
def get_smb_share_output(filter: Optional[pulumi.Input[GetSmbShareFilterArgs]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSmbShareResult]func LookupSmbShare(ctx *Context, args *LookupSmbShareArgs, opts ...InvokeOption) (*LookupSmbShareResult, error)
func LookupSmbShareOutput(ctx *Context, args *LookupSmbShareOutputArgs, opts ...InvokeOption) LookupSmbShareResultOutput> Note: This function is named LookupSmbShare in the Go SDK.
public static class GetSmbShare 
{
    public static Task<GetSmbShareResult> InvokeAsync(GetSmbShareArgs args, InvokeOptions? opts = null)
    public static Output<GetSmbShareResult> Invoke(GetSmbShareInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSmbShareResult> getSmbShare(GetSmbShareArgs args, InvokeOptions options)
public static Output<GetSmbShareResult> getSmbShare(GetSmbShareArgs args, InvokeOptions options)
fn::invoke:
  function: powerscale:index/getSmbShare:getSmbShare
  arguments:
    # arguments dictionaryThe following arguments are supported:
getSmbShare Result
The following output properties are available:
- Id string
- Identifier
- 
List<GetSmb Share Smb Share> 
- List of smb shares
- Filter
GetSmb Share Filter 
- Id string
- Identifier
- 
[]GetSmb Share Smb Share 
- List of smb shares
- Filter
GetSmb Share Filter 
- id String
- Identifier
- 
List<GetSmb Share Smb Share> 
- List of smb shares
- filter
GetSmb Share Filter 
- id string
- Identifier
- 
GetSmb Share Smb Share[] 
- List of smb shares
- filter
GetSmb Share Filter 
- id str
- Identifier
- 
Sequence[GetSmb Share Smb Share] 
- List of smb shares
- filter
GetSmb Share Filter 
- id String
- Identifier
- List<Property Map>
- List of smb shares
- filter Property Map
Supporting Types
GetSmbShareFilter   
- Dir string
- The direction of the sort.
- Limit double
- Return no more than this many results at once (see resume).
- Names List<string>
- Names to filter smb shares.
- Offset double
- The position of the first item returned for a paginated query within the full result set.
- Resume string
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- Sort string
- The field that will be used for sorting.
- Zone string
- Specifies which access zone to use.
- Dir string
- The direction of the sort.
- Limit float64
- Return no more than this many results at once (see resume).
- Names []string
- Names to filter smb shares.
- Offset float64
- The position of the first item returned for a paginated query within the full result set.
- Resume string
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- Sort string
- The field that will be used for sorting.
- Zone string
- Specifies which access zone to use.
- dir String
- The direction of the sort.
- limit Double
- Return no more than this many results at once (see resume).
- names List<String>
- Names to filter smb shares.
- offset Double
- The position of the first item returned for a paginated query within the full result set.
- resume String
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- sort String
- The field that will be used for sorting.
- zone String
- Specifies which access zone to use.
- dir string
- The direction of the sort.
- limit number
- Return no more than this many results at once (see resume).
- names string[]
- Names to filter smb shares.
- offset number
- The position of the first item returned for a paginated query within the full result set.
- resume string
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- sort string
- The field that will be used for sorting.
- zone string
- Specifies which access zone to use.
- dir str
- The direction of the sort.
- limit float
- Return no more than this many results at once (see resume).
- names Sequence[str]
- Names to filter smb shares.
- offset float
- The position of the first item returned for a paginated query within the full result set.
- resume str
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- sort str
- The field that will be used for sorting.
- zone str
- Specifies which access zone to use.
- dir String
- The direction of the sort.
- limit Number
- Return no more than this many results at once (see resume).
- names List<String>
- Names to filter smb shares.
- offset Number
- The position of the first item returned for a paginated query within the full result set.
- resume String
- Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
- 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.
- sort String
- The field that will be used for sorting.
- zone String
- Specifies which access zone to use.
GetSmbShareSmbShare    
- AccessBased boolEnumeration 
- Only enumerate files and folders the requesting user has access to.
- AccessBased boolEnumeration Root Only 
- Access-based enumeration on only the root directory of the share.
- AllowDelete boolReadonly 
- Allow deletion of read-only files in the share.
- AllowExecute boolAlways 
- Allows users to execute files they have read rights for.
- AllowVariable boolExpansion 
- Allow automatic expansion of variables for home directories.
- AutoCreate boolDirectory 
- Automatically create home directories.
- Browsable bool
- Share is visible in net view and the browse list.
- CaTimeout double
- Persistent open timeout for the share.
- CaWrite stringIntegrity 
- Specify the level of write-integrity on continuously available shares.
- ChangeNotify string
- Level of change notification alerts on the share.
- ContinuouslyAvailable bool
- Specify if persistent opens are allowed on the share.
- CreatePermissions string
- Create permissions for new files and directories in share.
- CscPolicy string
- Client-side caching policy for the shares.
- Description string
- Description for this SMB share.
- DirectoryCreate doubleMask 
- Directory create mask bits.
- DirectoryCreate doubleMode 
- Directory create mode bits.
- FileCreate doubleMask 
- File create mask bits.
- FileCreate doubleMode 
- File create mode bits.
- FileFilter List<string>Extensions 
- Specifies the list of file extensions.
- FileFilter stringType 
- Specifies if filter list is for deny or allow. Default is deny.
- FileFiltering boolEnabled 
- Enables file filtering on this zone.
- HideDot boolFiles 
- 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.
- Id string
- Share ID.
- ImpersonateGuest string
- Specify the condition in which user access is done as the guest account.
- ImpersonateUser string
- User account to be used as guest account.
- InheritablePath boolAcl 
- Set the inheritable ACL on the share path.
- MangleByte doubleStart 
- Specifies the wchar_t starting point for automatic byte mangling.
- MangleMaps List<string>
- Character mangle map.
- Name string
- Share name.
- NtfsAcl boolSupport 
- Support NTFS ACLs on files and directories.
- Oplocks bool
- Support oplocks.
- Path string
- Path of share within /ifs.
- Permissions
List<GetSmb Share Smb Share Permission> 
- Specifies an ordered list of permission modifications.
- RunAs List<GetRoots Smb Share Smb Share Run As Root> 
- Allow account to run as root.
- Smb3EncryptionEnabled bool
- Enables SMB3 encryption for the share.
- SparseFile bool
- Enables sparse file.
- StrictCa boolLockout 
- 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.
- Zid double
- Numeric ID of the access zone which contains this SMB share
- AccessBased boolEnumeration 
- Only enumerate files and folders the requesting user has access to.
- AccessBased boolEnumeration Root Only 
- Access-based enumeration on only the root directory of the share.
- AllowDelete boolReadonly 
- Allow deletion of read-only files in the share.
- AllowExecute boolAlways 
- Allows users to execute files they have read rights for.
- AllowVariable boolExpansion 
- Allow automatic expansion of variables for home directories.
- AutoCreate boolDirectory 
- Automatically create home directories.
- Browsable bool
- Share is visible in net view and the browse list.
- CaTimeout float64
- Persistent open timeout for the share.
- CaWrite stringIntegrity 
- Specify the level of write-integrity on continuously available shares.
- ChangeNotify string
- Level of change notification alerts on the share.
- ContinuouslyAvailable bool
- Specify if persistent opens are allowed on the share.
- CreatePermissions string
- Create permissions for new files and directories in share.
- CscPolicy string
- Client-side caching policy for the shares.
- Description string
- Description for this SMB share.
- DirectoryCreate float64Mask 
- Directory create mask bits.
- DirectoryCreate float64Mode 
- Directory create mode bits.
- FileCreate float64Mask 
- File create mask bits.
- FileCreate float64Mode 
- File create mode bits.
- FileFilter []stringExtensions 
- Specifies the list of file extensions.
- FileFilter stringType 
- Specifies if filter list is for deny or allow. Default is deny.
- FileFiltering boolEnabled 
- Enables file filtering on this zone.
- HideDot boolFiles 
- 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.
- Id string
- Share ID.
- ImpersonateGuest string
- Specify the condition in which user access is done as the guest account.
- ImpersonateUser string
- User account to be used as guest account.
- InheritablePath boolAcl 
- Set the inheritable ACL on the share path.
- MangleByte float64Start 
- Specifies the wchar_t starting point for automatic byte mangling.
- MangleMaps []string
- Character mangle map.
- Name string
- Share name.
- NtfsAcl boolSupport 
- Support NTFS ACLs on files and directories.
- Oplocks bool
- Support oplocks.
- Path string
- Path of share within /ifs.
- Permissions
[]GetSmb Share Smb Share Permission 
- Specifies an ordered list of permission modifications.
- RunAs []GetRoots Smb Share Smb Share Run As Root 
- Allow account to run as root.
- Smb3EncryptionEnabled bool
- Enables SMB3 encryption for the share.
- SparseFile bool
- Enables sparse file.
- StrictCa boolLockout 
- 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.
- Zid float64
- Numeric ID of the access zone which contains this SMB share
- accessBased BooleanEnumeration 
- Only enumerate files and folders the requesting user has access to.
- accessBased BooleanEnumeration Root Only 
- Access-based enumeration on only the root directory of the share.
- allowDelete BooleanReadonly 
- Allow deletion of read-only files in the share.
- allowExecute BooleanAlways 
- Allows users to execute files they have read rights for.
- allowVariable BooleanExpansion 
- Allow automatic expansion of variables for home directories.
- autoCreate BooleanDirectory 
- Automatically create home directories.
- browsable Boolean
- Share is visible in net view and the browse list.
- caTimeout Double
- Persistent open timeout for the share.
- caWrite StringIntegrity 
- Specify the level of write-integrity on continuously available shares.
- changeNotify String
- Level of change notification alerts on the share.
- continuouslyAvailable Boolean
- Specify if persistent opens are allowed on the share.
- createPermissions String
- Create permissions for new files and directories in share.
- cscPolicy String
- Client-side caching policy for the shares.
- description String
- Description for this SMB share.
- directoryCreate DoubleMask 
- Directory create mask bits.
- directoryCreate DoubleMode 
- Directory create mode bits.
- fileCreate DoubleMask 
- File create mask bits.
- fileCreate DoubleMode 
- File create mode bits.
- fileFilter List<String>Extensions 
- Specifies the list of file extensions.
- fileFilter StringType 
- Specifies if filter list is for deny or allow. Default is deny.
- fileFiltering BooleanEnabled 
- Enables file filtering on this zone.
- hideDot BooleanFiles 
- 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.
- id String
- Share ID.
- impersonateGuest String
- Specify the condition in which user access is done as the guest account.
- impersonateUser String
- User account to be used as guest account.
- inheritablePath BooleanAcl 
- Set the inheritable ACL on the share path.
- mangleByte DoubleStart 
- Specifies the wchar_t starting point for automatic byte mangling.
- mangleMaps List<String>
- Character mangle map.
- name String
- Share name.
- ntfsAcl BooleanSupport 
- Support NTFS ACLs on files and directories.
- oplocks Boolean
- Support oplocks.
- path String
- Path of share within /ifs.
- permissions
List<GetSmb Share Smb Share Permission> 
- Specifies an ordered list of permission modifications.
- runAs List<GetRoots Smb Share Smb Share Run As Root> 
- Allow account to run as root.
- smb3EncryptionEnabled Boolean
- Enables SMB3 encryption for the share.
- sparseFile Boolean
- Enables sparse file.
- strictCa BooleanLockout 
- 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.
- zid Double
- Numeric ID of the access zone which contains this SMB share
- accessBased booleanEnumeration 
- Only enumerate files and folders the requesting user has access to.
- accessBased booleanEnumeration Root Only 
- Access-based enumeration on only the root directory of the share.
- allowDelete booleanReadonly 
- Allow deletion of read-only files in the share.
- allowExecute booleanAlways 
- Allows users to execute files they have read rights for.
- allowVariable booleanExpansion 
- Allow automatic expansion of variables for home directories.
- autoCreate booleanDirectory 
- Automatically create home directories.
- browsable boolean
- Share is visible in net view and the browse list.
- caTimeout number
- Persistent open timeout for the share.
- caWrite stringIntegrity 
- Specify the level of write-integrity on continuously available shares.
- changeNotify string
- Level of change notification alerts on the share.
- continuouslyAvailable boolean
- Specify if persistent opens are allowed on the share.
- createPermissions string
- Create permissions for new files and directories in share.
- cscPolicy string
- Client-side caching policy for the shares.
- description string
- Description for this SMB share.
- directoryCreate numberMask 
- Directory create mask bits.
- directoryCreate numberMode 
- Directory create mode bits.
- fileCreate numberMask 
- File create mask bits.
- fileCreate numberMode 
- File create mode bits.
- fileFilter string[]Extensions 
- Specifies the list of file extensions.
- fileFilter stringType 
- Specifies if filter list is for deny or allow. Default is deny.
- fileFiltering booleanEnabled 
- Enables file filtering on this zone.
- hideDot booleanFiles 
- 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.
- id string
- Share ID.
- impersonateGuest string
- Specify the condition in which user access is done as the guest account.
- impersonateUser string
- User account to be used as guest account.
- inheritablePath booleanAcl 
- Set the inheritable ACL on the share path.
- mangleByte numberStart 
- Specifies the wchar_t starting point for automatic byte mangling.
- mangleMaps string[]
- Character mangle map.
- name string
- Share name.
- ntfsAcl booleanSupport 
- Support NTFS ACLs on files and directories.
- oplocks boolean
- Support oplocks.
- path string
- Path of share within /ifs.
- permissions
GetSmb Share Smb Share Permission[] 
- Specifies an ordered list of permission modifications.
- runAs GetRoots Smb Share Smb Share Run As Root[] 
- Allow account to run as root.
- smb3EncryptionEnabled boolean
- Enables SMB3 encryption for the share.
- sparseFile boolean
- Enables sparse file.
- strictCa booleanLockout 
- 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.
- zid number
- Numeric ID of the access zone which contains this SMB share
- access_based_ boolenumeration 
- Only enumerate files and folders the requesting user has access to.
- access_based_ boolenumeration_ root_ only 
- Access-based enumeration on only the root directory of the share.
- allow_delete_ boolreadonly 
- Allow deletion of read-only files in the share.
- allow_execute_ boolalways 
- Allows users to execute files they have read rights for.
- allow_variable_ boolexpansion 
- Allow automatic expansion of variables for home directories.
- auto_create_ booldirectory 
- Automatically create home directories.
- browsable bool
- Share is visible in net view and the browse list.
- ca_timeout float
- Persistent open timeout for the share.
- ca_write_ strintegrity 
- Specify the level of write-integrity on continuously available shares.
- change_notify str
- Level of change notification alerts on the share.
- continuously_available bool
- Specify if persistent opens are allowed on the share.
- create_permissions str
- Create permissions for new files and directories in share.
- csc_policy str
- Client-side caching policy for the shares.
- description str
- Description for this SMB share.
- directory_create_ floatmask 
- Directory create mask bits.
- directory_create_ floatmode 
- Directory create mode bits.
- file_create_ floatmask 
- File create mask bits.
- file_create_ floatmode 
- File create mode bits.
- file_filter_ Sequence[str]extensions 
- Specifies the list of file extensions.
- file_filter_ strtype 
- Specifies if filter list is for deny or allow. Default is deny.
- file_filtering_ boolenabled 
- Enables file filtering on this zone.
- hide_dot_ boolfiles 
- 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.
- id str
- Share ID.
- impersonate_guest str
- Specify the condition in which user access is done as the guest account.
- impersonate_user str
- User account to be used as guest account.
- inheritable_path_ boolacl 
- Set the inheritable ACL on the share path.
- mangle_byte_ floatstart 
- Specifies the wchar_t starting point for automatic byte mangling.
- mangle_maps Sequence[str]
- Character mangle map.
- name str
- Share name.
- ntfs_acl_ boolsupport 
- Support NTFS ACLs on files and directories.
- oplocks bool
- Support oplocks.
- path str
- Path of share within /ifs.
- permissions
Sequence[GetSmb Share Smb Share Permission] 
- Specifies an ordered list of permission modifications.
- run_as_ Sequence[Getroots Smb Share Smb Share Run As Root] 
- Allow account to run as root.
- smb3_encryption_ boolenabled 
- Enables SMB3 encryption for the share.
- sparse_file bool
- Enables sparse file.
- strict_ca_ boollockout 
- 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.
- zid float
- Numeric ID of the access zone which contains this SMB share
- accessBased BooleanEnumeration 
- Only enumerate files and folders the requesting user has access to.
- accessBased BooleanEnumeration Root Only 
- Access-based enumeration on only the root directory of the share.
- allowDelete BooleanReadonly 
- Allow deletion of read-only files in the share.
- allowExecute BooleanAlways 
- Allows users to execute files they have read rights for.
- allowVariable BooleanExpansion 
- Allow automatic expansion of variables for home directories.
- autoCreate BooleanDirectory 
- Automatically create home directories.
- browsable Boolean
- Share is visible in net view and the browse list.
- caTimeout Number
- Persistent open timeout for the share.
- caWrite StringIntegrity 
- Specify the level of write-integrity on continuously available shares.
- changeNotify String
- Level of change notification alerts on the share.
- continuouslyAvailable Boolean
- Specify if persistent opens are allowed on the share.
- createPermissions String
- Create permissions for new files and directories in share.
- cscPolicy String
- Client-side caching policy for the shares.
- description String
- Description for this SMB share.
- directoryCreate NumberMask 
- Directory create mask bits.
- directoryCreate NumberMode 
- Directory create mode bits.
- fileCreate NumberMask 
- File create mask bits.
- fileCreate NumberMode 
- File create mode bits.
- fileFilter List<String>Extensions 
- Specifies the list of file extensions.
- fileFilter StringType 
- Specifies if filter list is for deny or allow. Default is deny.
- fileFiltering BooleanEnabled 
- Enables file filtering on this zone.
- hideDot BooleanFiles 
- 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.
- id String
- Share ID.
- impersonateGuest String
- Specify the condition in which user access is done as the guest account.
- impersonateUser String
- User account to be used as guest account.
- inheritablePath BooleanAcl 
- Set the inheritable ACL on the share path.
- mangleByte NumberStart 
- Specifies the wchar_t starting point for automatic byte mangling.
- mangleMaps List<String>
- Character mangle map.
- name String
- Share name.
- ntfsAcl BooleanSupport 
- Support NTFS ACLs on files and directories.
- oplocks Boolean
- Support oplocks.
- path String
- Path of share within /ifs.
- permissions List<Property Map>
- Specifies an ordered list of permission modifications.
- runAs List<Property Map>Roots 
- Allow account to run as root.
- smb3EncryptionEnabled Boolean
- Enables SMB3 encryption for the share.
- sparseFile Boolean
- Enables sparse file.
- strictCa BooleanLockout 
- 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.
- zid Number
- Numeric ID of the access zone which contains this SMB share
GetSmbShareSmbSharePermission     
- Permission string
- Specifies the file system rights that are allowed or denied.
- PermissionType string
- Determines whether the permission is allowed or denied.
- Trustee
GetSmb Share Smb Share Permission Trustee 
- Specifies the persona of the file group.
- Permission string
- Specifies the file system rights that are allowed or denied.
- PermissionType string
- Determines whether the permission is allowed or denied.
- Trustee
GetSmb Share Smb Share Permission Trustee 
- Specifies the persona of the file group.
- permission String
- Specifies the file system rights that are allowed or denied.
- permissionType String
- Determines whether the permission is allowed or denied.
- trustee
GetSmb Share Smb Share Permission Trustee 
- Specifies the persona of the file group.
- permission string
- Specifies the file system rights that are allowed or denied.
- permissionType string
- Determines whether the permission is allowed or denied.
- trustee
GetSmb Share Smb Share Permission Trustee 
- Specifies the persona of the file group.
- permission str
- Specifies the file system rights that are allowed or denied.
- permission_type str
- Determines whether the permission is allowed or denied.
- trustee
GetSmb Share Smb Share Permission Trustee 
- Specifies the persona of the file group.
- permission String
- Specifies the file system rights that are allowed or denied.
- permissionType String
- Determines whether the permission is allowed or denied.
- trustee Property Map
- Specifies the persona of the file group.
GetSmbShareSmbSharePermissionTrustee      
GetSmbShareSmbShareRunAsRoot       
Package Details
- Repository
- powerscale dell/terraform-provider-powerscale
- License
- Notes
- This Pulumi package is based on the powerscaleTerraform Provider.
