Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-IISConfigAttributeValue

Last Updated: 3/30/2017

SYNOPSIS

Gets a configuration attribute value from an IIS configuration section or configuration element attribute.

SYNTAX

Get-IISConfigAttributeValue [-ConfigElement] <ConfigurationElement> [-AttributeName] <String>
 [<CommonParameters>]

DESCRIPTION

The Get-IISConfigAttributeValue cmdlet gets a configuration attribute value from an Internet Information Services (IIS) configuration section attribute or a configuration element attribute. The value returned is the value that can be extracted from the given ConfigurationElement and not necessarily the effective value for a given site / virtual directory / folder etc. To obtain the effective attribute values, always retrieve the configuration element by specifying the commit path as the deepest level possible. Even the configuration attribute is not defined at that level, the parent attributes are scanned and the effective configuration element is returned. You can then work on this ConfigurationElement to get/set/remove configuration attribute values.

EXAMPLES

Example 1: Get a configuration attribute from an IIS website

PS C:\> Get-IISSite "Default Web Site" | Get-IISConfigElement -ChildElementName "limits" | Get-IISConfigAttributeValue -AttributeName "MaxUrlSegments"

This command gets the configuration attribute MaxUrlSegments for the Default Web Site.

Example 2: Get configuration attribute values from different parts of the configuration store

PS C:\> Get-IISConfigSection "system.webServer/asp" | Get-IISConfigAttributeValue -AttributeName "ScriptErrorMessage"
error message inside the location path default web site

This command gets the global attribute value for ScriptErrorMessage

PARAMETERS

-AttributeName

Specifies the name of the attribute that will be retrieved.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigElement

Specifies the IIS ConfigurationSection or ConfigurationElement for which the attribute value will be looked up.

Type: ConfigurationElement
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Web.Administration.ConfigurationElement, System.String

OUTPUTS

object

NOTES

Set-IISConfigAttributeValue

IIS Administration Cmdlets for Windows PowerShell

© 2017 Microsoft