powerstore.getSmbShare

Explore with Pulumi AI

powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

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.

TypeScript
Python
Go
C#
Java
YAML

function getSmbShare(args: GetSmbShareArgs, opts?: InvokeOptions): Promise<GetSmbShareResult>
function getSmbShareOutput(args: GetSmbShareOutputArgs, opts?: InvokeOptions): Output<GetSmbShareResult>

def get_smb_share(file_system_id: Optional[str] = None,
                  filter_expression: Optional[str] = None,
                  id: Optional[str] = None,
                  name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSmbShareResult
def get_smb_share_output(file_system_id: Optional[pulumi.Input[str]] = None,
                  filter_expression: Optional[pulumi.Input[str]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = 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: powerstore:index/getSmbShare:getSmbShare
  arguments:
    # arguments dictionary

The following arguments are supported:

FileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
FilterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
Id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
Name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

FileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
FilterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
Id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
Name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

fileSystemId String: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression String: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
id String: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
name String: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

fileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

file_system_id str: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filter_expression str: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
id str: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
name str: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

fileSystemId String: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression String: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
id String: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
name String: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

getSmbShare Result

The following output properties are available:

Id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
SmbShares List<GetSmbShareSmbShare>: List of SMB shares fetched from PowerStore array.
FileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
FilterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
Name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

Id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
SmbShares []GetSmbShareSmbShare: List of SMB shares fetched from PowerStore array.
FileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
FilterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
Name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

id String: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
smbShares List<GetSmbShareSmbShare>: List of SMB shares fetched from PowerStore array.
fileSystemId String: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression String: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
name String: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

id string: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
smbShares GetSmbShareSmbShare[]: List of SMB shares fetched from PowerStore array.
fileSystemId string: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression string: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
name string: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

id str: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
smb_shares Sequence[GetSmbShareSmbShare]: List of SMB shares fetched from PowerStore array.
file_system_id str: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filter_expression str: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
name str: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

id String: Unique identifier of the SMB share to be fetched. Conflicts with name, file_system_id and filter_expression.
smbShares List<Property Map>: List of SMB shares fetched from PowerStore array.
fileSystemId String: The ID of the file system whose SMB Shares are to be fetched. Conflicts with id, name and filter_expression.
filterExpression String: PowerStore filter expression to filter SMB shares by. Conflicts with id, name and file_system_id.
name String: Name of the SMB share to be fetch. Conflicts with id, file_system_id and filter_expression.

Supporting Types

GetSmbShareSmbShare

Description string: User defined SMB share description.
FileSystemId string: The unique identifier of the file system on which the SMB Share is created.
Id string: The unique identifier of the SMB Share.
IsAbeEnabled bool: Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
IsContinuousAvailabilityEnabled bool: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
IsEncryptionEnabled bool: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
Name string: The name of the SMB Share.
OfflineAvailability string: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
OfflineAvailabilityL10n string: Localized message string corresponding to offline_availability
Path string: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
Umask string: The default UNIX umask for new files created on the Share.

Description string: User defined SMB share description.
FileSystemId string: The unique identifier of the file system on which the SMB Share is created.
Id string: The unique identifier of the SMB Share.
IsAbeEnabled bool: Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
IsContinuousAvailabilityEnabled bool: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
IsEncryptionEnabled bool: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
Name string: The name of the SMB Share.
OfflineAvailability string: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
OfflineAvailabilityL10n string: Localized message string corresponding to offline_availability
Path string: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
Umask string: The default UNIX umask for new files created on the Share.

description String: User defined SMB share description.
fileSystemId String: The unique identifier of the file system on which the SMB Share is created.
id String: The unique identifier of the SMB Share.
isAbeEnabled Boolean: Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
isContinuousAvailabilityEnabled Boolean: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
isEncryptionEnabled Boolean: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
name String: The name of the SMB Share.
offlineAvailability String: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
offlineAvailabilityL10n String: Localized message string corresponding to offline_availability
path String: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
umask String: The default UNIX umask for new files created on the Share.

description string: User defined SMB share description.
fileSystemId string: The unique identifier of the file system on which the SMB Share is created.
id string: The unique identifier of the SMB Share.
isAbeEnabled boolean: Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled boolean: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
isContinuousAvailabilityEnabled boolean: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
isEncryptionEnabled boolean: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
name string: The name of the SMB Share.
offlineAvailability string: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
offlineAvailabilityL10n string: Localized message string corresponding to offline_availability
path string: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
umask string: The default UNIX umask for new files created on the Share.

description str: User defined SMB share description.
file_system_id str: The unique identifier of the file system on which the SMB Share is created.
id str: The unique identifier of the SMB Share.
is_abe_enabled bool: Whether Access-based Enumeration (ABE) is enabled.
is_branch_cache_enabled bool: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
is_continuous_availability_enabled bool: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
is_encryption_enabled bool: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
name str: The name of the SMB Share.
offline_availability str: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
offline_availability_l10n str: Localized message string corresponding to offline_availability
path str: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
umask str: The default UNIX umask for new files created on the Share.

description String: User defined SMB share description.
fileSystemId String: The unique identifier of the file system on which the SMB Share is created.
id String: The unique identifier of the SMB Share.
isAbeEnabled Boolean: Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean: Whether BranchCache optimization is enabled. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
isContinuousAvailabilityEnabled Boolean: Whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share.
isEncryptionEnabled Boolean: Whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
name String: The name of the SMB Share.
offlineAvailability String: Defines valid states of Offline Availability, where the states are: Manual - Only specified files will be available offline. Documents - All files that users open will be available offline. Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. None - Prevents clients from storing documents and programs in offline cache.
offlineAvailabilityL10n String: Localized message string corresponding to offline_availability
path String: The local path of the filesystem or any existing sub-folder of the file system exported via the SMB Share. This path is relative to the NAS Server.
umask String: The default UNIX umask for new files created on the Share.

Package Details

Repository: powerstore dell/terraform-provider-powerstore
License
Notes: This Pulumi package is based on the powerstore Terraform Provider.

powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

dell/terraform-provider-powerstore

powerstore.getSmbShare

On this page

On this page

Using getSmbShare

getSmbShare Result

Supporting Types

GetSmbShareSmbShare

Package Details

On this page

On this page