COMMAND EVERYTHING.
Creates an SMB share.
Microsoft SmbShare reference: Creates an SMB 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.
Use an account with the target resource permissions documented for New-SmbShare. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Windows / SmbShare · Windows Server 2025 documentation; feature/module prerequisites apply
-AsJob- Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-CATimeout- Specifies the continuous availability time-out for the share.
-CachingMode- Specifies the caching mode of the offline files for the SMB share. There are five caching modes: - BranchCache - Enables BranchCache and manual caching of documents on the shared folder. - Documents - Automatically stores documents offline. - Manual - Allows users to identify the documents and programs that they want to store offline. - Programs - Automatically stores documents and programs offline. - None - Prevents users from storing documents and programs offline.
-ChangeAccess- Specifies which users are granted modify permission to access the share. Multiple users can be specified by using a comma-separated list. Each entry in the comma-separated list must be contained within single or double quotes, for example 'CONTOSO\Finance Users','CONTOSO\HR Users'.
-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.
-CompressData- Indicates that SMB compression is requested for all client connections that support it.
-ConcurrentUserLimit- 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. The default value is zero (0).
-Confirm- Prompts you for confirmation before running the cmdlet.
-ContinuouslyAvailable- Indicates that the share is continuously available.
-Description- Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters. The default value is no description or an empty description.
-EncryptData- Indicates that the share is encrypted.
-FolderEnumerationMode- Specifies which files and folders in the SMB share are visible to users. The acceptable values for this parameter are: - AccessBased. SMB doesn't 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 doesn't have permission to access the items. The default value is Unrestricted.
-FullAccess- Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. Each entry in the comma-separated list must be contained within single or double quotes, for example 'CONTOSO\Finance Users','CONTOSO\HR Users'. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.
-LeasingMode- Specifies SMB leasing and oplock behaviors for application compatibility. The acceptable values for this parameter are: - Full: Use default lease and oplock behaviors from SMB3. - Shared: Grant read-caching lease but not write or handle-caching. - None: No oplocks or leases, behave like SMB1 (not recommended).
-Name (required)- Specifies a name for the SMB share. The names pipe and mailslot are reserved for use by the computer. Share names can be up to a maximum of 80 characters long. The SMB share name can use any character allowed by Windows for files and directories. To learn more about naming conventions for files read the Naming Files, Paths, and Namespaces articles.
-NoAccess- Specifies which accounts are denied access to the SMB share. Multiple accounts can be specified by supplying a comma-separated list. Each entry in the comma-separated list must be contained within single or double quotes, for example 'CONTOSO\Finance Users','CONTOSO\HR Users'.
-Path (required)- Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters aren't permitted.
-ReadAccess- Specifies which users are granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list. Each entry in the comma-separated list must be contained within single or double quotes, for example 'CONTOSO\Finance Users','CONTOSO\HR Users'.
-ScopeName- Specifies the scope name of the share. For use with Windows Server failover cluster file server resources.
-SecurityDescriptor- Specifies the security descriptor for the SMB share in string format.
-Temporary- Specifies the new SMB share is temporary and will not persist beyond the next restart of the computer. By default, new SMB shares aren't temporary.
-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.
-WhatIf- Shows what would happen if the cmdlet runs. The cmdlet isn't run. > [!NOTE] > The WhatIf switch doesn't work with this cmdlet.
Windows with the SmbShare module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
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.