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

powerscale.SmbShare

Explore with Pulumi AI

powerscale logo
powerscale 1.7.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerscale

    This resource is used to manage the SMB share entity on PowerScale array. PowerScale SMB shares provide clients network access to file system resources on the cluster. We can Create, Update and Delete the SMB share using this resource. We can also import an existing SMB Share from PowerScale array.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as powerscale from "@pulumi/powerscale";

// PowerScale SMB shares provide clients network access to file system resources on the cluster
const shareExample = new powerscale.SmbShare("shareExample", {
    path: "/ifs/smb_share_example",
    permissions: [{
        permission: "full",
        permissionType: "allow",
        trustee: {
            id: "SID:S-1-1-0",
            name: "Everyone",
            type: "wellknown",
        },
    }],
});

    import pulumi
import pulumi_powerscale as powerscale

# PowerScale SMB shares provide clients network access to file system resources on the cluster
share_example = powerscale.SmbShare("shareExample",
    path="/ifs/smb_share_example",
    permissions=[{
        "permission": "full",
        "permission_type": "allow",
        "trustee": {
            "id": "SID:S-1-1-0",
            "name": "Everyone",
            "type": "wellknown",
        },
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// PowerScale SMB shares provide clients network access to file system resources on the cluster
		_, err := powerscale.NewSmbShare(ctx, "shareExample", &powerscale.SmbShareArgs{
			Path: pulumi.String("/ifs/smb_share_example"),
			Permissions: powerscale.SmbSharePermissionArray{
				&powerscale.SmbSharePermissionArgs{
					Permission:     pulumi.String("full"),
					PermissionType: pulumi.String("allow"),
					Trustee: &powerscale.SmbSharePermissionTrusteeArgs{
						Id:   pulumi.String("SID:S-1-1-0"),
						Name: pulumi.String("Everyone"),
						Type: pulumi.String("wellknown"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    // PowerScale SMB shares provide clients network access to file system resources on the cluster
    var shareExample = new Powerscale.SmbShare("shareExample", new()
    {
        Path = "/ifs/smb_share_example",
        Permissions = new[]
        {
            new Powerscale.Inputs.SmbSharePermissionArgs
            {
                Permission = "full",
                PermissionType = "allow",
                Trustee = new Powerscale.Inputs.SmbSharePermissionTrusteeArgs
                {
                    Id = "SID:S-1-1-0",
                    Name = "Everyone",
                    Type = "wellknown",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SmbShare;
import com.pulumi.powerscale.SmbShareArgs;
import com.pulumi.powerscale.inputs.SmbSharePermissionArgs;
import com.pulumi.powerscale.inputs.SmbSharePermissionTrusteeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // PowerScale SMB shares provide clients network access to file system resources on the cluster
        var shareExample = new SmbShare("shareExample", SmbShareArgs.builder()
            .path("/ifs/smb_share_example")
            .permissions(SmbSharePermissionArgs.builder()
                .permission("full")
                .permissionType("allow")
                .trustee(SmbSharePermissionTrusteeArgs.builder()
                    .id("SID:S-1-1-0")
                    .name("Everyone")
                    .type("wellknown")
                    .build())
                .build())
            .build());

    }
}

    resources:
  # PowerScale SMB shares provide clients network access to file system resources on the cluster
  shareExample:
    type: powerscale:SmbShare
    properties:
      path: /ifs/smb_share_example
      permissions:
        - permission: full
          permissionType: allow
          trustee:
            id: SID:S-1-1-0
            name: Everyone
            type: wellknown

    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,
             path: Optional[str] = None,
             permissions: Optional[Sequence[SmbSharePermissionArgs]] = None,
             file_filtering_enabled: Optional[bool] = None,
             hide_dot_files: Optional[bool] = None,
             allow_variable_expansion: Optional[bool] = None,
             auto_create_directory: Optional[bool] = None,
             browsable: Optional[bool] = None,
             ca_timeout: Optional[float] = None,
             ca_write_integrity: Optional[str] = None,
             change_notify: Optional[str] = None,
             create_path: Optional[bool] = None,
             host_acls: Optional[Sequence[str]] = None,
             csc_policy: Optional[str] = None,
             description: Optional[str] = None,
             directory_create_mask: Optional[float] = None,
             directory_create_mode: Optional[float] = None,
             file_create_mask: Optional[float] = None,
             file_create_mode: Optional[float] = None,
             file_filter_extensions: Optional[Sequence[str]] = None,
             file_filter_type: Optional[str] = None,
             allow_execute_always: Optional[bool] = None,
             access_based_enumeration: Optional[bool] = None,
             create_permissions: Optional[str] = None,
             impersonate_guest: Optional[str] = None,
             impersonate_user: Optional[str] = None,
             inheritable_path_acl: Optional[bool] = None,
             mangle_byte_start: Optional[float] = None,
             mangle_maps: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             ntfs_acl_support: Optional[bool] = None,
             oplocks: Optional[bool] = None,
             allow_delete_readonly: Optional[bool] = None,
             access_based_enumeration_root_only: Optional[bool] = None,
             run_as_roots: Optional[Sequence[SmbShareRunAsRootArgs]] = None,
             smb3_encryption_enabled: Optional[bool] = None,
             sparse_file: Optional[bool] = None,
             strict_ca_lockout: Optional[bool] = None,
             strict_flush: Optional[bool] = None,
             strict_locking: Optional[bool] = None,
             zone: 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: powerscale:SmbShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SmbShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args SmbShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmbShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 Powerscale.SmbShare("smbShareResource", new()
{
    Path = "string",
    Permissions = new[]
    {
        new Powerscale.Inputs.SmbSharePermissionArgs
        {
            Permission = "string",
            PermissionType = "string",
            Trustee = new Powerscale.Inputs.SmbSharePermissionTrusteeArgs
            {
                Id = "string",
                Name = "string",
                Type = "string",
            },
        },
    },
    FileFilteringEnabled = false,
    HideDotFiles = false,
    AllowVariableExpansion = false,
    AutoCreateDirectory = false,
    Browsable = false,
    CaTimeout = 0,
    CaWriteIntegrity = "string",
    ChangeNotify = "string",
    CreatePath = false,
    HostAcls = new[]
    {
        "string",
    },
    CscPolicy = "string",
    Description = "string",
    DirectoryCreateMask = 0,
    DirectoryCreateMode = 0,
    FileCreateMask = 0,
    FileCreateMode = 0,
    FileFilterExtensions = new[]
    {
        "string",
    },
    FileFilterType = "string",
    AllowExecuteAlways = false,
    AccessBasedEnumeration = false,
    CreatePermissions = "string",
    ImpersonateGuest = "string",
    ImpersonateUser = "string",
    InheritablePathAcl = false,
    MangleByteStart = 0,
    MangleMaps = new[]
    {
        "string",
    },
    Name = "string",
    NtfsAclSupport = false,
    Oplocks = false,
    AllowDeleteReadonly = false,
    AccessBasedEnumerationRootOnly = false,
    RunAsRoots = new[]
    {
        new Powerscale.Inputs.SmbShareRunAsRootArgs
        {
            Id = "string",
            Name = "string",
            Type = "string",
        },
    },
    Smb3EncryptionEnabled = false,
    SparseFile = false,
    StrictCaLockout = false,
    StrictFlush = false,
    StrictLocking = false,
    Zone = "string",
});

    example, err := powerscale.NewSmbShare(ctx, "smbShareResource", &powerscale.SmbShareArgs{
	Path: pulumi.String("string"),
	Permissions: powerscale.SmbSharePermissionArray{
		&powerscale.SmbSharePermissionArgs{
			Permission:     pulumi.String("string"),
			PermissionType: pulumi.String("string"),
			Trustee: &powerscale.SmbSharePermissionTrusteeArgs{
				Id:   pulumi.String("string"),
				Name: pulumi.String("string"),
				Type: pulumi.String("string"),
			},
		},
	},
	FileFilteringEnabled:   pulumi.Bool(false),
	HideDotFiles:           pulumi.Bool(false),
	AllowVariableExpansion: pulumi.Bool(false),
	AutoCreateDirectory:    pulumi.Bool(false),
	Browsable:              pulumi.Bool(false),
	CaTimeout:              pulumi.Float64(0),
	CaWriteIntegrity:       pulumi.String("string"),
	ChangeNotify:           pulumi.String("string"),
	CreatePath:             pulumi.Bool(false),
	HostAcls: pulumi.StringArray{
		pulumi.String("string"),
	},
	CscPolicy:           pulumi.String("string"),
	Description:         pulumi.String("string"),
	DirectoryCreateMask: pulumi.Float64(0),
	DirectoryCreateMode: pulumi.Float64(0),
	FileCreateMask:      pulumi.Float64(0),
	FileCreateMode:      pulumi.Float64(0),
	FileFilterExtensions: pulumi.StringArray{
		pulumi.String("string"),
	},
	FileFilterType:         pulumi.String("string"),
	AllowExecuteAlways:     pulumi.Bool(false),
	AccessBasedEnumeration: pulumi.Bool(false),
	CreatePermissions:      pulumi.String("string"),
	ImpersonateGuest:       pulumi.String("string"),
	ImpersonateUser:        pulumi.String("string"),
	InheritablePathAcl:     pulumi.Bool(false),
	MangleByteStart:        pulumi.Float64(0),
	MangleMaps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                           pulumi.String("string"),
	NtfsAclSupport:                 pulumi.Bool(false),
	Oplocks:                        pulumi.Bool(false),
	AllowDeleteReadonly:            pulumi.Bool(false),
	AccessBasedEnumerationRootOnly: pulumi.Bool(false),
	RunAsRoots: powerscale.SmbShareRunAsRootArray{
		&powerscale.SmbShareRunAsRootArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	Smb3EncryptionEnabled: pulumi.Bool(false),
	SparseFile:            pulumi.Bool(false),
	StrictCaLockout:       pulumi.Bool(false),
	StrictFlush:           pulumi.Bool(false),
	StrictLocking:         pulumi.Bool(false),
	Zone:                  pulumi.String("string"),
})

    var smbShareResource = new SmbShare("smbShareResource", SmbShareArgs.builder()
    .path("string")
    .permissions(SmbSharePermissionArgs.builder()
        .permission("string")
        .permissionType("string")
        .trustee(SmbSharePermissionTrusteeArgs.builder()
            .id("string")
            .name("string")
            .type("string")
            .build())
        .build())
    .fileFilteringEnabled(false)
    .hideDotFiles(false)
    .allowVariableExpansion(false)
    .autoCreateDirectory(false)
    .browsable(false)
    .caTimeout(0)
    .caWriteIntegrity("string")
    .changeNotify("string")
    .createPath(false)
    .hostAcls("string")
    .cscPolicy("string")
    .description("string")
    .directoryCreateMask(0)
    .directoryCreateMode(0)
    .fileCreateMask(0)
    .fileCreateMode(0)
    .fileFilterExtensions("string")
    .fileFilterType("string")
    .allowExecuteAlways(false)
    .accessBasedEnumeration(false)
    .createPermissions("string")
    .impersonateGuest("string")
    .impersonateUser("string")
    .inheritablePathAcl(false)
    .mangleByteStart(0)
    .mangleMaps("string")
    .name("string")
    .ntfsAclSupport(false)
    .oplocks(false)
    .allowDeleteReadonly(false)
    .accessBasedEnumerationRootOnly(false)
    .runAsRoots(SmbShareRunAsRootArgs.builder()
        .id("string")
        .name("string")
        .type("string")
        .build())
    .smb3EncryptionEnabled(false)
    .sparseFile(false)
    .strictCaLockout(false)
    .strictFlush(false)
    .strictLocking(false)
    .zone("string")
    .build());

    smb_share_resource = powerscale.SmbShare("smbShareResource",
    path="string",
    permissions=[{
        "permission": "string",
        "permission_type": "string",
        "trustee": {
            "id": "string",
            "name": "string",
            "type": "string",
        },
    }],
    file_filtering_enabled=False,
    hide_dot_files=False,
    allow_variable_expansion=False,
    auto_create_directory=False,
    browsable=False,
    ca_timeout=0,
    ca_write_integrity="string",
    change_notify="string",
    create_path=False,
    host_acls=["string"],
    csc_policy="string",
    description="string",
    directory_create_mask=0,
    directory_create_mode=0,
    file_create_mask=0,
    file_create_mode=0,
    file_filter_extensions=["string"],
    file_filter_type="string",
    allow_execute_always=False,
    access_based_enumeration=False,
    create_permissions="string",
    impersonate_guest="string",
    impersonate_user="string",
    inheritable_path_acl=False,
    mangle_byte_start=0,
    mangle_maps=["string"],
    name="string",
    ntfs_acl_support=False,
    oplocks=False,
    allow_delete_readonly=False,
    access_based_enumeration_root_only=False,
    run_as_roots=[{
        "id": "string",
        "name": "string",
        "type": "string",
    }],
    smb3_encryption_enabled=False,
    sparse_file=False,
    strict_ca_lockout=False,
    strict_flush=False,
    strict_locking=False,
    zone="string")

    const smbShareResource = new powerscale.SmbShare("smbShareResource", {
    path: "string",
    permissions: [{
        permission: "string",
        permissionType: "string",
        trustee: {
            id: "string",
            name: "string",
            type: "string",
        },
    }],
    fileFilteringEnabled: false,
    hideDotFiles: false,
    allowVariableExpansion: false,
    autoCreateDirectory: false,
    browsable: false,
    caTimeout: 0,
    caWriteIntegrity: "string",
    changeNotify: "string",
    createPath: false,
    hostAcls: ["string"],
    cscPolicy: "string",
    description: "string",
    directoryCreateMask: 0,
    directoryCreateMode: 0,
    fileCreateMask: 0,
    fileCreateMode: 0,
    fileFilterExtensions: ["string"],
    fileFilterType: "string",
    allowExecuteAlways: false,
    accessBasedEnumeration: false,
    createPermissions: "string",
    impersonateGuest: "string",
    impersonateUser: "string",
    inheritablePathAcl: false,
    mangleByteStart: 0,
    mangleMaps: ["string"],
    name: "string",
    ntfsAclSupport: false,
    oplocks: false,
    allowDeleteReadonly: false,
    accessBasedEnumerationRootOnly: false,
    runAsRoots: [{
        id: "string",
        name: "string",
        type: "string",
    }],
    smb3EncryptionEnabled: false,
    sparseFile: false,
    strictCaLockout: false,
    strictFlush: false,
    strictLocking: false,
    zone: "string",
});

    type: powerscale:SmbShare
properties:
    accessBasedEnumeration: false
    accessBasedEnumerationRootOnly: false
    allowDeleteReadonly: false
    allowExecuteAlways: false
    allowVariableExpansion: false
    autoCreateDirectory: false
    browsable: false
    caTimeout: 0
    caWriteIntegrity: string
    changeNotify: string
    createPath: false
    createPermissions: string
    cscPolicy: string
    description: string
    directoryCreateMask: 0
    directoryCreateMode: 0
    fileCreateMask: 0
    fileCreateMode: 0
    fileFilterExtensions:
        - string
    fileFilterType: string
    fileFilteringEnabled: false
    hideDotFiles: false
    hostAcls:
        - string
    impersonateGuest: string
    impersonateUser: string
    inheritablePathAcl: false
    mangleByteStart: 0
    mangleMaps:
        - string
    name: string
    ntfsAclSupport: false
    oplocks: false
    path: string
    permissions:
        - permission: string
          permissionType: string
          trustee:
            id: string
            name: string
            type: string
    runAsRoots:
        - id: string
          name: string
          type: string
    smb3EncryptionEnabled: false
    sparseFile: false
    strictCaLockout: false
    strictFlush: false
    strictLocking: false
    zone: string

    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:

    Path string
    Path of share within /ifs.
    Permissions List<SmbSharePermission>
    Specifies an ordered list of permission modifications.
    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    AllowVariableExpansion bool
    Allow automatic expansion of variables for home directories.
    AutoCreateDirectory bool
    Automatically create home directories.
    Browsable bool
    Share is visible in net view and the browse list.
    CaTimeout double
    Persistent open timeout for the share.
    CaWriteIntegrity string
    Specify the level of write-integrity on continuously available shares.
    ChangeNotify string
    Level of change notification alerts on the share.
    CreatePath bool
    Create path if does not exist.
    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.
    DirectoryCreateMask double
    Directory create mask bits.
    DirectoryCreateMode double
    Directory create mode bits.
    FileCreateMask double
    File create mask bits.
    FileCreateMode double
    File create mode bits.
    FileFilterExtensions List<string>
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on this zone.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls List<string>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account.
    ImpersonateUser string
    User account to be used as guest account.
    InheritablePathAcl bool
    Set the inheritable ACL on the share path.
    MangleByteStart double
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps List<string>
    Character mangle map.
    Name string
    Share name.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Support oplocks.
    RunAsRoots List<SmbShareRunAsRoot>
    Allow account to run as root.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zone string
    Name of the access zone to which to move this SMB share.
    Path string
    Path of share within /ifs.
    Permissions []SmbSharePermissionArgs
    Specifies an ordered list of permission modifications.
    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    AllowVariableExpansion bool
    Allow automatic expansion of variables for home directories.
    AutoCreateDirectory bool
    Automatically create home directories.
    Browsable bool
    Share is visible in net view and the browse list.
    CaTimeout float64
    Persistent open timeout for the share.
    CaWriteIntegrity string
    Specify the level of write-integrity on continuously available shares.
    ChangeNotify string
    Level of change notification alerts on the share.
    CreatePath bool
    Create path if does not exist.
    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.
    DirectoryCreateMask float64
    Directory create mask bits.
    DirectoryCreateMode float64
    Directory create mode bits.
    FileCreateMask float64
    File create mask bits.
    FileCreateMode float64
    File create mode bits.
    FileFilterExtensions []string
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on this zone.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls []string
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account.
    ImpersonateUser string
    User account to be used as guest account.
    InheritablePathAcl bool
    Set the inheritable ACL on the share path.
    MangleByteStart float64
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps []string
    Character mangle map.
    Name string
    Share name.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Support oplocks.
    RunAsRoots []SmbShareRunAsRootArgs
    Allow account to run as root.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zone string
    Name of the access zone to which to move this SMB share.
    path String
    Path of share within /ifs.
    permissions List<SmbSharePermission>
    Specifies an ordered list of permission modifications.
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion Boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory Boolean
    Automatically create home directories.
    browsable Boolean
    Share is visible in net view and the browse list.
    caTimeout Double
    Persistent open timeout for the share.
    caWriteIntegrity String
    Specify the level of write-integrity on continuously available shares.
    changeNotify String
    Level of change notification alerts on the share.
    createPath Boolean
    Create path if does not exist.
    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.
    directoryCreateMask Double
    Directory create mask bits.
    directoryCreateMode Double
    Directory create mode bits.
    fileCreateMask Double
    File create mask bits.
    fileCreateMode Double
    File create mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on this zone.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account.
    impersonateUser String
    User account to be used as guest account.
    inheritablePathAcl Boolean
    Set the inheritable ACL on the share path.
    mangleByteStart Double
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    name String
    Share name.
    ntfsAclSupport Boolean
    Support NTFS ACLs on files and directories.
    oplocks Boolean
    Support oplocks.
    runAsRoots List<SmbShareRunAsRoot>
    Allow account to run as root.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone String
    Name of the access zone to which to move this SMB share.
    path string
    Path of share within /ifs.
    permissions SmbSharePermission[]
    Specifies an ordered list of permission modifications.
    accessBasedEnumeration boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory boolean
    Automatically create home directories.
    browsable boolean
    Share is visible in net view and the browse list.
    caTimeout number
    Persistent open timeout for the share.
    caWriteIntegrity string
    Specify the level of write-integrity on continuously available shares.
    changeNotify string
    Level of change notification alerts on the share.
    createPath boolean
    Create path if does not exist.
    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.
    directoryCreateMask number
    Directory create mask bits.
    directoryCreateMode number
    Directory create mode bits.
    fileCreateMask number
    File create mask bits.
    fileCreateMode number
    File create mode bits.
    fileFilterExtensions string[]
    Specifies the list of file extensions.
    fileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled boolean
    Enables file filtering on this zone.
    hideDotFiles boolean
    Hide files and directories that begin with a period '.'.
    hostAcls string[]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest string
    Specify the condition in which user access is done as the guest account.
    impersonateUser string
    User account to be used as guest account.
    inheritablePathAcl boolean
    Set the inheritable ACL on the share path.
    mangleByteStart number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps string[]
    Character mangle map.
    name string
    Share name.
    ntfsAclSupport boolean
    Support NTFS ACLs on files and directories.
    oplocks boolean
    Support oplocks.
    runAsRoots SmbShareRunAsRoot[]
    Allow account to run as root.
    smb3EncryptionEnabled boolean
    Enables SMB3 encryption for the share.
    sparseFile boolean
    Enables sparse file.
    strictCaLockout boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush boolean
    Handle SMB flush operations.
    strictLocking boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone string
    Name of the access zone to which to move this SMB share.
    path str
    Path of share within /ifs.
    permissions Sequence[SmbSharePermissionArgs]
    Specifies an ordered list of permission modifications.
    access_based_enumeration bool
    Only enumerate files and folders the requesting user has access to.
    access_based_enumeration_root_only bool
    Access-based enumeration on only the root directory of the share.
    allow_delete_readonly bool
    Allow deletion of read-only files in the share.
    allow_execute_always bool
    Allows users to execute files they have read rights for.
    allow_variable_expansion bool
    Allow automatic expansion of variables for home directories.
    auto_create_directory bool
    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_integrity str
    Specify the level of write-integrity on continuously available shares.
    change_notify str
    Level of change notification alerts on the share.
    create_path bool
    Create path if does not exist.
    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_mask float
    Directory create mask bits.
    directory_create_mode float
    Directory create mode bits.
    file_create_mask float
    File create mask bits.
    file_create_mode float
    File create mode bits.
    file_filter_extensions Sequence[str]
    Specifies the list of file extensions.
    file_filter_type str
    Specifies if filter list is for deny or allow. Default is deny.
    file_filtering_enabled bool
    Enables file filtering on this zone.
    hide_dot_files bool
    Hide files and directories that begin with a period '.'.
    host_acls Sequence[str]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonate_guest str
    Specify the condition in which user access is done as the guest account.
    impersonate_user str
    User account to be used as guest account.
    inheritable_path_acl bool
    Set the inheritable ACL on the share path.
    mangle_byte_start float
    Specifies the wchar_t starting point for automatic byte mangling.
    mangle_maps Sequence[str]
    Character mangle map.
    name str
    Share name.
    ntfs_acl_support bool
    Support NTFS ACLs on files and directories.
    oplocks bool
    Support oplocks.
    run_as_roots Sequence[SmbShareRunAsRootArgs]
    Allow account to run as root.
    smb3_encryption_enabled bool
    Enables SMB3 encryption for the share.
    sparse_file bool
    Enables sparse file.
    strict_ca_lockout bool
    Specifies if persistent opens would do strict lockout on the share.
    strict_flush bool
    Handle SMB flush operations.
    strict_locking bool
    Specifies whether byte range locks contend against SMB I/O.
    zone str
    Name of the access zone to which to move this SMB share.
    path String
    Path of share within /ifs.
    permissions List<Property Map>
    Specifies an ordered list of permission modifications.
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion Boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory Boolean
    Automatically create home directories.
    browsable Boolean
    Share is visible in net view and the browse list.
    caTimeout Number
    Persistent open timeout for the share.
    caWriteIntegrity String
    Specify the level of write-integrity on continuously available shares.
    changeNotify String
    Level of change notification alerts on the share.
    createPath Boolean
    Create path if does not exist.
    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.
    directoryCreateMask Number
    Directory create mask bits.
    directoryCreateMode Number
    Directory create mode bits.
    fileCreateMask Number
    File create mask bits.
    fileCreateMode Number
    File create mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on this zone.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account.
    impersonateUser String
    User account to be used as guest account.
    inheritablePathAcl Boolean
    Set the inheritable ACL on the share path.
    mangleByteStart Number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    name String
    Share name.
    ntfsAclSupport Boolean
    Support NTFS ACLs on files and directories.
    oplocks Boolean
    Support oplocks.
    runAsRoots List<Property Map>
    Allow account to run as root.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zone String
    Name of the access zone to which to move this SMB share.

    Outputs

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

    ContinuouslyAvailable bool
    Specify if persistent opens are allowed on the share.
    Id string
    The provider-assigned unique ID for this managed resource.
    Zid double
    Numeric ID of the access zone which contains this SMB share.
    ContinuouslyAvailable bool
    Specify if persistent opens are allowed on the share.
    Id string
    The provider-assigned unique ID for this managed resource.
    Zid float64
    Numeric ID of the access zone which contains this SMB share.
    continuouslyAvailable Boolean
    Specify if persistent opens are allowed on the share.
    id String
    The provider-assigned unique ID for this managed resource.
    zid Double
    Numeric ID of the access zone which contains this SMB share.
    continuouslyAvailable boolean
    Specify if persistent opens are allowed on the share.
    id string
    The provider-assigned unique ID for this managed resource.
    zid number
    Numeric ID of the access zone which contains this SMB share.
    continuously_available bool
    Specify if persistent opens are allowed on the share.
    id str
    The provider-assigned unique ID for this managed resource.
    zid float
    Numeric ID of the access zone which contains this SMB share.
    continuouslyAvailable Boolean
    Specify if persistent opens are allowed on the share.
    id String
    The provider-assigned unique ID for this managed resource.
    zid Number
    Numeric ID of the access zone which contains this SMB share.

    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,
        access_based_enumeration: Optional[bool] = None,
        access_based_enumeration_root_only: Optional[bool] = None,
        allow_delete_readonly: Optional[bool] = None,
        allow_execute_always: Optional[bool] = None,
        allow_variable_expansion: Optional[bool] = None,
        auto_create_directory: Optional[bool] = None,
        browsable: Optional[bool] = None,
        ca_timeout: Optional[float] = None,
        ca_write_integrity: Optional[str] = None,
        change_notify: Optional[str] = None,
        continuously_available: Optional[bool] = None,
        create_path: Optional[bool] = None,
        create_permissions: Optional[str] = None,
        csc_policy: Optional[str] = None,
        description: Optional[str] = None,
        directory_create_mask: Optional[float] = None,
        directory_create_mode: Optional[float] = None,
        file_create_mask: Optional[float] = None,
        file_create_mode: Optional[float] = None,
        file_filter_extensions: Optional[Sequence[str]] = None,
        file_filter_type: Optional[str] = None,
        file_filtering_enabled: Optional[bool] = None,
        hide_dot_files: Optional[bool] = None,
        host_acls: Optional[Sequence[str]] = None,
        impersonate_guest: Optional[str] = None,
        impersonate_user: Optional[str] = None,
        inheritable_path_acl: Optional[bool] = None,
        mangle_byte_start: Optional[float] = None,
        mangle_maps: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        ntfs_acl_support: Optional[bool] = None,
        oplocks: Optional[bool] = None,
        path: Optional[str] = None,
        permissions: Optional[Sequence[SmbSharePermissionArgs]] = None,
        run_as_roots: Optional[Sequence[SmbShareRunAsRootArgs]] = None,
        smb3_encryption_enabled: Optional[bool] = None,
        sparse_file: Optional[bool] = None,
        strict_ca_lockout: Optional[bool] = None,
        strict_flush: Optional[bool] = None,
        strict_locking: Optional[bool] = None,
        zid: Optional[float] = None,
        zone: 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: powerscale:SmbShare    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    AllowVariableExpansion bool
    Allow automatic expansion of variables for home directories.
    AutoCreateDirectory bool
    Automatically create home directories.
    Browsable bool
    Share is visible in net view and the browse list.
    CaTimeout double
    Persistent open timeout for the share.
    CaWriteIntegrity string
    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.
    CreatePath bool
    Create path if does not exist.
    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.
    DirectoryCreateMask double
    Directory create mask bits.
    DirectoryCreateMode double
    Directory create mode bits.
    FileCreateMask double
    File create mask bits.
    FileCreateMode double
    File create mode bits.
    FileFilterExtensions List<string>
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on this zone.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls List<string>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account.
    ImpersonateUser string
    User account to be used as guest account.
    InheritablePathAcl bool
    Set the inheritable ACL on the share path.
    MangleByteStart double
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps List<string>
    Character mangle map.
    Name string
    Share name.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Support oplocks.
    Path string
    Path of share within /ifs.
    Permissions List<SmbSharePermission>
    Specifies an ordered list of permission modifications.
    RunAsRoots List<SmbShareRunAsRoot>
    Allow account to run as root.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zid double
    Numeric ID of the access zone which contains this SMB share.
    Zone string
    Name of the access zone to which to move this SMB share.
    AccessBasedEnumeration bool
    Only enumerate files and folders the requesting user has access to.
    AccessBasedEnumerationRootOnly bool
    Access-based enumeration on only the root directory of the share.
    AllowDeleteReadonly bool
    Allow deletion of read-only files in the share.
    AllowExecuteAlways bool
    Allows users to execute files they have read rights for.
    AllowVariableExpansion bool
    Allow automatic expansion of variables for home directories.
    AutoCreateDirectory bool
    Automatically create home directories.
    Browsable bool
    Share is visible in net view and the browse list.
    CaTimeout float64
    Persistent open timeout for the share.
    CaWriteIntegrity string
    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.
    CreatePath bool
    Create path if does not exist.
    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.
    DirectoryCreateMask float64
    Directory create mask bits.
    DirectoryCreateMode float64
    Directory create mode bits.
    FileCreateMask float64
    File create mask bits.
    FileCreateMode float64
    File create mode bits.
    FileFilterExtensions []string
    Specifies the list of file extensions.
    FileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    FileFilteringEnabled bool
    Enables file filtering on this zone.
    HideDotFiles bool
    Hide files and directories that begin with a period '.'.
    HostAcls []string
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    ImpersonateGuest string
    Specify the condition in which user access is done as the guest account.
    ImpersonateUser string
    User account to be used as guest account.
    InheritablePathAcl bool
    Set the inheritable ACL on the share path.
    MangleByteStart float64
    Specifies the wchar_t starting point for automatic byte mangling.
    MangleMaps []string
    Character mangle map.
    Name string
    Share name.
    NtfsAclSupport bool
    Support NTFS ACLs on files and directories.
    Oplocks bool
    Support oplocks.
    Path string
    Path of share within /ifs.
    Permissions []SmbSharePermissionArgs
    Specifies an ordered list of permission modifications.
    RunAsRoots []SmbShareRunAsRootArgs
    Allow account to run as root.
    Smb3EncryptionEnabled bool
    Enables SMB3 encryption for the share.
    SparseFile bool
    Enables sparse file.
    StrictCaLockout bool
    Specifies if persistent opens would do strict lockout on the share.
    StrictFlush bool
    Handle SMB flush operations.
    StrictLocking bool
    Specifies whether byte range locks contend against SMB I/O.
    Zid float64
    Numeric ID of the access zone which contains this SMB share.
    Zone string
    Name of the access zone to which to move this SMB share.
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion Boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory Boolean
    Automatically create home directories.
    browsable Boolean
    Share is visible in net view and the browse list.
    caTimeout Double
    Persistent open timeout for the share.
    caWriteIntegrity String
    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.
    createPath Boolean
    Create path if does not exist.
    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.
    directoryCreateMask Double
    Directory create mask bits.
    directoryCreateMode Double
    Directory create mode bits.
    fileCreateMask Double
    File create mask bits.
    fileCreateMode Double
    File create mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on this zone.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account.
    impersonateUser String
    User account to be used as guest account.
    inheritablePathAcl Boolean
    Set the inheritable ACL on the share path.
    mangleByteStart Double
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    name String
    Share name.
    ntfsAclSupport Boolean
    Support NTFS ACLs on files and directories.
    oplocks Boolean
    Support oplocks.
    path String
    Path of share within /ifs.
    permissions List<SmbSharePermission>
    Specifies an ordered list of permission modifications.
    runAsRoots List<SmbShareRunAsRoot>
    Allow account to run as root.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zid Double
    Numeric ID of the access zone which contains this SMB share.
    zone String
    Name of the access zone to which to move this SMB share.
    accessBasedEnumeration boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory boolean
    Automatically create home directories.
    browsable boolean
    Share is visible in net view and the browse list.
    caTimeout number
    Persistent open timeout for the share.
    caWriteIntegrity string
    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.
    createPath boolean
    Create path if does not exist.
    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.
    directoryCreateMask number
    Directory create mask bits.
    directoryCreateMode number
    Directory create mode bits.
    fileCreateMask number
    File create mask bits.
    fileCreateMode number
    File create mode bits.
    fileFilterExtensions string[]
    Specifies the list of file extensions.
    fileFilterType string
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled boolean
    Enables file filtering on this zone.
    hideDotFiles boolean
    Hide files and directories that begin with a period '.'.
    hostAcls string[]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest string
    Specify the condition in which user access is done as the guest account.
    impersonateUser string
    User account to be used as guest account.
    inheritablePathAcl boolean
    Set the inheritable ACL on the share path.
    mangleByteStart number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps string[]
    Character mangle map.
    name string
    Share name.
    ntfsAclSupport boolean
    Support NTFS ACLs on files and directories.
    oplocks boolean
    Support oplocks.
    path string
    Path of share within /ifs.
    permissions SmbSharePermission[]
    Specifies an ordered list of permission modifications.
    runAsRoots SmbShareRunAsRoot[]
    Allow account to run as root.
    smb3EncryptionEnabled boolean
    Enables SMB3 encryption for the share.
    sparseFile boolean
    Enables sparse file.
    strictCaLockout boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush boolean
    Handle SMB flush operations.
    strictLocking boolean
    Specifies whether byte range locks contend against SMB I/O.
    zid number
    Numeric ID of the access zone which contains this SMB share.
    zone string
    Name of the access zone to which to move this SMB share.
    access_based_enumeration bool
    Only enumerate files and folders the requesting user has access to.
    access_based_enumeration_root_only bool
    Access-based enumeration on only the root directory of the share.
    allow_delete_readonly bool
    Allow deletion of read-only files in the share.
    allow_execute_always bool
    Allows users to execute files they have read rights for.
    allow_variable_expansion bool
    Allow automatic expansion of variables for home directories.
    auto_create_directory bool
    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_integrity str
    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_path bool
    Create path if does not exist.
    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_mask float
    Directory create mask bits.
    directory_create_mode float
    Directory create mode bits.
    file_create_mask float
    File create mask bits.
    file_create_mode float
    File create mode bits.
    file_filter_extensions Sequence[str]
    Specifies the list of file extensions.
    file_filter_type str
    Specifies if filter list is for deny or allow. Default is deny.
    file_filtering_enabled bool
    Enables file filtering on this zone.
    hide_dot_files bool
    Hide files and directories that begin with a period '.'.
    host_acls Sequence[str]
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonate_guest str
    Specify the condition in which user access is done as the guest account.
    impersonate_user str
    User account to be used as guest account.
    inheritable_path_acl bool
    Set the inheritable ACL on the share path.
    mangle_byte_start float
    Specifies the wchar_t starting point for automatic byte mangling.
    mangle_maps Sequence[str]
    Character mangle map.
    name str
    Share name.
    ntfs_acl_support bool
    Support NTFS ACLs on files and directories.
    oplocks bool
    Support oplocks.
    path str
    Path of share within /ifs.
    permissions Sequence[SmbSharePermissionArgs]
    Specifies an ordered list of permission modifications.
    run_as_roots Sequence[SmbShareRunAsRootArgs]
    Allow account to run as root.
    smb3_encryption_enabled bool
    Enables SMB3 encryption for the share.
    sparse_file bool
    Enables sparse file.
    strict_ca_lockout bool
    Specifies if persistent opens would do strict lockout on the share.
    strict_flush bool
    Handle SMB flush operations.
    strict_locking bool
    Specifies whether byte range locks contend against SMB I/O.
    zid float
    Numeric ID of the access zone which contains this SMB share.
    zone str
    Name of the access zone to which to move this SMB share.
    accessBasedEnumeration Boolean
    Only enumerate files and folders the requesting user has access to.
    accessBasedEnumerationRootOnly Boolean
    Access-based enumeration on only the root directory of the share.
    allowDeleteReadonly Boolean
    Allow deletion of read-only files in the share.
    allowExecuteAlways Boolean
    Allows users to execute files they have read rights for.
    allowVariableExpansion Boolean
    Allow automatic expansion of variables for home directories.
    autoCreateDirectory Boolean
    Automatically create home directories.
    browsable Boolean
    Share is visible in net view and the browse list.
    caTimeout Number
    Persistent open timeout for the share.
    caWriteIntegrity String
    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.
    createPath Boolean
    Create path if does not exist.
    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.
    directoryCreateMask Number
    Directory create mask bits.
    directoryCreateMode Number
    Directory create mode bits.
    fileCreateMask Number
    File create mask bits.
    fileCreateMode Number
    File create mode bits.
    fileFilterExtensions List<String>
    Specifies the list of file extensions.
    fileFilterType String
    Specifies if filter list is for deny or allow. Default is deny.
    fileFilteringEnabled Boolean
    Enables file filtering on this zone.
    hideDotFiles Boolean
    Hide files and directories that begin with a period '.'.
    hostAcls List<String>
    An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
    impersonateGuest String
    Specify the condition in which user access is done as the guest account.
    impersonateUser String
    User account to be used as guest account.
    inheritablePathAcl Boolean
    Set the inheritable ACL on the share path.
    mangleByteStart Number
    Specifies the wchar_t starting point for automatic byte mangling.
    mangleMaps List<String>
    Character mangle map.
    name String
    Share name.
    ntfsAclSupport Boolean
    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.
    runAsRoots List<Property Map>
    Allow account to run as root.
    smb3EncryptionEnabled Boolean
    Enables SMB3 encryption for the share.
    sparseFile Boolean
    Enables sparse file.
    strictCaLockout Boolean
    Specifies if persistent opens would do strict lockout on the share.
    strictFlush Boolean
    Handle SMB flush operations.
    strictLocking Boolean
    Specifies whether byte range locks contend against SMB I/O.
    zid Number
    Numeric ID of the access zone which contains this SMB share.
    zone String
    Name of the access zone to which to move this SMB share.

    Supporting Types

    SmbSharePermission, SmbSharePermissionArgs

    Permission string
    Specifies the file system rights that are allowed or denied.
    PermissionType string
    Determines whether the permission is allowed or denied.
    Trustee SmbSharePermissionTrustee
    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 SmbSharePermissionTrustee
    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 SmbSharePermissionTrustee
    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 SmbSharePermissionTrustee
    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 SmbSharePermissionTrustee
    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.

    SmbSharePermissionTrustee, SmbSharePermissionTrusteeArgs

    Id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    Id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.
    id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name string
    Specifies the persona name, which must be combined with a type.
    type string
    Specifies the type of persona, which must be combined with a name.
    id str
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name str
    Specifies the persona name, which must be combined with a type.
    type str
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.

    SmbShareRunAsRoot, SmbShareRunAsRootArgs

    Id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    Id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.
    id string
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name string
    Specifies the persona name, which must be combined with a type.
    type string
    Specifies the type of persona, which must be combined with a name.
    id str
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name str
    Specifies the persona name, which must be combined with a type.
    type str
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona using security identifier, which can be 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.

    Import

    Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    Licensed under the Mozilla Public License Version 2.0 (the “License”);

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an “AS IS” BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

    The command is

    $ pulumi import powerscale:index/smbShare:SmbShare share_example [<zoneID>]:<name>

    Example 1: is Optional, defaults to System:

    $ pulumi import powerscale:index/smbShare:SmbShare share_example example_share

    Example 2:

    $ pulumi import powerscale:index/smbShare:SmbShare share_example zone_id:example_share

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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