NAME
Set-FileShare
SYNOPSIS
Modifies a file share.SYNTAX
Set-FileShare [-CimSession
] [-Description ] [-EncryptData ] [-ThrottleLimit
] -UniqueId [-Confirm] [-WhatIf] [ ] Set-FileShare [-CimSession
] [-Description ] [-EncryptData ] [-ThrottleLimit
] [-Confirm] [-WhatIf] [ ] Set-FileShare [-CimSession
] [-Description ] [-EncryptData ] [-ThrottleLimit
] -Name [-Confirm] [-WhatIf] [ ] DESCRIPTION
The Set-FileShare cmdlet modifies a file share.
PARAMETERS
-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-Description [
Specifies a description for the file share. You can use this parameter to store extra information such as notes or details about the file share. Some file shares only support a default description. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -EncryptData [
Indicates whether to enable encryption for data transmission.] This parameter does not effect on-disk (data-at-rest) encryption, which is set at the volume level.
Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false-Name
Specifies the name of the file share. Required? true Position? named Default value noneAccept 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 PowerShellr 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] -UniqueId
Specifies the unique ID of the file share. Required? true Position? named Default value noneAccept pipeline input? true (ByPropertyName)
Accept wildcard characters? false-Confirm [
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 [
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] 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
OUTPUTS
Example 1: Set a description
PS C:\>Set-FileShare -Description "This share is for use by the accounting department."
This command sets the description for a file share.Example 2: Enable encryption
PS C:\>Set-FileShare -EnableEncryption
This command enables data-in-flight encryption for the file share.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816479Debug-FileShare
Get-FileShare
New-FileShare
Remove-FileShare