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

powerscale.SmbServerSettings

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

Example Usage

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

// PowerScale SMB server settings allow you to configure SMB server settings on PowerScale.
const example = new powerscale.SmbServerSettings("example", {scope: "effective"});
Copy
import pulumi
import pulumi_powerscale as powerscale

# PowerScale SMB server settings allow you to configure SMB server settings on PowerScale.
example = powerscale.SmbServerSettings("example", scope="effective")
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 server settings allow you to configure SMB server settings on PowerScale.
		_, err := powerscale.NewSmbServerSettings(ctx, "example", &powerscale.SmbServerSettingsArgs{
			Scope: pulumi.String("effective"),
		})
		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 server settings allow you to configure SMB server settings on PowerScale.
    var example = new Powerscale.SmbServerSettings("example", new()
    {
        Scope = "effective",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SmbServerSettings;
import com.pulumi.powerscale.SmbServerSettingsArgs;
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 server settings allow you to configure SMB server settings on PowerScale.
        var example = new SmbServerSettings("example", SmbServerSettingsArgs.builder()
            .scope("effective")
            .build());

    }
}
Copy
resources:
  # PowerScale SMB server settings allow you to configure SMB server settings on PowerScale.
  example:
    type: powerscale:SmbServerSettings
    properties:
      # Optional fields both for creating and updating
      scope: effective
Copy

Create SmbServerSettings Resource

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

Constructor syntax

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

@overload
def SmbServerSettings(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      access_based_share_enum: Optional[bool] = None,
                      audit_fileshare: Optional[str] = None,
                      audit_logon: Optional[str] = None,
                      dot_snap_accessible_child: Optional[bool] = None,
                      dot_snap_accessible_root: Optional[bool] = None,
                      dot_snap_visible_child: Optional[bool] = None,
                      dot_snap_visible_root: Optional[bool] = None,
                      enable_security_signatures: Optional[bool] = None,
                      guest_user: Optional[str] = None,
                      ignore_eas: Optional[bool] = None,
                      onefs_cpu_multiplier: Optional[float] = None,
                      onefs_num_workers: Optional[float] = None,
                      reject_unencrypted_access: Optional[bool] = None,
                      require_security_signatures: Optional[bool] = None,
                      scope: Optional[str] = None,
                      server_side_copy: Optional[bool] = None,
                      server_string: Optional[str] = None,
                      service: Optional[bool] = None,
                      srv_cpu_multiplier: Optional[float] = None,
                      srv_num_workers: Optional[float] = None,
                      support_multichannel: Optional[bool] = None,
                      support_netbios: Optional[bool] = None,
                      support_smb2: Optional[bool] = None,
                      support_smb3_encryption: Optional[bool] = None)
func NewSmbServerSettings(ctx *Context, name string, args *SmbServerSettingsArgs, opts ...ResourceOption) (*SmbServerSettings, error)
public SmbServerSettings(string name, SmbServerSettingsArgs? args = null, CustomResourceOptions? opts = null)
public SmbServerSettings(String name, SmbServerSettingsArgs args)
public SmbServerSettings(String name, SmbServerSettingsArgs args, CustomResourceOptions options)

type: powerscale:SmbServerSettings
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 SmbServerSettingsArgs
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 SmbServerSettingsArgs
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 SmbServerSettingsArgs
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 SmbServerSettingsArgs
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. SmbServerSettingsArgs
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 smbServerSettingsResource = new Powerscale.SmbServerSettings("smbServerSettingsResource", new()
{
    AccessBasedShareEnum = false,
    AuditFileshare = "string",
    AuditLogon = "string",
    DotSnapAccessibleChild = false,
    DotSnapAccessibleRoot = false,
    DotSnapVisibleChild = false,
    DotSnapVisibleRoot = false,
    EnableSecuritySignatures = false,
    GuestUser = "string",
    IgnoreEas = false,
    OnefsCpuMultiplier = 0,
    OnefsNumWorkers = 0,
    RejectUnencryptedAccess = false,
    RequireSecuritySignatures = false,
    Scope = "string",
    ServerSideCopy = false,
    ServerString = "string",
    Service = false,
    SrvCpuMultiplier = 0,
    SrvNumWorkers = 0,
    SupportMultichannel = false,
    SupportNetbios = false,
    SupportSmb2 = false,
    SupportSmb3Encryption = false,
});
Copy
example, err := powerscale.NewSmbServerSettings(ctx, "smbServerSettingsResource", &powerscale.SmbServerSettingsArgs{
AccessBasedShareEnum: pulumi.Bool(false),
AuditFileshare: pulumi.String("string"),
AuditLogon: pulumi.String("string"),
DotSnapAccessibleChild: pulumi.Bool(false),
DotSnapAccessibleRoot: pulumi.Bool(false),
DotSnapVisibleChild: pulumi.Bool(false),
DotSnapVisibleRoot: pulumi.Bool(false),
EnableSecuritySignatures: pulumi.Bool(false),
GuestUser: pulumi.String("string"),
IgnoreEas: pulumi.Bool(false),
OnefsCpuMultiplier: pulumi.Float64(0),
OnefsNumWorkers: pulumi.Float64(0),
RejectUnencryptedAccess: pulumi.Bool(false),
RequireSecuritySignatures: pulumi.Bool(false),
Scope: pulumi.String("string"),
ServerSideCopy: pulumi.Bool(false),
ServerString: pulumi.String("string"),
Service: pulumi.Bool(false),
SrvCpuMultiplier: pulumi.Float64(0),
SrvNumWorkers: pulumi.Float64(0),
SupportMultichannel: pulumi.Bool(false),
SupportNetbios: pulumi.Bool(false),
SupportSmb2: pulumi.Bool(false),
SupportSmb3Encryption: pulumi.Bool(false),
})
Copy
var smbServerSettingsResource = new SmbServerSettings("smbServerSettingsResource", SmbServerSettingsArgs.builder()
    .accessBasedShareEnum(false)
    .auditFileshare("string")
    .auditLogon("string")
    .dotSnapAccessibleChild(false)
    .dotSnapAccessibleRoot(false)
    .dotSnapVisibleChild(false)
    .dotSnapVisibleRoot(false)
    .enableSecuritySignatures(false)
    .guestUser("string")
    .ignoreEas(false)
    .onefsCpuMultiplier(0)
    .onefsNumWorkers(0)
    .rejectUnencryptedAccess(false)
    .requireSecuritySignatures(false)
    .scope("string")
    .serverSideCopy(false)
    .serverString("string")
    .service(false)
    .srvCpuMultiplier(0)
    .srvNumWorkers(0)
    .supportMultichannel(false)
    .supportNetbios(false)
    .supportSmb2(false)
    .supportSmb3Encryption(false)
    .build());
Copy
smb_server_settings_resource = powerscale.SmbServerSettings("smbServerSettingsResource",
    access_based_share_enum=False,
    audit_fileshare="string",
    audit_logon="string",
    dot_snap_accessible_child=False,
    dot_snap_accessible_root=False,
    dot_snap_visible_child=False,
    dot_snap_visible_root=False,
    enable_security_signatures=False,
    guest_user="string",
    ignore_eas=False,
    onefs_cpu_multiplier=0,
    onefs_num_workers=0,
    reject_unencrypted_access=False,
    require_security_signatures=False,
    scope="string",
    server_side_copy=False,
    server_string="string",
    service=False,
    srv_cpu_multiplier=0,
    srv_num_workers=0,
    support_multichannel=False,
    support_netbios=False,
    support_smb2=False,
    support_smb3_encryption=False)
Copy
const smbServerSettingsResource = new powerscale.SmbServerSettings("smbServerSettingsResource", {
    accessBasedShareEnum: false,
    auditFileshare: "string",
    auditLogon: "string",
    dotSnapAccessibleChild: false,
    dotSnapAccessibleRoot: false,
    dotSnapVisibleChild: false,
    dotSnapVisibleRoot: false,
    enableSecuritySignatures: false,
    guestUser: "string",
    ignoreEas: false,
    onefsCpuMultiplier: 0,
    onefsNumWorkers: 0,
    rejectUnencryptedAccess: false,
    requireSecuritySignatures: false,
    scope: "string",
    serverSideCopy: false,
    serverString: "string",
    service: false,
    srvCpuMultiplier: 0,
    srvNumWorkers: 0,
    supportMultichannel: false,
    supportNetbios: false,
    supportSmb2: false,
    supportSmb3Encryption: false,
});
Copy
type: powerscale:SmbServerSettings
properties:
    accessBasedShareEnum: false
    auditFileshare: string
    auditLogon: string
    dotSnapAccessibleChild: false
    dotSnapAccessibleRoot: false
    dotSnapVisibleChild: false
    dotSnapVisibleRoot: false
    enableSecuritySignatures: false
    guestUser: string
    ignoreEas: false
    onefsCpuMultiplier: 0
    onefsNumWorkers: 0
    rejectUnencryptedAccess: false
    requireSecuritySignatures: false
    scope: string
    serverSideCopy: false
    serverString: string
    service: false
    srvCpuMultiplier: 0
    srvNumWorkers: 0
    supportMultichannel: false
    supportNetbios: false
    supportSmb2: false
    supportSmb3Encryption: false
Copy

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

AccessBasedShareEnum bool
Only enumerate files and folders the requesting user has access to.
AuditFileshare string
Specify level of file share audit events to log.
AuditLogon string
Specify the level of logon audit events to log.
DotSnapAccessibleChild bool
Allow access to .snapshot directories in share subdirectories.
DotSnapAccessibleRoot bool
Allow access to the .snapshot directory in the root of the share.
DotSnapVisibleChild bool
Show .snapshot directories in share subdirectories.
DotSnapVisibleRoot bool
Show the .snapshot directory in the root of a share.
EnableSecuritySignatures bool
Indicates whether the server supports signed SMB packets.
GuestUser string
Specifies the fully-qualified user to use for guest access.
IgnoreEas bool
Specify whether to ignore EAs on files.
OnefsCpuMultiplier double
Specify the number of OneFS driver worker threads per CPU.
OnefsNumWorkers double
Set the maximum number of OneFS driver worker threads.
RejectUnencryptedAccess bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
RequireSecuritySignatures bool
Indicates whether the server requires signed SMB packets.
Scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
ServerSideCopy bool
Enable Server Side Copy.
ServerString string
Provides a description of the server.
Service bool
Specify whether service is enabled.
SrvCpuMultiplier double
Specify the number of SRV service worker threads per CPU.
SrvNumWorkers double
Set the maximum number of SRV service worker threads.
SupportMultichannel bool
Support multichannel.
SupportNetbios bool
Support NetBIOS.
SupportSmb2 bool
Support the SMB2 protocol on the server.
SupportSmb3Encryption bool
Support the SMB3 encryption on the server.
AccessBasedShareEnum bool
Only enumerate files and folders the requesting user has access to.
AuditFileshare string
Specify level of file share audit events to log.
AuditLogon string
Specify the level of logon audit events to log.
DotSnapAccessibleChild bool
Allow access to .snapshot directories in share subdirectories.
DotSnapAccessibleRoot bool
Allow access to the .snapshot directory in the root of the share.
DotSnapVisibleChild bool
Show .snapshot directories in share subdirectories.
DotSnapVisibleRoot bool
Show the .snapshot directory in the root of a share.
EnableSecuritySignatures bool
Indicates whether the server supports signed SMB packets.
GuestUser string
Specifies the fully-qualified user to use for guest access.
IgnoreEas bool
Specify whether to ignore EAs on files.
OnefsCpuMultiplier float64
Specify the number of OneFS driver worker threads per CPU.
OnefsNumWorkers float64
Set the maximum number of OneFS driver worker threads.
RejectUnencryptedAccess bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
RequireSecuritySignatures bool
Indicates whether the server requires signed SMB packets.
Scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
ServerSideCopy bool
Enable Server Side Copy.
ServerString string
Provides a description of the server.
Service bool
Specify whether service is enabled.
SrvCpuMultiplier float64
Specify the number of SRV service worker threads per CPU.
SrvNumWorkers float64
Set the maximum number of SRV service worker threads.
SupportMultichannel bool
Support multichannel.
SupportNetbios bool
Support NetBIOS.
SupportSmb2 bool
Support the SMB2 protocol on the server.
SupportSmb3Encryption bool
Support the SMB3 encryption on the server.
accessBasedShareEnum Boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare String
Specify level of file share audit events to log.
auditLogon String
Specify the level of logon audit events to log.
dotSnapAccessibleChild Boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot Boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild Boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot Boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures Boolean
Indicates whether the server supports signed SMB packets.
guestUser String
Specifies the fully-qualified user to use for guest access.
ignoreEas Boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier Double
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers Double
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess Boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures Boolean
Indicates whether the server requires signed SMB packets.
scope String
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy Boolean
Enable Server Side Copy.
serverString String
Provides a description of the server.
service Boolean
Specify whether service is enabled.
srvCpuMultiplier Double
Specify the number of SRV service worker threads per CPU.
srvNumWorkers Double
Set the maximum number of SRV service worker threads.
supportMultichannel Boolean
Support multichannel.
supportNetbios Boolean
Support NetBIOS.
supportSmb2 Boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption Boolean
Support the SMB3 encryption on the server.
accessBasedShareEnum boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare string
Specify level of file share audit events to log.
auditLogon string
Specify the level of logon audit events to log.
dotSnapAccessibleChild boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures boolean
Indicates whether the server supports signed SMB packets.
guestUser string
Specifies the fully-qualified user to use for guest access.
ignoreEas boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier number
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers number
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures boolean
Indicates whether the server requires signed SMB packets.
scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy boolean
Enable Server Side Copy.
serverString string
Provides a description of the server.
service boolean
Specify whether service is enabled.
srvCpuMultiplier number
Specify the number of SRV service worker threads per CPU.
srvNumWorkers number
Set the maximum number of SRV service worker threads.
supportMultichannel boolean
Support multichannel.
supportNetbios boolean
Support NetBIOS.
supportSmb2 boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption boolean
Support the SMB3 encryption on the server.
access_based_share_enum bool
Only enumerate files and folders the requesting user has access to.
audit_fileshare str
Specify level of file share audit events to log.
audit_logon str
Specify the level of logon audit events to log.
dot_snap_accessible_child bool
Allow access to .snapshot directories in share subdirectories.
dot_snap_accessible_root bool
Allow access to the .snapshot directory in the root of the share.
dot_snap_visible_child bool
Show .snapshot directories in share subdirectories.
dot_snap_visible_root bool
Show the .snapshot directory in the root of a share.
enable_security_signatures bool
Indicates whether the server supports signed SMB packets.
guest_user str
Specifies the fully-qualified user to use for guest access.
ignore_eas bool
Specify whether to ignore EAs on files.
onefs_cpu_multiplier float
Specify the number of OneFS driver worker threads per CPU.
onefs_num_workers float
Set the maximum number of OneFS driver worker threads.
reject_unencrypted_access bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
require_security_signatures bool
Indicates whether the server requires signed SMB packets.
scope str
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
server_side_copy bool
Enable Server Side Copy.
server_string str
Provides a description of the server.
service bool
Specify whether service is enabled.
srv_cpu_multiplier float
Specify the number of SRV service worker threads per CPU.
srv_num_workers float
Set the maximum number of SRV service worker threads.
support_multichannel bool
Support multichannel.
support_netbios bool
Support NetBIOS.
support_smb2 bool
Support the SMB2 protocol on the server.
support_smb3_encryption bool
Support the SMB3 encryption on the server.
accessBasedShareEnum Boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare String
Specify level of file share audit events to log.
auditLogon String
Specify the level of logon audit events to log.
dotSnapAccessibleChild Boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot Boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild Boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot Boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures Boolean
Indicates whether the server supports signed SMB packets.
guestUser String
Specifies the fully-qualified user to use for guest access.
ignoreEas Boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier Number
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers Number
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess Boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures Boolean
Indicates whether the server requires signed SMB packets.
scope String
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy Boolean
Enable Server Side Copy.
serverString String
Provides a description of the server.
service Boolean
Specify whether service is enabled.
srvCpuMultiplier Number
Specify the number of SRV service worker threads per CPU.
srvNumWorkers Number
Set the maximum number of SRV service worker threads.
supportMultichannel Boolean
Support multichannel.
supportNetbios Boolean
Support NetBIOS.
supportSmb2 Boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption Boolean
Support the SMB3 encryption on the server.

Outputs

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

Get an existing SmbServerSettings 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?: SmbServerSettingsState, opts?: CustomResourceOptions): SmbServerSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_based_share_enum: Optional[bool] = None,
        audit_fileshare: Optional[str] = None,
        audit_logon: Optional[str] = None,
        dot_snap_accessible_child: Optional[bool] = None,
        dot_snap_accessible_root: Optional[bool] = None,
        dot_snap_visible_child: Optional[bool] = None,
        dot_snap_visible_root: Optional[bool] = None,
        enable_security_signatures: Optional[bool] = None,
        guest_user: Optional[str] = None,
        ignore_eas: Optional[bool] = None,
        onefs_cpu_multiplier: Optional[float] = None,
        onefs_num_workers: Optional[float] = None,
        reject_unencrypted_access: Optional[bool] = None,
        require_security_signatures: Optional[bool] = None,
        scope: Optional[str] = None,
        server_side_copy: Optional[bool] = None,
        server_string: Optional[str] = None,
        service: Optional[bool] = None,
        srv_cpu_multiplier: Optional[float] = None,
        srv_num_workers: Optional[float] = None,
        support_multichannel: Optional[bool] = None,
        support_netbios: Optional[bool] = None,
        support_smb2: Optional[bool] = None,
        support_smb3_encryption: Optional[bool] = None) -> SmbServerSettings
func GetSmbServerSettings(ctx *Context, name string, id IDInput, state *SmbServerSettingsState, opts ...ResourceOption) (*SmbServerSettings, error)
public static SmbServerSettings Get(string name, Input<string> id, SmbServerSettingsState? state, CustomResourceOptions? opts = null)
public static SmbServerSettings get(String name, Output<String> id, SmbServerSettingsState state, CustomResourceOptions options)
resources:  _:    type: powerscale:SmbServerSettings    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:
AccessBasedShareEnum bool
Only enumerate files and folders the requesting user has access to.
AuditFileshare string
Specify level of file share audit events to log.
AuditLogon string
Specify the level of logon audit events to log.
DotSnapAccessibleChild bool
Allow access to .snapshot directories in share subdirectories.
DotSnapAccessibleRoot bool
Allow access to the .snapshot directory in the root of the share.
DotSnapVisibleChild bool
Show .snapshot directories in share subdirectories.
DotSnapVisibleRoot bool
Show the .snapshot directory in the root of a share.
EnableSecuritySignatures bool
Indicates whether the server supports signed SMB packets.
GuestUser string
Specifies the fully-qualified user to use for guest access.
IgnoreEas bool
Specify whether to ignore EAs on files.
OnefsCpuMultiplier double
Specify the number of OneFS driver worker threads per CPU.
OnefsNumWorkers double
Set the maximum number of OneFS driver worker threads.
RejectUnencryptedAccess bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
RequireSecuritySignatures bool
Indicates whether the server requires signed SMB packets.
Scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
ServerSideCopy bool
Enable Server Side Copy.
ServerString string
Provides a description of the server.
Service bool
Specify whether service is enabled.
SrvCpuMultiplier double
Specify the number of SRV service worker threads per CPU.
SrvNumWorkers double
Set the maximum number of SRV service worker threads.
SupportMultichannel bool
Support multichannel.
SupportNetbios bool
Support NetBIOS.
SupportSmb2 bool
Support the SMB2 protocol on the server.
SupportSmb3Encryption bool
Support the SMB3 encryption on the server.
AccessBasedShareEnum bool
Only enumerate files and folders the requesting user has access to.
AuditFileshare string
Specify level of file share audit events to log.
AuditLogon string
Specify the level of logon audit events to log.
DotSnapAccessibleChild bool
Allow access to .snapshot directories in share subdirectories.
DotSnapAccessibleRoot bool
Allow access to the .snapshot directory in the root of the share.
DotSnapVisibleChild bool
Show .snapshot directories in share subdirectories.
DotSnapVisibleRoot bool
Show the .snapshot directory in the root of a share.
EnableSecuritySignatures bool
Indicates whether the server supports signed SMB packets.
GuestUser string
Specifies the fully-qualified user to use for guest access.
IgnoreEas bool
Specify whether to ignore EAs on files.
OnefsCpuMultiplier float64
Specify the number of OneFS driver worker threads per CPU.
OnefsNumWorkers float64
Set the maximum number of OneFS driver worker threads.
RejectUnencryptedAccess bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
RequireSecuritySignatures bool
Indicates whether the server requires signed SMB packets.
Scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
ServerSideCopy bool
Enable Server Side Copy.
ServerString string
Provides a description of the server.
Service bool
Specify whether service is enabled.
SrvCpuMultiplier float64
Specify the number of SRV service worker threads per CPU.
SrvNumWorkers float64
Set the maximum number of SRV service worker threads.
SupportMultichannel bool
Support multichannel.
SupportNetbios bool
Support NetBIOS.
SupportSmb2 bool
Support the SMB2 protocol on the server.
SupportSmb3Encryption bool
Support the SMB3 encryption on the server.
accessBasedShareEnum Boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare String
Specify level of file share audit events to log.
auditLogon String
Specify the level of logon audit events to log.
dotSnapAccessibleChild Boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot Boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild Boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot Boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures Boolean
Indicates whether the server supports signed SMB packets.
guestUser String
Specifies the fully-qualified user to use for guest access.
ignoreEas Boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier Double
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers Double
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess Boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures Boolean
Indicates whether the server requires signed SMB packets.
scope String
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy Boolean
Enable Server Side Copy.
serverString String
Provides a description of the server.
service Boolean
Specify whether service is enabled.
srvCpuMultiplier Double
Specify the number of SRV service worker threads per CPU.
srvNumWorkers Double
Set the maximum number of SRV service worker threads.
supportMultichannel Boolean
Support multichannel.
supportNetbios Boolean
Support NetBIOS.
supportSmb2 Boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption Boolean
Support the SMB3 encryption on the server.
accessBasedShareEnum boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare string
Specify level of file share audit events to log.
auditLogon string
Specify the level of logon audit events to log.
dotSnapAccessibleChild boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures boolean
Indicates whether the server supports signed SMB packets.
guestUser string
Specifies the fully-qualified user to use for guest access.
ignoreEas boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier number
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers number
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures boolean
Indicates whether the server requires signed SMB packets.
scope string
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy boolean
Enable Server Side Copy.
serverString string
Provides a description of the server.
service boolean
Specify whether service is enabled.
srvCpuMultiplier number
Specify the number of SRV service worker threads per CPU.
srvNumWorkers number
Set the maximum number of SRV service worker threads.
supportMultichannel boolean
Support multichannel.
supportNetbios boolean
Support NetBIOS.
supportSmb2 boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption boolean
Support the SMB3 encryption on the server.
access_based_share_enum bool
Only enumerate files and folders the requesting user has access to.
audit_fileshare str
Specify level of file share audit events to log.
audit_logon str
Specify the level of logon audit events to log.
dot_snap_accessible_child bool
Allow access to .snapshot directories in share subdirectories.
dot_snap_accessible_root bool
Allow access to the .snapshot directory in the root of the share.
dot_snap_visible_child bool
Show .snapshot directories in share subdirectories.
dot_snap_visible_root bool
Show the .snapshot directory in the root of a share.
enable_security_signatures bool
Indicates whether the server supports signed SMB packets.
guest_user str
Specifies the fully-qualified user to use for guest access.
ignore_eas bool
Specify whether to ignore EAs on files.
onefs_cpu_multiplier float
Specify the number of OneFS driver worker threads per CPU.
onefs_num_workers float
Set the maximum number of OneFS driver worker threads.
reject_unencrypted_access bool
If SMB3 encryption is enabled, reject unencrypted access from clients.
require_security_signatures bool
Indicates whether the server requires signed SMB packets.
scope str
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
server_side_copy bool
Enable Server Side Copy.
server_string str
Provides a description of the server.
service bool
Specify whether service is enabled.
srv_cpu_multiplier float
Specify the number of SRV service worker threads per CPU.
srv_num_workers float
Set the maximum number of SRV service worker threads.
support_multichannel bool
Support multichannel.
support_netbios bool
Support NetBIOS.
support_smb2 bool
Support the SMB2 protocol on the server.
support_smb3_encryption bool
Support the SMB3 encryption on the server.
accessBasedShareEnum Boolean
Only enumerate files and folders the requesting user has access to.
auditFileshare String
Specify level of file share audit events to log.
auditLogon String
Specify the level of logon audit events to log.
dotSnapAccessibleChild Boolean
Allow access to .snapshot directories in share subdirectories.
dotSnapAccessibleRoot Boolean
Allow access to the .snapshot directory in the root of the share.
dotSnapVisibleChild Boolean
Show .snapshot directories in share subdirectories.
dotSnapVisibleRoot Boolean
Show the .snapshot directory in the root of a share.
enableSecuritySignatures Boolean
Indicates whether the server supports signed SMB packets.
guestUser String
Specifies the fully-qualified user to use for guest access.
ignoreEas Boolean
Specify whether to ignore EAs on files.
onefsCpuMultiplier Number
Specify the number of OneFS driver worker threads per CPU.
onefsNumWorkers Number
Set the maximum number of OneFS driver worker threads.
rejectUnencryptedAccess Boolean
If SMB3 encryption is enabled, reject unencrypted access from clients.
requireSecuritySignatures Boolean
Indicates whether the server requires signed SMB packets.
scope String
If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
serverSideCopy Boolean
Enable Server Side Copy.
serverString String
Provides a description of the server.
service Boolean
Specify whether service is enabled.
srvCpuMultiplier Number
Specify the number of SRV service worker threads per CPU.
srvNumWorkers Number
Set the maximum number of SRV service worker threads.
supportMultichannel Boolean
Support multichannel.
supportNetbios Boolean
Support NetBIOS.
supportSmb2 Boolean
Support the SMB2 protocol on the server.
supportSmb3Encryption Boolean
Support the SMB3 encryption on the server.

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/smbServerSettings:SmbServerSettings example scope
Copy

Example:

$ pulumi import powerscale:index/smbServerSettings:SmbServerSettings example effective
Copy

after running this command, populate the scope 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