Skip to content

Latest commit

 

History

History
173 lines (129 loc) · 3.22 KB

File metadata and controls

173 lines (129 loc) · 3.22 KB
external help file Module Name online version schema
WSS_Cmdlets.xml
WssCmdlets
2.0.0

Remove-WssFolder

SYNOPSIS

Removes a server folder.

SYNTAX

UNNAMED_PARAMETER_SET_1

Remove-WssFolder [-DeleteContents] [-Force] -Name <String> [-Confirm] [-WhatIf]

UNNAMED_PARAMETER_SET_2

Remove-WssFolder [-DeleteContents] [-Force] -Folder <Folder> [-Confirm] [-WhatIf]

UNNAMED_PARAMETER_SET_3

Remove-WssFolder [-DeleteContents] [-Force] -ID <Guid> [-Confirm] [-WhatIf]

DESCRIPTION

The Remove-WssFolder cmdlet removes a server folder. If you specify the DeleteContents parameter, the cmdlet deletes the contents of the server folder that you specify. If you do not specify the DeleteContents parameter, the cmdlet stops sharing the contents of the server folder.

EXAMPLES

Example 1: Remove a server folder

PS C:\> Remove-WssFolder -Name "ProjectsNorth" -DeleteContents

This command removes the server folder named ProjectsNorth and deletes all the contents of the folder.

PARAMETERS

-DeleteContents

Indicates that the cmdlet deletes the contents of the server folder.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-Folder

Specifies the name of a folder.

Type: Folder
Parameter Sets: UNNAMED_PARAMETER_SET_2
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-ID

Specifies the GUID for a folder.

Type: Guid
Parameter Sets: UNNAMED_PARAMETER_SET_3
Aliases: 

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

-Name

Specifies the name of a folder.

Type: String
Parameter Sets: UNNAMED_PARAMETER_SET_1
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

INPUTS

Microsoft.WindowsServerSolutions.Storage.Folder

OUTPUTS

Microsoft.WindowsServerSolutions.Storage.Folder

NOTES

RELATED LINKS

Add-WssFolder

Get-WssFolder

Set-WssFolder

Move-WssFolder

Measure-WssFolder