Edit

Share via

Get-WebConfiguration

  • Reference
Module:
WebAdministration

Gets an IIS configuration element.

Syntax

Get-WebConfiguration
   [-Recurse]
   [-Metadata]
   [-Clr <String>]
   [-Location <String[]>]
   [-Filter] <String[]>
   [[-PSPath] <String[]>]
   [<CommonParameters>]

Description

The Get-WebConfiguration cmdlet gets the Internet Information Services (IIS) configuration element at the specified location.

Examples

Example 1: Query authentication settings

IIS:\> Get-WebConfiguration -Filter "System.WebServer/Security/Authentication/* /*" -Recurse | where {$_.enabled -eq $True} | Format-List

This command queries for all authentication settings specified under the default website.

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.

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

-Filter

Specifies the configuration path for which this cmdlet gets the configuration elements.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

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

-Metadata

Indicates that the cmdlet returns configuration metadata such as encryption or locking settings.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-Recurse

Indicates that this cmdlet returns all elements contained in the specified location and the subsequent hierarchy.

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

Inputs

PSObject

Outputs

PSObject