Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-SmbShare

Set-SmbShare

smbshare.cdxml

Synopsis

Modifies the properties of the Server Message Block (SMB) share.

Syntax

Set-SmbShare [-AsJob] [-CachingMode] [-CATimeout] [-CimSession] [-ConcurrentUserLimit] [-ContinuouslyAvailable] [-Description] [-EncryptData] [-FolderEnumerationMode] [-Force] [-PassThru] [-SecurityDescriptor] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-SmbShare [-Name] [-ScopeName] [-AsJob] [-CachingMode] [-CATimeout] [-CimSession] [-ConcurrentUserLimit] [-ContinuouslyAvailable] [-Description] [-EncryptData] [-FolderEnumerationMode] [-Force] [-PassThru] [-SecurityDescriptor] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-SMBShare cmdlet modifies the properties of the Server Message Block (SMB) share.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CachingMode <CachingMode>

Specifies the caching mode of the offline files for the SMB share. There are five different caching modes: -- None: Prevents users from storing documents and programs offline. -- Manual: Allows users to identify the documents and programs that they want to store offline. -- Programs: Automatically stores documents and programs offline. -- Documents: Automatically stores documents offline. -- BranchCache: Enables BranchCache and manual caching of documents on the shared folder.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CATimeout <UInt32>

Specifies the continuous availability timeout of the SMB share.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ConcurrentUserLimit <UInt32>

Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. By default, new SMB shares have no limit on the number of concurrent connections.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ContinuouslyAvailable <Boolean>

Indicates that the share is continuously available.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies an optional description of the SMB share. A description of the share can be displayed by running the Get-SMBShare cmdlet. Specify an empty string to clear the current description. The description may not contain more than 256 characters.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EncryptData <Boolean>

Indicates that the SMB share is encrypted.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-FolderEnumerationMode <FolderEnumerationMode>

Specifies which files and folders in the new SMB share will be visible to the users. The acceptable values for this parameter are:  -- AccessBased: SMB will not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares. -- Unrestricted: SMB will display files and folders to a user even when the user does not have permission to access those items. The default value is Unrestricted.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of one or more SMB shares.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ScopeName <String[]>

Specifies the scope name of the SMB share.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-SecurityDescriptor <String>

Specifies the security descriptor for the SMB share in string format.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare

Notes

None

Examples

EXAMPLE 1

This example modifies the properties of an SMB share.

PS C:\>Set-SmbShare -Name VMFiles -EncryptData $true
Confirm 
Are you sure you want to perform this action? 
Performing operation 'Modify' on Target 'Contoso-SO,VMFiles'. 
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): 

EXAMPLE 2

This example modifies the properties of an SMB share without user confirmation.

PS C:\>Set-SmbShare -Name VMFiles -EncryptData $true -Force


Online Version
Get-SmbShare
New-SmbShare
Remove-SmbShare