Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Clear-WebConfiguration

Last Updated: 3/8/2017

SYNOPSIS

Removes configuration settings from a configuration location.

SYNTAX

Clear-WebConfiguration [-Clr <String>] [-Force] [-Location <String[]>] [-Filter] <String[]>
 [[-PSPath] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Clear-WebConfiguration cmdlet removes configuration settings from the specified configuration location.

EXAMPLES

Example 1: Remove ASP configuration on the root node

C:\PS> Clear-WebConfiguration -Filter "/system.webServer/asp" -PSPath "IIS:\"

This command removes the <asp> section from the root node.

Example 2: Remove a configuration property from the root node

C:\PS> Clear-WebConfiguration -Filter "/system.webServer/asp/@lcid" -PSPath "IIS:\"

This command removes the lcid property from the IIS configuration root node.

Example 3: Remove ASP configuration from the site node

IIS:\> Clear-WebConfiguration -Filter "/system.webServer/asp" -PSPath "IIS:\sites\Default Web Site"

This command removes the <asp> section from the IIS configuration node for the default website.

PARAMETERS

-Clr

Specifies the version of the .NET Framework in the form vn.n, such as v4.0 or v2.0. The default is v4.0. Specify this parameter only when the PSPath parameter is set to either Machine or Machine/Webroot. If PSPath is not set to one of these values and the Clr parameter is set, Windows PowerShell® ignores the value of Clr and returns a warning.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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: cf

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

-Filter

Specifies the IIS configuration section or an XPath query that returns a configuration element.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

Forces the specified configuration to be cleared.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-Location

Specifies the location of the configuration setting. Location tags are frequently used for configuration settings that must be set more precisely than per application or per virtual directory. For example, a setting for a particular file or directory could use a location tag. Location tags are also used if a particular section is locked. In such an instance, the configuration system would have to use a location tag in one of the parent configuration files.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-PSPath

Specifies the configuration path. This path can be either an IIS configuration path in the format computer name/webroot/apphost, or the IIS module path in the format IIS:\sites\Default Web Site.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Add-WebConfiguration

Get-WebConfiguration

Restore-WebConfiguration

Set-WebConfiguration

© 2017 Microsoft