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

powerscale.SmbShareSettings

Explore with Pulumi AI

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 Settings entity of PowerScale Array. We can Create, Update and Delete the SMB share Settings using this resource. We can also import the existing SMB share Settings from PowerScale array. Note that, SMB share Settings is the native functionality of PowerScale. When creating the resource, we actually load SMB share Settings from PowerScale to the resource state.

Example Usage

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

// PowerScale SMB share settings provide clients network access to file system resources on the cluster
const example = new powerscale.SmbShareSettings("example", {zone: "System"});
Copy
import pulumi
import pulumi_powerscale as powerscale

# PowerScale SMB share settings provide clients network access to file system resources on the cluster
example = powerscale.SmbShareSettings("example", zone="System")
Copy
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 share settings provide clients network access to file system resources on the cluster
		_, err := powerscale.NewSmbShareSettings(ctx, "example", &powerscale.SmbShareSettingsArgs{
			Zone: pulumi.String("System"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    // PowerScale SMB share settings provide clients network access to file system resources on the cluster
    var example = new Powerscale.SmbShareSettings("example", new()
    {
        Zone = "System",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SmbShareSettings;
import com.pulumi.powerscale.SmbShareSettingsArgs;
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 share settings provide clients network access to file system resources on the cluster
        var example = new SmbShareSettings("example", SmbShareSettingsArgs.builder()
            .zone("System")
            .build());

    }
}
Copy
resources:
  # PowerScale SMB share settings provide clients network access to file system resources on the cluster
  example:
    type: powerscale:SmbShareSettings
    properties:
      # Required field both for creating and updating
      zone: System
Copy

Create SmbShareSettings Resource

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

Constructor syntax

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

@overload
def SmbShareSettings(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     zone: Optional[str] = None,
                     file_filtering_enabled: Optional[bool] = None,
                     hide_dot_files: Optional[bool] = None,
                     allow_execute_always: 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_permissions: Optional[str] = None,
                     csc_policy: 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,
                     allow_delete_readonly: Optional[bool] = None,
                     file_filter_type: Optional[str] = None,
                     impersonate_guest: Optional[str] = None,
                     host_acls: Optional[Sequence[str]] = None,
                     access_based_enumeration: Optional[bool] = None,
                     impersonate_user: Optional[str] = None,
                     mangle_byte_start: Optional[float] = None,
                     mangle_maps: Optional[Sequence[str]] = None,
                     ntfs_acl_support: Optional[bool] = None,
                     oplocks: Optional[bool] = None,
                     scope: Optional[str] = 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,
                     access_based_enumeration_root_only: Optional[bool] = None)
func NewSmbShareSettings(ctx *Context, name string, args SmbShareSettingsArgs, opts ...ResourceOption) (*SmbShareSettings, error)
public SmbShareSettings(string name, SmbShareSettingsArgs args, CustomResourceOptions? opts = null)
public SmbShareSettings(String name, SmbShareSettingsArgs args)
public SmbShareSettings(String name, SmbShareSettingsArgs args, CustomResourceOptions options)

type: powerscale:SmbShareSettings
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. SmbShareSettingsArgs
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. SmbShareSettingsArgs
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. SmbShareSettingsArgs
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. SmbShareSettingsArgs
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. SmbShareSettingsArgs
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 smbShareSettingsResource = new Powerscale.SmbShareSettings("smbShareSettingsResource", new()
{
    Zone = "string",
    FileFilteringEnabled = false,
    HideDotFiles = false,
    AllowExecuteAlways = false,
    CaTimeout = 0,
    CaWriteIntegrity = "string",
    ChangeNotify = "string",
    ContinuouslyAvailable = false,
    CreatePermissions = "string",
    CscPolicy = "string",
    DirectoryCreateMask = 0,
    DirectoryCreateMode = 0,
    FileCreateMask = 0,
    FileCreateMode = 0,
    FileFilterExtensions = new[]
    {
        "string",
    },
    AllowDeleteReadonly = false,
    FileFilterType = "string",
    ImpersonateGuest = "string",
    HostAcls = new[]
    {
        "string",
    },
    AccessBasedEnumeration = false,
    ImpersonateUser = "string",
    MangleByteStart = 0,
    MangleMaps = new[]
    {
        "string",
    },
    NtfsAclSupport = false,
    Oplocks = false,
    Scope = "string",
    Smb3EncryptionEnabled = false,
    SparseFile = false,
    StrictCaLockout = false,
    StrictFlush = false,
    StrictLocking = false,
    AccessBasedEnumerationRootOnly = false,
});
Copy
example, err := powerscale.NewSmbShareSettings(ctx, "smbShareSettingsResource", &powerscale.SmbShareSettingsArgs{
Zone: pulumi.String("string"),
FileFilteringEnabled: pulumi.Bool(false),
HideDotFiles: pulumi.Bool(false),
AllowExecuteAlways: pulumi.Bool(false),
CaTimeout: pulumi.Float64(0),
CaWriteIntegrity: pulumi.String("string"),
ChangeNotify: pulumi.String("string"),
ContinuouslyAvailable: pulumi.Bool(false),
CreatePermissions: pulumi.String("string"),
CscPolicy: 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"),
},
AllowDeleteReadonly: pulumi.Bool(false),
FileFilterType: pulumi.String("string"),
ImpersonateGuest: pulumi.String("string"),
HostAcls: pulumi.StringArray{
pulumi.String("string"),
},
AccessBasedEnumeration: pulumi.Bool(false),
ImpersonateUser: pulumi.String("string"),
MangleByteStart: pulumi.Float64(0),
MangleMaps: pulumi.StringArray{
pulumi.String("string"),
},
NtfsAclSupport: pulumi.Bool(false),
Oplocks: pulumi.Bool(false),
Scope: pulumi.String("string"),
Smb3EncryptionEnabled: pulumi.Bool(false),
SparseFile: pulumi.Bool(false),
StrictCaLockout: pulumi.Bool(false),
StrictFlush: pulumi.Bool(false),
StrictLocking: pulumi.Bool(false),
AccessBasedEnumerationRootOnly: pulumi.Bool(false),
})
Copy
var smbShareSettingsResource = new SmbShareSettings("smbShareSettingsResource", SmbShareSettingsArgs.builder()
    .zone("string")
    .fileFilteringEnabled(false)
    .hideDotFiles(false)
    .allowExecuteAlways(false)
    .caTimeout(0)
    .caWriteIntegrity("string")
    .changeNotify("string")
    .continuouslyAvailable(false)
    .createPermissions("string")
    .cscPolicy("string")
    .directoryCreateMask(0)
    .directoryCreateMode(0)
    .fileCreateMask(0)
    .fileCreateMode(0)
    .fileFilterExtensions("string")
    .allowDeleteReadonly(false)
    .fileFilterType("string")
    .impersonateGuest("string")
    .hostAcls("string")
    .accessBasedEnumeration(false)
    .impersonateUser("string")
    .mangleByteStart(0)
    .mangleMaps("string")
    .ntfsAclSupport(false)
    .oplocks(false)
    .scope("string")
    .smb3EncryptionEnabled(false)
    .sparseFile(false)
    .strictCaLockout(false)
    .strictFlush(false)
    .strictLocking(false)
    .accessBasedEnumerationRootOnly(false)
    .build());
Copy
smb_share_settings_resource = powerscale.SmbShareSettings("smbShareSettingsResource",
    zone="string",
    file_filtering_enabled=False,
    hide_dot_files=False,
    allow_execute_always=False,
    ca_timeout=0,
    ca_write_integrity="string",
    change_notify="string",
    continuously_available=False,
    create_permissions="string",
    csc_policy="string",
    directory_create_mask=0,
    directory_create_mode=0,
    file_create_mask=0,
    file_create_mode=0,
    file_filter_extensions=["string"],
    allow_delete_readonly=False,
    file_filter_type="string",
    impersonate_guest="string",
    host_acls=["string"],
    access_based_enumeration=False,
    impersonate_user="string",
    mangle_byte_start=0,
    mangle_maps=["string"],
    ntfs_acl_support=False,
    oplocks=False,
    scope="string",
    smb3_encryption_enabled=False,
    sparse_file=False,
    strict_ca_lockout=False,
    strict_flush=False,
    strict_locking=False,
    access_based_enumeration_root_only=False)
Copy
const smbShareSettingsResource = new powerscale.SmbShareSettings("smbShareSettingsResource", {
    zone: "string",
    fileFilteringEnabled: false,
    hideDotFiles: false,
    allowExecuteAlways: false,
    caTimeout: 0,
    caWriteIntegrity: "string",
    changeNotify: "string",
    continuouslyAvailable: false,
    createPermissions: "string",
    cscPolicy: "string",
    directoryCreateMask: 0,
    directoryCreateMode: 0,
    fileCreateMask: 0,
    fileCreateMode: 0,
    fileFilterExtensions: ["string"],
    allowDeleteReadonly: false,
    fileFilterType: "string",
    impersonateGuest: "string",
    hostAcls: ["string"],
    accessBasedEnumeration: false,
    impersonateUser: "string",
    mangleByteStart: 0,
    mangleMaps: ["string"],
    ntfsAclSupport: false,
    oplocks: false,
    scope: "string",
    smb3EncryptionEnabled: false,
    sparseFile: false,
    strictCaLockout: false,
    strictFlush: false,
    strictLocking: false,
    accessBasedEnumerationRootOnly: false,
});
Copy
type: powerscale:SmbShareSettings
properties:
    accessBasedEnumeration: false
    accessBasedEnumerationRootOnly: false
    allowDeleteReadonly: false
    allowExecuteAlways: false
    caTimeout: 0
    caWriteIntegrity: string
    changeNotify: string
    continuouslyAvailable: false
    createPermissions: string
    cscPolicy: string
    directoryCreateMask: 0
    directoryCreateMode: 0
    fileCreateMask: 0
    fileCreateMode: 0
    fileFilterExtensions:
        - string
    fileFilterType: string
    fileFilteringEnabled: false
    hideDotFiles: false
    hostAcls:
        - string
    impersonateGuest: string
    impersonateUser: string
    mangleByteStart: 0
    mangleMaps:
        - string
    ntfsAclSupport: false
    oplocks: false
    scope: string
    smb3EncryptionEnabled: false
    sparseFile: false
    strictCaLockout: false
    strictFlush: false
    strictLocking: false
    zone: string
Copy

SmbShareSettings 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 SmbShareSettings resource accepts the following input properties:

Zone This property is required. string
Name of the access zone in which to update settings
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.
CaTimeout double
Persistent open timeout for the share.
CaWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
ChangeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
ContinuouslyAvailable bool
Specify if persistent opens are allowed on the share.
CreatePermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
CscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
DirectoryCreateMask double
Unix umask or mode bits.
DirectoryCreateMode double
Unix umask or mode bits.
FileCreateMask double
Unix umask or mode bits.
FileCreateMode double
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
ImpersonateUser string
User account to be used as guest account.
MangleByteStart double
Specifies the wchar_t starting point for automatic byte mangling.
MangleMaps List<string>
Character mangle map.
NtfsAclSupport bool
Support NTFS ACLs on files and directories.
Oplocks bool
Allow oplock requests.
Scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 This property is required. string
Name of the access zone in which to update settings
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.
CaTimeout float64
Persistent open timeout for the share.
CaWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
ChangeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
ContinuouslyAvailable bool
Specify if persistent opens are allowed on the share.
CreatePermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
CscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
DirectoryCreateMask float64
Unix umask or mode bits.
DirectoryCreateMode float64
Unix umask or mode bits.
FileCreateMask float64
Unix umask or mode bits.
FileCreateMode float64
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
ImpersonateUser string
User account to be used as guest account.
MangleByteStart float64
Specifies the wchar_t starting point for automatic byte mangling.
MangleMaps []string
Character mangle map.
NtfsAclSupport bool
Support NTFS ACLs on files and directories.
Oplocks bool
Allow oplock requests.
Scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 This property is required. String
Name of the access zone in which to update settings
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.
caTimeout Double
Persistent open timeout for the share.
caWriteIntegrity String
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify String
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable Boolean
Specify if persistent opens are allowed on the share.
createPermissions String
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy String
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask Double
Unix umask or mode bits.
directoryCreateMode Double
Unix umask or mode bits.
fileCreateMask Double
Unix umask or mode bits.
fileCreateMode Double
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser String
User account to be used as guest account.
mangleByteStart Double
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps List<String>
Character mangle map.
ntfsAclSupport Boolean
Support NTFS ACLs on files and directories.
oplocks Boolean
Allow oplock requests.
scope String
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 This property is required. string
Name of the access zone in which to update settings
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.
caTimeout number
Persistent open timeout for the share.
caWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable boolean
Specify if persistent opens are allowed on the share.
createPermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask number
Unix umask or mode bits.
directoryCreateMode number
Unix umask or mode bits.
fileCreateMask number
Unix umask or mode bits.
fileCreateMode number
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser string
User account to be used as guest account.
mangleByteStart number
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps string[]
Character mangle map.
ntfsAclSupport boolean
Support NTFS ACLs on files and directories.
oplocks boolean
Allow oplock requests.
scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 This property is required. str
Name of the access zone in which to update settings
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.
ca_timeout float
Persistent open timeout for the share.
ca_write_integrity str
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
change_notify str
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuously_available bool
Specify if persistent opens are allowed on the share.
create_permissions str
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
csc_policy str
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directory_create_mask float
Unix umask or mode bits.
directory_create_mode float
Unix umask or mode bits.
file_create_mask float
Unix umask or mode bits.
file_create_mode float
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonate_user str
User account to be used as guest account.
mangle_byte_start float
Specifies the wchar_t starting point for automatic byte mangling.
mangle_maps Sequence[str]
Character mangle map.
ntfs_acl_support bool
Support NTFS ACLs on files and directories.
oplocks bool
Allow oplock requests.
scope str
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 This property is required. String
Name of the access zone in which to update settings
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.
caTimeout Number
Persistent open timeout for the share.
caWriteIntegrity String
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify String
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable Boolean
Specify if persistent opens are allowed on the share.
createPermissions String
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy String
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask Number
Unix umask or mode bits.
directoryCreateMode Number
Unix umask or mode bits.
fileCreateMask Number
Unix umask or mode bits.
fileCreateMode Number
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser String
User account to be used as guest account.
mangleByteStart Number
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps List<String>
Character mangle map.
ntfsAclSupport Boolean
Support NTFS ACLs on files and directories.
oplocks Boolean
Allow oplock requests.
scope String
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the SmbShareSettings 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 SmbShareSettings Resource

Get an existing SmbShareSettings 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?: SmbShareSettingsState, opts?: CustomResourceOptions): SmbShareSettings
@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,
        ca_timeout: Optional[float] = None,
        ca_write_integrity: Optional[str] = None,
        change_notify: Optional[str] = None,
        continuously_available: Optional[bool] = None,
        create_permissions: Optional[str] = None,
        csc_policy: 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,
        mangle_byte_start: Optional[float] = None,
        mangle_maps: Optional[Sequence[str]] = None,
        ntfs_acl_support: Optional[bool] = None,
        oplocks: Optional[bool] = None,
        scope: Optional[str] = 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) -> SmbShareSettings
func GetSmbShareSettings(ctx *Context, name string, id IDInput, state *SmbShareSettingsState, opts ...ResourceOption) (*SmbShareSettings, error)
public static SmbShareSettings Get(string name, Input<string> id, SmbShareSettingsState? state, CustomResourceOptions? opts = null)
public static SmbShareSettings get(String name, Output<String> id, SmbShareSettingsState state, CustomResourceOptions options)
resources:  _:    type: powerscale:SmbShareSettings    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:
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.
CaTimeout double
Persistent open timeout for the share.
CaWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
ChangeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
ContinuouslyAvailable bool
Specify if persistent opens are allowed on the share.
CreatePermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
CscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
DirectoryCreateMask double
Unix umask or mode bits.
DirectoryCreateMode double
Unix umask or mode bits.
FileCreateMask double
Unix umask or mode bits.
FileCreateMode double
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
ImpersonateUser string
User account to be used as guest account.
MangleByteStart double
Specifies the wchar_t starting point for automatic byte mangling.
MangleMaps List<string>
Character mangle map.
NtfsAclSupport bool
Support NTFS ACLs on files and directories.
Oplocks bool
Allow oplock requests.
Scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings
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.
CaTimeout float64
Persistent open timeout for the share.
CaWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
ChangeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
ContinuouslyAvailable bool
Specify if persistent opens are allowed on the share.
CreatePermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
CscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
DirectoryCreateMask float64
Unix umask or mode bits.
DirectoryCreateMode float64
Unix umask or mode bits.
FileCreateMask float64
Unix umask or mode bits.
FileCreateMode float64
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
ImpersonateUser string
User account to be used as guest account.
MangleByteStart float64
Specifies the wchar_t starting point for automatic byte mangling.
MangleMaps []string
Character mangle map.
NtfsAclSupport bool
Support NTFS ACLs on files and directories.
Oplocks bool
Allow oplock requests.
Scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings
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.
caTimeout Double
Persistent open timeout for the share.
caWriteIntegrity String
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify String
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable Boolean
Specify if persistent opens are allowed on the share.
createPermissions String
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy String
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask Double
Unix umask or mode bits.
directoryCreateMode Double
Unix umask or mode bits.
fileCreateMask Double
Unix umask or mode bits.
fileCreateMode Double
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser String
User account to be used as guest account.
mangleByteStart Double
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps List<String>
Character mangle map.
ntfsAclSupport Boolean
Support NTFS ACLs on files and directories.
oplocks Boolean
Allow oplock requests.
scope String
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings
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.
caTimeout number
Persistent open timeout for the share.
caWriteIntegrity string
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify string
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable boolean
Specify if persistent opens are allowed on the share.
createPermissions string
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy string
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask number
Unix umask or mode bits.
directoryCreateMode number
Unix umask or mode bits.
fileCreateMask number
Unix umask or mode bits.
fileCreateMode number
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser string
User account to be used as guest account.
mangleByteStart number
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps string[]
Character mangle map.
ntfsAclSupport boolean
Support NTFS ACLs on files and directories.
oplocks boolean
Allow oplock requests.
scope string
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings
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.
ca_timeout float
Persistent open timeout for the share.
ca_write_integrity str
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
change_notify str
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuously_available bool
Specify if persistent opens are allowed on the share.
create_permissions str
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
csc_policy str
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directory_create_mask float
Unix umask or mode bits.
directory_create_mode float
Unix umask or mode bits.
file_create_mask float
Unix umask or mode bits.
file_create_mode float
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonate_user str
User account to be used as guest account.
mangle_byte_start float
Specifies the wchar_t starting point for automatic byte mangling.
mangle_maps Sequence[str]
Character mangle map.
ntfs_acl_support bool
Support NTFS ACLs on files and directories.
oplocks bool
Allow oplock requests.
scope str
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings
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.
caTimeout Number
Persistent open timeout for the share.
caWriteIntegrity String
Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
changeNotify String
Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuouslyAvailable Boolean
Specify if persistent opens are allowed on the share.
createPermissions String
Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
cscPolicy String
Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directoryCreateMask Number
Unix umask or mode bits.
directoryCreateMode Number
Unix umask or mode bits.
fileCreateMask Number
Unix umask or mode bits.
fileCreateMode Number
Unix umask or 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 the share.
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. Acceptable values: always, bad user, never
impersonateUser String
User account to be used as guest account.
mangleByteStart Number
Specifies the wchar_t starting point for automatic byte mangling.
mangleMaps List<String>
Character mangle map.
ntfsAclSupport Boolean
Support NTFS ACLs on files and directories.
oplocks Boolean
Allow oplock requests.
scope String
When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.
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 in which to update settings

Import

Copyright (c) 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/smbShareSettings:SmbShareSettings example zone
Copy
$ pulumi import powerscale:index/smbShareSettings:SmbShareSettings example tfaccAccessZone
Copy

after running this command, populate the zone 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 1.7.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerscale