Clear-WebConfiguration
Clear-WebConfiguration
Removes configuration settings from the specified configuration location.
Syntax
Parameter Set: Default
Clear-WebConfiguration [-Filter] <String[]> [[-PSPath] <String[]> ] [-Clr <String> ] [-Force] [-Location <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Removes configuration settings from the specified configuration location.
Parameters
-Clr<String>
Version of the .NET framework in the form vn.n, such as v4.0 or v2.0. The default is v4.0. This parameter is used only when PSPath is set to either Machine or Machine/Webroot. If PSPath is not set to one of these values and the Clr parameter is set, PowerShell ignores the value of Clr and returns a warning.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Filter<String[]>
Specifies the IIS configuration section or an XPath query that returns a configuration element.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the specified configuration to be cleared.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Location<String[]>
The location of the configuration setting to clear. 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PSPath<String[]>
Specifies the configuration path. This can be either an IIS configuration path in the formatcomputer name/webroot/apphost, or the IIS module path in this format IIS:\sites\Default Web Site.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
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.
Examples
-------------- EXAMPLE 1: Removing ASP configuration on the root node --------------
This command removes the <asp> section from the root node.
C:\PS>Clear-WebConfiguration -Filter /system.webServer/asp -PSPath 'IIS:\'
-------------- EXAMPLE 2: Remove a configuration property from the root node --------------
This example removes the lcid property from the IIS configuration root node.
C:\PS>Clear-WebConfiguration -Filter /system.webServer/asp/@lcid -PSPath 'IIS:\'
-------------- EXAMPLE 3: Removing configuration from the site node --------------
Remove the <asp> section from the IIS configuration node for the Default Web Site.
IIS:\>Clear-WebConfiguration -Filter /system.webServer/asp -PSPath 'IIS:\sites\Default Web Site'