powerscale 1.7.0 published on Monday, Apr 14, 2025 by dell
powerscale.getSmbShare
Explore with Pulumi AI
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 dictionary
The following arguments are supported:
getSmbShare Result
The following output properties are available:
- Id string
- Identifier
- List<Get
Smb Share Smb Share> - List of smb shares
- Filter
Get
Smb Share Filter
- Id string
- Identifier
- []Get
Smb Share Smb Share - List of smb shares
- Filter
Get
Smb Share Filter
- id String
- Identifier
- List<Get
Smb Share Smb Share> - List of smb shares
- filter
Get
Smb Share Filter
- id string
- Identifier
- Get
Smb Share Smb Share[] - List of smb shares
- filter
Get
Smb Share Filter
- id str
- Identifier
- Sequence[Get
Smb Share Smb Share] - List of smb shares
- filter
Get
Smb 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
- 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 double - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares.
- Change
Notify string - Level of change notification alerts on the share.
- Continuously
Available bool - Specify if persistent opens are allowed on the share.
- Create
Permissions string - Create permissions for new files and directories in share.
- Csc
Policy string - Client-side caching policy for the shares.
- Description string
- Description for this SMB share.
- Directory
Create doubleMask - Directory create mask bits.
- Directory
Create doubleMode - Directory create mode bits.
- File
Create doubleMask - File create mask bits.
- File
Create doubleMode - File create mode bits.
- File
Filter List<string>Extensions - Specifies the list of file extensions.
- File
Filter stringType - 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 List<string> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Id string
- Share ID.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account.
- Impersonate
User string - User account to be used as guest account.
- Inheritable
Path boolAcl - Set the inheritable ACL on the share path.
- Mangle
Byte doubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps List<string> - Character mangle map.
- Name string
- Share name.
- Ntfs
Acl boolSupport - Support NTFS ACLs on files and directories.
- Oplocks bool
- Support oplocks.
- Path string
- Path of share within /ifs.
- Permissions
List<Get
Smb Share Smb Share Permission> - Specifies an ordered list of permission modifications.
- Run
As List<GetRoots Smb Share Smb Share Run As Root> - Allow account to run as root.
- Smb3Encryption
Enabled bool - 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 double
- 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 float64 - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares.
- Change
Notify string - Level of change notification alerts on the share.
- Continuously
Available bool - Specify if persistent opens are allowed on the share.
- Create
Permissions string - Create permissions for new files and directories in share.
- Csc
Policy string - Client-side caching policy for the shares.
- Description string
- Description for this SMB share.
- Directory
Create float64Mask - Directory create mask bits.
- Directory
Create float64Mode - Directory create mode bits.
- File
Create float64Mask - File create mask bits.
- File
Create float64Mode - File create mode bits.
- File
Filter []stringExtensions - Specifies the list of file extensions.
- File
Filter stringType - 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 []string - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Id string
- Share ID.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account.
- Impersonate
User string - User account to be used as guest account.
- Inheritable
Path boolAcl - Set the inheritable ACL on the share path.
- Mangle
Byte float64Start - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps []string - Character mangle map.
- Name string
- Share name.
- Ntfs
Acl boolSupport - Support NTFS ACLs on files and directories.
- Oplocks bool
- Support oplocks.
- Path string
- Path of share within /ifs.
- Permissions
[]Get
Smb Share Smb Share Permission - Specifies an ordered list of permission modifications.
- Run
As []GetRoots Smb Share Smb Share Run As Root - Allow account to run as root.
- Smb3Encryption
Enabled bool - 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 float64
- Numeric ID of the access zone which contains this SMB share
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- allow
Variable BooleanExpansion - Allow automatic expansion of variables for home directories.
- auto
Create BooleanDirectory - Automatically create home directories.
- browsable Boolean
- Share is visible in net view and the browse list.
- ca
Timeout Double - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares.
- change
Notify String - Level of change notification alerts on the share.
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - Create permissions for new files and directories in share.
- csc
Policy String - Client-side caching policy for the shares.
- description String
- Description for this SMB share.
- directory
Create DoubleMask - Directory create mask bits.
- directory
Create DoubleMode - Directory create mode bits.
- file
Create DoubleMask - File create mask bits.
- file
Create DoubleMode - File create mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on this zone.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- id String
- Share ID.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account.
- impersonate
User String - User account to be used as guest account.
- inheritable
Path BooleanAcl - Set the inheritable ACL on the share path.
- mangle
Byte DoubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- name String
- Share name.
- ntfs
Acl BooleanSupport - Support NTFS ACLs on files and directories.
- oplocks Boolean
- Support oplocks.
- path String
- Path of share within /ifs.
- permissions
List<Get
Smb Share Smb Share Permission> - Specifies an ordered list of permission modifications.
- run
As List<GetRoots Smb Share Smb Share Run As Root> - Allow account to run as root.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - 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.
- zid Double
- Numeric ID of the access zone which contains this SMB share
- access
Based booleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based booleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete booleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute booleanAlways - Allows users to execute files they have read rights for.
- allow
Variable booleanExpansion - Allow automatic expansion of variables for home directories.
- auto
Create booleanDirectory - Automatically create home directories.
- browsable boolean
- Share is visible in net view and the browse list.
- ca
Timeout number - Persistent open timeout for the share.
- ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares.
- change
Notify string - Level of change notification alerts on the share.
- continuously
Available boolean - Specify if persistent opens are allowed on the share.
- create
Permissions string - Create permissions for new files and directories in share.
- csc
Policy string - Client-side caching policy for the shares.
- description string
- Description for this SMB share.
- directory
Create numberMask - Directory create mask bits.
- directory
Create numberMode - Directory create mode bits.
- file
Create numberMask - File create mask bits.
- file
Create numberMode - File create mode bits.
- file
Filter string[]Extensions - Specifies the list of file extensions.
- file
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering booleanEnabled - Enables file filtering on this zone.
- hide
Dot booleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls string[] - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- id string
- Share ID.
- impersonate
Guest string - Specify the condition in which user access is done as the guest account.
- impersonate
User string - User account to be used as guest account.
- inheritable
Path booleanAcl - Set the inheritable ACL on the share path.
- mangle
Byte numberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps string[] - Character mangle map.
- name string
- Share name.
- ntfs
Acl booleanSupport - Support NTFS ACLs on files and directories.
- oplocks boolean
- Support oplocks.
- path string
- Path of share within /ifs.
- permissions
Get
Smb Share Smb Share Permission[] - Specifies an ordered list of permission modifications.
- run
As GetRoots Smb Share Smb Share Run As Root[] - Allow account to run as root.
- smb3Encryption
Enabled boolean - Enables SMB3 encryption for the share.
- sparse
File boolean - Enables sparse file.
- strict
Ca booleanLockout - 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.
- 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[Get
Smb 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
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- allow
Variable BooleanExpansion - Allow automatic expansion of variables for home directories.
- auto
Create BooleanDirectory - Automatically create home directories.
- browsable Boolean
- Share is visible in net view and the browse list.
- ca
Timeout Number - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares.
- change
Notify String - Level of change notification alerts on the share.
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - Create permissions for new files and directories in share.
- csc
Policy String - Client-side caching policy for the shares.
- description String
- Description for this SMB share.
- directory
Create NumberMask - Directory create mask bits.
- directory
Create NumberMode - Directory create mode bits.
- file
Create NumberMask - File create mask bits.
- file
Create NumberMode - File create mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on this zone.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- id String
- Share ID.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account.
- impersonate
User String - User account to be used as guest account.
- inheritable
Path BooleanAcl - Set the inheritable ACL on the share path.
- mangle
Byte NumberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- name String
- Share name.
- ntfs
Acl 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.
- run
As List<Property Map>Roots - Allow account to run as root.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - 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.
- 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.
- Permission
Type string - Determines whether the permission is allowed or denied.
- Trustee
Get
Smb Share Smb Share Permission Trustee - Specifies the persona of the file group.
- Permission string
- Specifies the file system rights that are allowed or denied.
- Permission
Type string - Determines whether the permission is allowed or denied.
- Trustee
Get
Smb Share Smb Share Permission Trustee - Specifies the persona of the file group.
- permission String
- Specifies the file system rights that are allowed or denied.
- permission
Type String - Determines whether the permission is allowed or denied.
- trustee
Get
Smb Share Smb Share Permission Trustee - Specifies the persona of the file group.
- permission string
- Specifies the file system rights that are allowed or denied.
- permission
Type string - Determines whether the permission is allowed or denied.
- trustee
Get
Smb 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
Get
Smb Share Smb Share Permission Trustee - Specifies the persona of the file group.
- permission String
- Specifies the file system rights that are allowed or denied.
- permission
Type 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
powerscale
Terraform Provider.