Edit

Remove-WebConfigurationProperty

  • Reference
Module:
WebAdministration

Removes an IIS configuration property.

Syntax

Remove-WebConfigurationProperty
      -Name <String>
      [-Clr <String>]
      [-AtElement <Hashtable>]
      [-AtIndex <Int32>]
      [-AtName <String>]
      [-Force]
      [-Location <String[]>]
      [-Filter] <String[]>
      [[-PSPath] <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-WebConfigurationProperty cmdlet removes an Internet Information Services (IIS) configuration property.

Examples

Example 1: Remove the first binding on a site

IIS:\> Remove-WebConfigurationProperty -Filter '/system.applicationHost/sites/site[@name="Default Web Site"]' -Name "Bindings.collection" -AtIndex 0

This command removes the first binding on the default website.

Parameters

-AtElement

Specifies the element at which this cmdlet removes the configuration property.

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

-AtIndex

Specifies the index at which this cmdlet removes the configuration property.

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

-AtName

Specifies the name of the configuration property at which this cmdlet removes the property.

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

-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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-Filter

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Indicates that this cmdlet causes the configuration property to be removed from a level in the configuration hierarchy above an existing lock.

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

-Location

Specifies the location of the configuration property. 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[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the configuration property to remove.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
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[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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