Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerstore Provider
  3. API Docs
  4. SmbShare
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerstore

powerstore.SmbShare

Explore with Pulumi AI

powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerstore

This resource is used to manage the smb share entity of PowerStore Array. We can Create, Update and Delete the smb share using this resource. We can also import an existing smb share from PowerStore array.

(resource arguments)

}

$ pulumi import powerstore:index/smbShare:SmbShare Step 4 - Execute the command: "powerstore_smb_share.resource_block_name" "id_of_the_smb_share" (resource_block_name must be taken from step 3 and id must be taken from step 2)
Copy

Step 5 - After successful execution of the command , check the state file

Create SmbShare Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SmbShare(name: string, args: SmbShareArgs, opts?: CustomResourceOptions);
@overload
def SmbShare(resource_name: str,
             args: SmbShareArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def SmbShare(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             file_system_id: Optional[str] = None,
             path: Optional[str] = None,
             aces: Optional[Sequence[SmbShareAceArgs]] = None,
             description: Optional[str] = None,
             is_abe_enabled: Optional[bool] = None,
             is_branch_cache_enabled: Optional[bool] = None,
             is_continuous_availability_enabled: Optional[bool] = None,
             is_encryption_enabled: Optional[bool] = None,
             name: Optional[str] = None,
             offline_availability: Optional[str] = None,
             umask: Optional[str] = None)
func NewSmbShare(ctx *Context, name string, args SmbShareArgs, opts ...ResourceOption) (*SmbShare, error)
public SmbShare(string name, SmbShareArgs args, CustomResourceOptions? opts = null)
public SmbShare(String name, SmbShareArgs args)
public SmbShare(String name, SmbShareArgs args, CustomResourceOptions options)

type: powerstore:SmbShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SmbShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SmbShareArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SmbShareArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SmbShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SmbShareArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var smbShareResource = new Powerstore.SmbShare("smbShareResource", new()
{
    FileSystemId = "string",
    Path = "string",
    Aces = new[]
    {
        new Powerstore.Inputs.SmbShareAceArgs
        {
            AccessLevel = "string",
            AccessType = "string",
            TrusteeName = "string",
            TrusteeType = "string",
        },
    },
    Description = "string",
    IsAbeEnabled = false,
    IsBranchCacheEnabled = false,
    IsContinuousAvailabilityEnabled = false,
    IsEncryptionEnabled = false,
    Name = "string",
    OfflineAvailability = "string",
    Umask = "string",
});
Copy
example, err := powerstore.NewSmbShare(ctx, "smbShareResource", &powerstore.SmbShareArgs{
FileSystemId: pulumi.String("string"),
Path: pulumi.String("string"),
Aces: .SmbShareAceArray{
&.SmbShareAceArgs{
AccessLevel: pulumi.String("string"),
AccessType: pulumi.String("string"),
TrusteeName: pulumi.String("string"),
TrusteeType: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
IsAbeEnabled: pulumi.Bool(false),
IsBranchCacheEnabled: pulumi.Bool(false),
IsContinuousAvailabilityEnabled: pulumi.Bool(false),
IsEncryptionEnabled: pulumi.Bool(false),
Name: pulumi.String("string"),
OfflineAvailability: pulumi.String("string"),
Umask: pulumi.String("string"),
})
Copy
var smbShareResource = new SmbShare("smbShareResource", SmbShareArgs.builder()
    .fileSystemId("string")
    .path("string")
    .aces(SmbShareAceArgs.builder()
        .accessLevel("string")
        .accessType("string")
        .trusteeName("string")
        .trusteeType("string")
        .build())
    .description("string")
    .isAbeEnabled(false)
    .isBranchCacheEnabled(false)
    .isContinuousAvailabilityEnabled(false)
    .isEncryptionEnabled(false)
    .name("string")
    .offlineAvailability("string")
    .umask("string")
    .build());
Copy
smb_share_resource = powerstore.SmbShare("smbShareResource",
    file_system_id="string",
    path="string",
    aces=[{
        "access_level": "string",
        "access_type": "string",
        "trustee_name": "string",
        "trustee_type": "string",
    }],
    description="string",
    is_abe_enabled=False,
    is_branch_cache_enabled=False,
    is_continuous_availability_enabled=False,
    is_encryption_enabled=False,
    name="string",
    offline_availability="string",
    umask="string")
Copy
const smbShareResource = new powerstore.SmbShare("smbShareResource", {
    fileSystemId: "string",
    path: "string",
    aces: [{
        accessLevel: "string",
        accessType: "string",
        trusteeName: "string",
        trusteeType: "string",
    }],
    description: "string",
    isAbeEnabled: false,
    isBranchCacheEnabled: false,
    isContinuousAvailabilityEnabled: false,
    isEncryptionEnabled: false,
    name: "string",
    offlineAvailability: "string",
    umask: "string",
});
Copy
type: powerstore:SmbShare
properties:
    aces:
        - accessLevel: string
          accessType: string
          trusteeName: string
          trusteeType: string
    description: string
    fileSystemId: string
    isAbeEnabled: false
    isBranchCacheEnabled: false
    isContinuousAvailabilityEnabled: false
    isEncryptionEnabled: false
    name: string
    offlineAvailability: string
    path: string
    umask: string
Copy

SmbShare Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SmbShare resource accepts the following input properties:

FileSystemId This property is required. string
The unique identifier of the file system on which the SMB Share is created.
Path This property is required. string
The local path to export relative to the NAS Server.
Aces List<SmbShareAce>
To specify the ACL access options.
Description string
User defined SMB share description.
IsAbeEnabled bool
Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool
Whether BranchCache optimization is enabled.
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.
Umask string
The default UNIX umask for new files created on the Share.
FileSystemId This property is required. string
The unique identifier of the file system on which the SMB Share is created.
Path This property is required. string
The local path to export relative to the NAS Server.
Aces []SmbShareAceArgs
To specify the ACL access options.
Description string
User defined SMB share description.
IsAbeEnabled bool
Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool
Whether BranchCache optimization is enabled.
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.
Umask string
The default UNIX umask for new files created on the Share.
fileSystemId This property is required. String
The unique identifier of the file system on which the SMB Share is created.
path This property is required. String
The local path to export relative to the NAS Server.
aces List<SmbShareAce>
To specify the ACL access options.
description String
User defined SMB share description.
isAbeEnabled Boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean
Whether BranchCache optimization is enabled.
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.
umask String
The default UNIX umask for new files created on the Share.
fileSystemId This property is required. string
The unique identifier of the file system on which the SMB Share is created.
path This property is required. string
The local path to export relative to the NAS Server.
aces SmbShareAce[]
To specify the ACL access options.
description string
User defined SMB share description.
isAbeEnabled boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled boolean
Whether BranchCache optimization is enabled.
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.
umask string
The default UNIX umask for new files created on the Share.
file_system_id This property is required. str
The unique identifier of the file system on which the SMB Share is created.
path This property is required. str
The local path to export relative to the NAS Server.
aces Sequence[SmbShareAceArgs]
To specify the ACL access options.
description str
User defined SMB share description.
is_abe_enabled bool
Whether Access-based Enumeration (ABE) is enabled.
is_branch_cache_enabled bool
Whether BranchCache optimization is enabled.
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.
umask str
The default UNIX umask for new files created on the Share.
fileSystemId This property is required. String
The unique identifier of the file system on which the SMB Share is created.
path This property is required. String
The local path to export relative to the NAS Server.
aces List<Property Map>
To specify the ACL access options.
description String
User defined SMB share description.
isAbeEnabled Boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean
Whether BranchCache optimization is enabled.
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.
umask String
The default UNIX umask for new files created on the Share.

Outputs

All input properties are implicitly available as output properties. Additionally, the SmbShare resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SmbShare Resource

Get an existing SmbShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SmbShareState, opts?: CustomResourceOptions): SmbShare
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aces: Optional[Sequence[SmbShareAceArgs]] = None,
        description: Optional[str] = None,
        file_system_id: Optional[str] = None,
        is_abe_enabled: Optional[bool] = None,
        is_branch_cache_enabled: Optional[bool] = None,
        is_continuous_availability_enabled: Optional[bool] = None,
        is_encryption_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        offline_availability: Optional[str] = None,
        path: Optional[str] = None,
        umask: Optional[str] = None) -> SmbShare
func GetSmbShare(ctx *Context, name string, id IDInput, state *SmbShareState, opts ...ResourceOption) (*SmbShare, error)
public static SmbShare Get(string name, Input<string> id, SmbShareState? state, CustomResourceOptions? opts = null)
public static SmbShare get(String name, Output<String> id, SmbShareState state, CustomResourceOptions options)
resources:  _:    type: powerstore:SmbShare    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Aces List<SmbShareAce>
To specify the ACL access options.
Description string
User defined SMB share description.
FileSystemId string
The unique identifier of the file system on which the SMB Share is created.
IsAbeEnabled bool
Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool
Whether BranchCache optimization is enabled.
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.
Path string
The local path to export relative to the NAS Server.
Umask string
The default UNIX umask for new files created on the Share.
Aces []SmbShareAceArgs
To specify the ACL access options.
Description string
User defined SMB share description.
FileSystemId string
The unique identifier of the file system on which the SMB Share is created.
IsAbeEnabled bool
Whether Access-based Enumeration (ABE) is enabled.
IsBranchCacheEnabled bool
Whether BranchCache optimization is enabled.
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.
Path string
The local path to export relative to the NAS Server.
Umask string
The default UNIX umask for new files created on the Share.
aces List<SmbShareAce>
To specify the ACL access options.
description String
User defined SMB share description.
fileSystemId String
The unique identifier of the file system on which the SMB Share is created.
isAbeEnabled Boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean
Whether BranchCache optimization is enabled.
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.
path String
The local path to export relative to the NAS Server.
umask String
The default UNIX umask for new files created on the Share.
aces SmbShareAce[]
To specify the ACL access options.
description string
User defined SMB share description.
fileSystemId string
The unique identifier of the file system on which the SMB Share is created.
isAbeEnabled boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled boolean
Whether BranchCache optimization is enabled.
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.
path string
The local path to export relative to the NAS Server.
umask string
The default UNIX umask for new files created on the Share.
aces Sequence[SmbShareAceArgs]
To specify the ACL access options.
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.
is_abe_enabled bool
Whether Access-based Enumeration (ABE) is enabled.
is_branch_cache_enabled bool
Whether BranchCache optimization is enabled.
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.
path str
The local path to export relative to the NAS Server.
umask str
The default UNIX umask for new files created on the Share.
aces List<Property Map>
To specify the ACL access options.
description String
User defined SMB share description.
fileSystemId String
The unique identifier of the file system on which the SMB Share is created.
isAbeEnabled Boolean
Whether Access-based Enumeration (ABE) is enabled.
isBranchCacheEnabled Boolean
Whether BranchCache optimization is enabled.
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.
path String
The local path to export relative to the NAS Server.
umask String
The default UNIX umask for new files created on the Share.

Supporting Types

SmbShareAce
, SmbShareAceArgs

AccessLevel This property is required. string
The access level.
AccessType This property is required. string
The access type.
TrusteeName This property is required. string
The name of the trustee.
TrusteeType This property is required. string
The type of the trustee.
AccessLevel This property is required. string
The access level.
AccessType This property is required. string
The access type.
TrusteeName This property is required. string
The name of the trustee.
TrusteeType This property is required. string
The type of the trustee.
accessLevel This property is required. String
The access level.
accessType This property is required. String
The access type.
trusteeName This property is required. String
The name of the trustee.
trusteeType This property is required. String
The type of the trustee.
accessLevel This property is required. string
The access level.
accessType This property is required. string
The access type.
trusteeName This property is required. string
The name of the trustee.
trusteeType This property is required. string
The type of the trustee.
access_level This property is required. str
The access level.
access_type This property is required. str
The access type.
trustee_name This property is required. str
The name of the trustee.
trustee_type This property is required. str
The type of the trustee.
accessLevel This property is required. String
The access level.
accessType This property is required. String
The access type.
trusteeName This property is required. String
The name of the trustee.
trusteeType This property is required. String
The type of the trustee.

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