Set-WssFolder
Set-WssFolder
Changes the settings of a server folder.
Syntax
Parameter Set: ByNameParamSet
Set-WssFolder [-Folder] <Folder> [-Description <String> ] [-Force] [-HideFolderFromRemoteAccess <Boolean> ] [-NewName <String> ] [-Permission <Permission> {None | ReadOnly | Full | Other} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: BySidParamSet
Set-WssFolder [-Folder] <Folder> [-Description <String> ] [-Force] [-HideFolderFromRemoteAccess <Boolean> ] [-NewName <String> ] [-Permission <Permission> {None | ReadOnly | Full | Other} ] [-UserSid <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-WssFolder cmdlet changes the settings of a server folder.
Parameters
-Description<String>
Specifies a description for the server folder.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Folder<Folder>
Specifies the name of a folder.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HideFolderFromRemoteAccess<Boolean>
Specifies whether to hide the folder in Remote Desktop Web Access or Web service applications.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies a new name for the folder.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Permission<Permission>
Specifies the access to the shared folder that the server grants to the user that you specify in the UserName parameter. The acceptable values for this parameter are:
-- None
-- Readonly
-- Full
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserName<String>
Specifies the user name of an account. The server grants the user the permission to the shared folder that you specify the Permission parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserSid<String>
Specifies the security identifier (SID) of the user that you specify in the UserName parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
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.
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.WindowsServerSolutions.Storage.Folder
Examples
Example 1: Change the settings of a server folder
The first command gets the folder named ProjectsWest and stores it in the $Folder variable.
The second command changes the name of the folder stored in the $Folder variable to ProjectsSoutwest01, and grants the user named SarahJones full access to ProjectsSoutwest01.
PS C:\> $Folder = Get-WssFolder -Name "ProjectsWest"
PS C:\> Set-WssFolder -Folder $Folder -NewName "ProjectsSoutwest01" -UserName "SarahJones" -Permission Full