Set-Smb Share

Module:
smbshare
Modifies the properties of the SMB share.

Syntax 

Set-SmbShare
   [-Name] <String[]>
   [[-ScopeName] <String[]>]
   [-SmbInstance <SmbInstance>]
   [-Description <String>]
   [-ConcurrentUserLimit <UInt32>]
   [-CATimeout <UInt32>]
   [-ContinuouslyAvailable <Boolean>]
   [-FolderEnumerationMode <FolderEnumerationMode>]
   [-CachingMode <CachingMode>]
   [-SecurityDescriptor <String>]
   [-EncryptData <Boolean>]
   [-Force]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SmbShare
   -InputObject <CimInstance[]>
   [-Description <String>]
   [-ConcurrentUserLimit <UInt32>]
   [-CATimeout <UInt32>]
   [-ContinuouslyAvailable <Boolean>]
   [-FolderEnumerationMode <FolderEnumerationMode>]
   [-CachingMode <CachingMode>]
   [-SecurityDescriptor <String>]
   [-EncryptData <Boolean>]
   [-Force]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Modify 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"):

This command modifies the properties of an SMB share.

Example 2: Modify properties of an SMB share without confirmation 

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

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

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name

Specifies the name of one or more SMB shares.

Type: String[]
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CATimeout

Specifies the continuous availability time-out of the SMB share.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-CachingMode

Specifies the caching mode of the offline files for the SMB share. There are five 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.
Type: CachingMode
Parameter Sets: None, Manual, Documents, Programs, BranchCache, Unknown
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ConcurrentUserLimit

Specifies the maximum number of concurrently connected users that the 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.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ContinuouslyAvailable

Indicates whether the share is continuously available.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Description

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-EncryptData

Indicates whether the SMB share is encrypted.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-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 does 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 displays files and folders to a user even when the user does not have permission to access those items.

The default value is Unrestricted.

Type: FolderEnumerationMode
Parameter Sets: AccessBased, Unrestricted
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

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

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScopeName

Specifies the scope name of the SMB share.

Type: String[]
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SecurityDescriptor

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

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SmbInstance

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

Type: SmbInstance
Parameter Sets: Default, CSV, SBL, SR
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

Outputs

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

This cmdlet returns a MSFT_SmbShare object that represents the modified share.