Get-WebConfigurationProperty
Gets an IIS configuration property at a path.
Syntax
Default (Default)
Get-WebConfigurationProperty
-Name <String[]>
[-Recurse]
[-Clr <String>]
[-Location <String[]>]
[-Filter] <String[]>
[[-PSPath] <String[]>]
[<CommonParameters>]
Description
The Get-WebConfigurationProperty cmdlet gets an Internet Information Services (IIS) configuration property at the specified path. This cmdlet is similar to the Get-WebConfiguration cmdlet, but the current cmdlet supports globbing, or wildcards.
Examples
Example 1: Return the default documents for the default website
C:\PS> Get-WebConfigurationProperty -Filter "//defaultDocument/files/add" -PSPath "IIS:\Sites\Default Web Site" -Name "value" | select value
Default.htm
Default.asp
Index.htm
Index.html
Iisstart.htm
Default.aspx
This command returns a list of the default documents associated with the default website.
Example 2: Show handlers mapped to Aspnet_isapi.dll
C:\PS> Get-WebConfigurationProperty -Filter "//handlers" -PSPath "IIS:\sites\Default Web Site" -Name Collection[scriptProcessor="*aspnet_isapi.dll"] | select path,name
This command gets the handlers mapped to aspnet_isapi.dll.
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Filter
Specifies the IIS configuration section or an XPath query that returns a configuration element.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of the property to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Recurse
Indicates that the cmdlet returns the properties of nodes contained within the hierarchy of the specified node.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.