powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-WebConfiguration



NAME
Get-WebConfiguration

SYNOPSIS
Gets an IIS configuration element at the specified path.

SYNTAX
Get-WebConfiguration [-Recurse] [-Metadata] [-Location ] [-Filter] [[-PSPath] ] [-Wa
rningAction ] [-WarningVariable ] []


DESCRIPTION
Gets the IIS configuration element at the specified location.


PARAMETERS
-Recurse
Returns all elements contained in the specified location and subsequent hierarchy.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Metadata
Returns configuration metadata such as encryption or locking settings.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Location
Location of the configuration setting. Location tags are usually used for configuration settings that need to b
e more granular than per application or per virtual directory. Settings for particular files or directory are a
n example.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Filter
Specifies the configuration path for which the configuration element(s) should be returned.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PSPath
Specifies the configuration path. This can be either an IIS configuration path (e.g. machine/webroot/apphost) o
r the IIS module path (e.g. 'IIS:\sites\Default Web Site').

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-WarningAction


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
PSObject


OUTPUTS
PSObject


NOTES




-------------- EXAMPLE 1: Querying authentication settings --------------

C:\PS>Get-WebConfiguration system.webServer/security/authentication/* 'IIS:\sites\Default Web Site' -Recurse | wher
e {$_.enabled -eq 'true'} | format-list


This example queries for all authentication settings specified under the 'Default Web Site'.






RELATED LINKS