< Back
Set-SmbShare
Post
NAME Set-SmbShare
SYNOPSIS
Modifies the properties of the SMB share.
SYNTAX
Set-SmbShare [-CachingMode {None | Manual | Documents | Programs | BranchCache | Unknown}] [-CATimeout <UInt32>] [-CimSession <CimSession[]>]
[-ConcurrentUserLimit <UInt32>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-FolderEnumerationMode {AccessBased
| Unrestricted}] [-Force] [-PassThru] [-SecurityDescriptor <String>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-SmbShare [-Name] <String[]> [[-ScopeName] <String[]>] [-CachingMode {None | Manual | Documents | Programs | BranchCache | Unknown}] [-CATimeout
<UInt32>] [-CimSession <CimSession[]>] [-ConcurrentUserLimit <UInt32>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData
<Boolean>] [-FolderEnumerationMode {AccessBased | Unrestricted}] [-Force] [-PassThru] [-SecurityDescriptor <String>] [-SmbInstance {Default | CSV}]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-SmbShare cmdlet modifies the properties of the Server Message Block (SMB) share.
PARAMETERS
-CachingMode [<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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CATimeout [<UInt32>]
Specifies the continuous availability time-out of the SMB share.
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.
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 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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ContinuouslyAvailable [<Boolean>]
Indicates whether the share is continuously available.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EncryptData [<Boolean>]
Indicates whether the SMB share is encrypted.
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 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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies the name of one or more SMB shares.
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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SmbInstance [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance>]
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
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.
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.Prompts you for confirmation before running the cmdlet.
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.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Get-SmbShare
New-SmbShare
Remove-SmbShare
SYNOPSIS
Modifies the properties of the SMB share.
SYNTAX
Set-SmbShare [-CachingMode {None | Manual | Documents | Programs | BranchCache | Unknown}] [-CATimeout <UInt32>] [-CimSession <CimSession[]>]
[-ConcurrentUserLimit <UInt32>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData <Boolean>] [-FolderEnumerationMode {AccessBased
| Unrestricted}] [-Force] [-PassThru] [-SecurityDescriptor <String>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-SmbShare [-Name] <String[]> [[-ScopeName] <String[]>] [-CachingMode {None | Manual | Documents | Programs | BranchCache | Unknown}] [-CATimeout
<UInt32>] [-CimSession <CimSession[]>] [-ConcurrentUserLimit <UInt32>] [-ContinuouslyAvailable <Boolean>] [-Description <String>] [-EncryptData
<Boolean>] [-FolderEnumerationMode {AccessBased | Unrestricted}] [-Force] [-PassThru] [-SecurityDescriptor <String>] [-SmbInstance {Default | CSV}]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-SmbShare cmdlet modifies the properties of the Server Message Block (SMB) share.
PARAMETERS
-CachingMode [<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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CATimeout [<UInt32>]
Specifies the continuous availability time-out of the SMB share.
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.
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 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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ContinuouslyAvailable [<Boolean>]
Indicates whether the share is continuously available.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EncryptData [<Boolean>]
Indicates whether the SMB share is encrypted.
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 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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies the name of one or more SMB shares.
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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SmbInstance [<Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance>]
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
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.
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.Prompts you for confirmation before running the cmdlet.
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.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Get-SmbShare
New-SmbShare
Remove-SmbShare