Edit

Set-WssFolder

  • Reference
Module:
WSSCmdlets

Changes the settings of a server folder.

Syntax

Set-WssFolder
   [-Force]
   [-Folder] <Folder>
   [-NewName <String>]
   [-Description <String>]
   [-UserName <String>]
   [-GroupName <String>]
   [-Permission <Permission>]
   [-HideFolderFromRemoteAccess <Boolean>]
   [-Quota <UInt64>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-WssFolder
   [-Force]
   [-Folder] <Folder>
   [-NewName <String>]
   [-Description <String>]
   [-UserSid <String>]
   [-GroupSid <String>]
   [-Permission <Permission>]
   [-HideFolderFromRemoteAccess <Boolean>]
   [-Quota <UInt64>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-WssFolder cmdlet changes the settings of a server folder.

Examples

Example 1: Change the settings of a server folder

PS C:\>$Folder = Get-WssFolder -Name "ProjectsWest"PS C:\> Set-WssFolder -Folder $Folder -NewName "ProjectsSouthwest01" -UserName "SarahJones" -Permission Full

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 ProjectsSouthwest01, and grants the user named SarahJones full access to ProjectsSouthwest01.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the server folder.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Folder

Specifies the name of a folder.

Type:Folder
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupName

Specifies the name of a group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupSid

Specifies a security ID of a group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HideFolderFromRemoteAccess

Specifies whether to hide the folder in Remote Desktop Web Access or Web service applications.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NewName

Specifies a new name for the folder.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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
Type:Permission
Accepted values:None, ReadOnly, Full, Other, ReadPermissions
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Quota

Specifies a quota, in bytes, for the folder.

Type:UInt64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Specifies the user name of an account. The server grants the user the permission to the shared folder that you specify the Permission parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserSid

Specifies the security identifier (SID) of the user that you specify in the UserName parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.WindowsServerSolutions.Storage.Folder

Outputs

Microsoft.WindowsServerSolutions.Storage.Folder

This cmdlet generates an object that represents the modified folder.