COMMAND EVERYTHING.

Set-FileShare

Modifies a file share.

Windows Server · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft Storage reference: Modifies a file share. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-FileShare [-Description <String>] [-EncryptData <Boolean>] -UniqueId <String> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-FileShare. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / Storage · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-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.
-Confirm: Prompts you for confirmation before running the cmdlet.
-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.
-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.
-InputObject (required): Specifies the input object that is used in a pipeline command.
-Name (required): Specifies the name of the file share.
-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.
-UniqueId (required): Specifies the unique ID of the file share.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the Storage module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Set a description

Set-FileShare -Description "This share is for use by the accounting department."

This command sets the description for a file share. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/Storage/Set-FileShare.md

https://learn.microsoft.com/powershell/module/storage/set-fileshare?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer