powerscale.SmbShareSettings
Explore with Pulumi AI
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"});
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")
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
})
}
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",
});
});
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());
}
}
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
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 string
- The unique name of the resource.
- args SmbShareSettingsArgs
- 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 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 string
- The unique name of the resource.
- args SmbShareSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SmbShareSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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,
});
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),
})
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());
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)
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,
});
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
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 string
- Name of the access zone in which to update settings
- Access
Based boolEnumeration - Only enumerate files and folders the requesting user has access to.
- Access
Based boolEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- Allow
Delete boolReadonly - Allow deletion of read-only files in the share.
- Allow
Execute boolAlways - Allows users to execute files they have read rights for.
- Ca
Timeout double - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- Change
Notify string - 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 string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- Directory
Create doubleMask - Unix umask or mode bits.
- Directory
Create doubleMode - Unix umask or mode bits.
- File
Create doubleMask - Unix umask or mode bits.
- File
Create doubleMode - Unix umask or mode bits.
- File
Filter List<string>Extensions - Specifies the list of file extensions.
- File
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- File
Filtering boolEnabled - Enables file filtering on the share.
- Hide
Dot boolFiles - Hide files and directories that begin with a period '.'.
- Host
Acls List<string> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- Impersonate
User string - User account to be used as guest account.
- Mangle
Byte doubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps List<string> - Character mangle map.
- Ntfs
Acl boolSupport - 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.
- Smb3Encryption
Enabled bool - Enables SMB3 encryption for the share.
- Sparse
File bool - Enables sparse file.
- Strict
Ca boolLockout - Specifies if persistent opens would do strict lockout on the share.
- Strict
Flush bool - Handle SMB flush operations.
- Strict
Locking bool - Specifies whether byte range locks contend against SMB I/O.
- Zone string
- Name of the access zone in which to update settings
- Access
Based boolEnumeration - Only enumerate files and folders the requesting user has access to.
- Access
Based boolEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- Allow
Delete boolReadonly - Allow deletion of read-only files in the share.
- Allow
Execute boolAlways - Allows users to execute files they have read rights for.
- Ca
Timeout float64 - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- Change
Notify string - 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 string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- Directory
Create float64Mask - Unix umask or mode bits.
- Directory
Create float64Mode - Unix umask or mode bits.
- File
Create float64Mask - Unix umask or mode bits.
- File
Create float64Mode - Unix umask or mode bits.
- File
Filter []stringExtensions - Specifies the list of file extensions.
- File
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- File
Filtering boolEnabled - Enables file filtering on the share.
- Hide
Dot boolFiles - Hide files and directories that begin with a period '.'.
- Host
Acls []string - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- Impersonate
User string - User account to be used as guest account.
- Mangle
Byte float64Start - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps []string - Character mangle map.
- Ntfs
Acl boolSupport - 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.
- Smb3Encryption
Enabled bool - Enables SMB3 encryption for the share.
- Sparse
File bool - Enables sparse file.
- Strict
Ca boolLockout - Specifies if persistent opens would do strict lockout on the share.
- Strict
Flush bool - Handle SMB flush operations.
- Strict
Locking bool - Specifies whether byte range locks contend against SMB I/O.
- zone String
- Name of the access zone in which to update settings
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout Double - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify String - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - 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 String - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create DoubleMask - Unix umask or mode bits.
- directory
Create DoubleMode - Unix umask or mode bits.
- file
Create DoubleMask - Unix umask or mode bits.
- file
Create DoubleMode - Unix umask or mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on the share.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User String - User account to be used as guest account.
- mangle
Byte DoubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- ntfs
Acl BooleanSupport - 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.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush Boolean - Handle SMB flush operations.
- strict
Locking Boolean - Specifies whether byte range locks contend against SMB I/O.
- zone string
- Name of the access zone in which to update settings
- access
Based booleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based booleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete booleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute booleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout number - Persistent open timeout for the share.
- ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify string - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available boolean - Specify if persistent opens are allowed on the share.
- create
Permissions string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create numberMask - Unix umask or mode bits.
- directory
Create numberMode - Unix umask or mode bits.
- file
Create numberMask - Unix umask or mode bits.
- file
Create numberMode - Unix umask or mode bits.
- file
Filter string[]Extensions - Specifies the list of file extensions.
- file
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering booleanEnabled - Enables file filtering on the share.
- hide
Dot booleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls string[] - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User string - User account to be used as guest account.
- mangle
Byte numberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps string[] - Character mangle map.
- ntfs
Acl booleanSupport - 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.
- smb3Encryption
Enabled boolean - Enables SMB3 encryption for the share.
- sparse
File boolean - Enables sparse file.
- strict
Ca booleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush boolean - Handle SMB flush operations.
- strict
Locking boolean - Specifies whether byte range locks contend against SMB I/O.
- zone str
- Name of the access zone in which to update settings
- access_
based_ boolenumeration - Only enumerate files and folders the requesting user has access to.
- access_
based_ boolenumeration_ root_ only - Access-based enumeration on only the root directory of the share.
- allow_
delete_ boolreadonly - Allow deletion of read-only files in the share.
- allow_
execute_ boolalways - Allows users to execute files they have read rights for.
- ca_
timeout float - Persistent open timeout for the share.
- ca_
write_ strintegrity - 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_ floatmask - Unix umask or mode bits.
- directory_
create_ floatmode - Unix umask or mode bits.
- file_
create_ floatmask - Unix umask or mode bits.
- file_
create_ floatmode - Unix umask or mode bits.
- file_
filter_ Sequence[str]extensions - Specifies the list of file extensions.
- file_
filter_ strtype - Specifies if filter list is for deny or allow. Default is deny.
- file_
filtering_ boolenabled - Enables file filtering on the share.
- hide_
dot_ boolfiles - Hide files and directories that begin with a period '.'.
- host_
acls Sequence[str] - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- 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_ floatstart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle_
maps Sequence[str] - Character mangle map.
- ntfs_
acl_ boolsupport - 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_ boolenabled - Enables SMB3 encryption for the share.
- sparse_
file bool - Enables sparse file.
- strict_
ca_ boollockout - Specifies if persistent opens would do strict lockout on the share.
- strict_
flush bool - Handle SMB flush operations.
- strict_
locking bool - Specifies whether byte range locks contend against SMB I/O.
- zone String
- Name of the access zone in which to update settings
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout Number - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify String - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - 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 String - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create NumberMask - Unix umask or mode bits.
- directory
Create NumberMode - Unix umask or mode bits.
- file
Create NumberMask - Unix umask or mode bits.
- file
Create NumberMode - Unix umask or mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on the share.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User String - User account to be used as guest account.
- mangle
Byte NumberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- ntfs
Acl BooleanSupport - 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.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush Boolean - Handle SMB flush operations.
- strict
Locking Boolean - Specifies whether byte range locks contend against SMB I/O.
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
- 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.
- Access
Based boolEnumeration - Only enumerate files and folders the requesting user has access to.
- Access
Based boolEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- Allow
Delete boolReadonly - Allow deletion of read-only files in the share.
- Allow
Execute boolAlways - Allows users to execute files they have read rights for.
- Ca
Timeout double - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- Change
Notify string - 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 string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- Directory
Create doubleMask - Unix umask or mode bits.
- Directory
Create doubleMode - Unix umask or mode bits.
- File
Create doubleMask - Unix umask or mode bits.
- File
Create doubleMode - Unix umask or mode bits.
- File
Filter List<string>Extensions - Specifies the list of file extensions.
- File
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- File
Filtering boolEnabled - Enables file filtering on the share.
- Hide
Dot boolFiles - Hide files and directories that begin with a period '.'.
- Host
Acls List<string> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- Impersonate
User string - User account to be used as guest account.
- Mangle
Byte doubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps List<string> - Character mangle map.
- Ntfs
Acl boolSupport - 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.
- Smb3Encryption
Enabled bool - Enables SMB3 encryption for the share.
- Sparse
File bool - Enables sparse file.
- Strict
Ca boolLockout - Specifies if persistent opens would do strict lockout on the share.
- Strict
Flush bool - Handle SMB flush operations.
- Strict
Locking bool - Specifies whether byte range locks contend against SMB I/O.
- Zone string
- Name of the access zone in which to update settings
- Access
Based boolEnumeration - Only enumerate files and folders the requesting user has access to.
- Access
Based boolEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- Allow
Delete boolReadonly - Allow deletion of read-only files in the share.
- Allow
Execute boolAlways - Allows users to execute files they have read rights for.
- Ca
Timeout float64 - Persistent open timeout for the share.
- Ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- Change
Notify string - 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 string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- Directory
Create float64Mask - Unix umask or mode bits.
- Directory
Create float64Mode - Unix umask or mode bits.
- File
Create float64Mask - Unix umask or mode bits.
- File
Create float64Mode - Unix umask or mode bits.
- File
Filter []stringExtensions - Specifies the list of file extensions.
- File
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- File
Filtering boolEnabled - Enables file filtering on the share.
- Hide
Dot boolFiles - Hide files and directories that begin with a period '.'.
- Host
Acls []string - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- Impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- Impersonate
User string - User account to be used as guest account.
- Mangle
Byte float64Start - Specifies the wchar_t starting point for automatic byte mangling.
- Mangle
Maps []string - Character mangle map.
- Ntfs
Acl boolSupport - 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.
- Smb3Encryption
Enabled bool - Enables SMB3 encryption for the share.
- Sparse
File bool - Enables sparse file.
- Strict
Ca boolLockout - Specifies if persistent opens would do strict lockout on the share.
- Strict
Flush bool - Handle SMB flush operations.
- Strict
Locking bool - Specifies whether byte range locks contend against SMB I/O.
- Zone string
- Name of the access zone in which to update settings
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout Double - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify String - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - 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 String - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create DoubleMask - Unix umask or mode bits.
- directory
Create DoubleMode - Unix umask or mode bits.
- file
Create DoubleMask - Unix umask or mode bits.
- file
Create DoubleMode - Unix umask or mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on the share.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User String - User account to be used as guest account.
- mangle
Byte DoubleStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- ntfs
Acl BooleanSupport - 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.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush Boolean - Handle SMB flush operations.
- strict
Locking Boolean - Specifies whether byte range locks contend against SMB I/O.
- zone String
- Name of the access zone in which to update settings
- access
Based booleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based booleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete booleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute booleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout number - Persistent open timeout for the share.
- ca
Write stringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify string - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available boolean - Specify if persistent opens are allowed on the share.
- create
Permissions string - 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 string - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create numberMask - Unix umask or mode bits.
- directory
Create numberMode - Unix umask or mode bits.
- file
Create numberMask - Unix umask or mode bits.
- file
Create numberMode - Unix umask or mode bits.
- file
Filter string[]Extensions - Specifies the list of file extensions.
- file
Filter stringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering booleanEnabled - Enables file filtering on the share.
- hide
Dot booleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls string[] - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest string - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User string - User account to be used as guest account.
- mangle
Byte numberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps string[] - Character mangle map.
- ntfs
Acl booleanSupport - 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.
- smb3Encryption
Enabled boolean - Enables SMB3 encryption for the share.
- sparse
File boolean - Enables sparse file.
- strict
Ca booleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush boolean - Handle SMB flush operations.
- strict
Locking boolean - Specifies whether byte range locks contend against SMB I/O.
- zone string
- Name of the access zone in which to update settings
- access_
based_ boolenumeration - Only enumerate files and folders the requesting user has access to.
- access_
based_ boolenumeration_ root_ only - Access-based enumeration on only the root directory of the share.
- allow_
delete_ boolreadonly - Allow deletion of read-only files in the share.
- allow_
execute_ boolalways - Allows users to execute files they have read rights for.
- ca_
timeout float - Persistent open timeout for the share.
- ca_
write_ strintegrity - 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_ floatmask - Unix umask or mode bits.
- directory_
create_ floatmode - Unix umask or mode bits.
- file_
create_ floatmask - Unix umask or mode bits.
- file_
create_ floatmode - Unix umask or mode bits.
- file_
filter_ Sequence[str]extensions - Specifies the list of file extensions.
- file_
filter_ strtype - Specifies if filter list is for deny or allow. Default is deny.
- file_
filtering_ boolenabled - Enables file filtering on the share.
- hide_
dot_ boolfiles - Hide files and directories that begin with a period '.'.
- host_
acls Sequence[str] - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- 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_ floatstart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle_
maps Sequence[str] - Character mangle map.
- ntfs_
acl_ boolsupport - 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_ boolenabled - Enables SMB3 encryption for the share.
- sparse_
file bool - Enables sparse file.
- strict_
ca_ boollockout - Specifies if persistent opens would do strict lockout on the share.
- strict_
flush bool - Handle SMB flush operations.
- strict_
locking bool - Specifies whether byte range locks contend against SMB I/O.
- zone str
- Name of the access zone in which to update settings
- access
Based BooleanEnumeration - Only enumerate files and folders the requesting user has access to.
- access
Based BooleanEnumeration Root Only - Access-based enumeration on only the root directory of the share.
- allow
Delete BooleanReadonly - Allow deletion of read-only files in the share.
- allow
Execute BooleanAlways - Allows users to execute files they have read rights for.
- ca
Timeout Number - Persistent open timeout for the share.
- ca
Write StringIntegrity - Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
- change
Notify String - Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
- continuously
Available Boolean - Specify if persistent opens are allowed on the share.
- create
Permissions String - 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 String - Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
- directory
Create NumberMask - Unix umask or mode bits.
- directory
Create NumberMode - Unix umask or mode bits.
- file
Create NumberMask - Unix umask or mode bits.
- file
Create NumberMode - Unix umask or mode bits.
- file
Filter List<String>Extensions - Specifies the list of file extensions.
- file
Filter StringType - Specifies if filter list is for deny or allow. Default is deny.
- file
Filtering BooleanEnabled - Enables file filtering on the share.
- hide
Dot BooleanFiles - Hide files and directories that begin with a period '.'.
- host
Acls List<String> - An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
- impersonate
Guest String - Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
- impersonate
User String - User account to be used as guest account.
- mangle
Byte NumberStart - Specifies the wchar_t starting point for automatic byte mangling.
- mangle
Maps List<String> - Character mangle map.
- ntfs
Acl BooleanSupport - 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.
- smb3Encryption
Enabled Boolean - Enables SMB3 encryption for the share.
- sparse
File Boolean - Enables sparse file.
- strict
Ca BooleanLockout - Specifies if persistent opens would do strict lockout on the share.
- strict
Flush Boolean - Handle SMB flush operations.
- strict
Locking Boolean - Specifies whether byte range locks contend against SMB I/O.
- 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
$ pulumi import powerscale:index/smbShareSettings:SmbShareSettings example tfaccAccessZone
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.