Get-WebConfiguration
Get-WebConfiguration
Gets an IIS configuration element at the specified path.
Syntax
Parameter Set: Default
Get-WebConfiguration [-Filter] <String[]> [[-PSPath] <String[]> ] [-Clr <String> ] [-Location <String[]> ] [-Metadata] [-Recurse] [ <CommonParameters>]
Detailed Description
Gets the IIS configuration element at the specified 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 configuration path for which the configuration elements are returned.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Location<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Metadata
Returns configuration metadata such as encryption or locking settings.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-Recurse
Returns all elements contained in the specified location and the subsequent hierarchy.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
- PSObject
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSObject
Examples
-------------- EXAMPLE 1: Querying authentication settings --------------
This example queries for all authentication settings specified under the Default Web Site.
IIS:\>Get-WebConfiguration system.webServer/security/authentication/* /* -Recurse | where {$_.enabled -eq $true} | format-list