Get-WebConfigurationProperty

Gets an IIS configuration property at the specified path.

Syntax

Get-WebConfigurationProperty
   -Name <String[]>
   [-Recurse]
   [-Clr <String>]
   [-Location <String[]>]
   [-Filter] <String[]>
   [[-PSPath] <String[]>]
   [<CommonParameters>]

Description

The Get-WebConfigurationProperty cmdlet is similar to the Get-WebConfiguration cmdlet, but Get-WebConfigurationProperty supports globbing (wildcards).

Examples

-------------- EXAMPLE 1: Return the Default Documents for the Default Web Site --------------

C:\PS>Get-WebConfigurationProperty -Filter //defaultDocument/files/add -PSPath 'IIS:\Sites\Default Web Site' -Name value | select value

Returns a list of the default documents associated with the Default Web Site.

Default.htm

Default.asp

Index.htm

Index.html

Iisstart.htm

Default.aspx

-------------- EXAMPLE 2: Show handlers mapped to ASPNET_ISAPI.DLL --------------

C:\PS>Get-WebConfigurationProperty //handlers 'IIS:\sites\Default Web Site' -Property Collection[scriptProcessor="*aspnet_isapi.dll"] | select path,name

Demonstrates how to get the handlers mapped to aspnet_isapi.dll.

Required Parameters

-Filter

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

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

The name of the property to get.

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

Optional Parameters

-Clr

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.

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

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[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PSPath

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

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Recurse

When theRecurseparameter is specified, the cmdlet returns the properties of nodes contained within the hierarchy of the specified node.

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

Inputs

PSObject

Outputs

PSObject