Export (0) Print
Expand All
Expand Minimize

Set-WebConfigurationProperty

Windows Server 2012 R2 and Windows 8.1

Updated: February 20, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-WebConfigurationProperty

Changes the value of an IIS configuration property.

Syntax

Parameter Set: InputPSObject
Set-WebConfigurationProperty [-Filter] <String[]> [[-PSPath] <String[]> ] -Name <String> -Value <PSObject> [-AtElement <Hashtable> ] [-AtIndex <Int32> ] [-AtName <String> ] [-Clr <String> ] [-Force] [-Location <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Set-WebConfigurationProperty [-Filter] <String[]> [[-PSPath] <String[]> ] -InputObject <Object> -Name <String> [-AtElement <Hashtable> ] [-AtIndex <Int32> ] [-AtName <String> ] [-Clr <String> ] [-Force] [-Location <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

TheSet-WebConfigurationPropertycmdlet changes the value of an IIS configuration property. The element can be specified as a configuration section or an XPath query. Globbing, the use of wildcards, is supported.

Parameters

-AtElement<Hashtable>

The element at which the configuration property is set.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-AtIndex<Int32>

The index at which the configuration property is set.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-AtName<String>

The name of the collection property for which the value is set.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-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 IIS configuration section or an XPath query that returns a configuration element.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Force

If theForceparameter is used it causes the configuration property setting to be set at a level in the configuration hierarchy above a lock in the configuration.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<Object>

Specifies an object that contains values to set for configuration properties.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Location<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

The name of the configuration property to change.


Aliases

none

Required?

true

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

-Value<PSObject>

The value of the configuration setting to change.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

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: Change the extension of all handlers mapped to .aspx --------------

The cmdlet changes all handler paths to *.mspx that were mapped to *.aspx.


IIS:\>Set-WebConfigurationProperty "//handlers/add[@path='*.aspx']" -PSPath IIS:\ -Name path –Value “*.mspx”

-------------- EXAMPLE 2: Setting new Bindings on an existing Web site --------------

The cmdlet sets new bindings on an existing Web site. The original bindings are replaced.


IIS:\>set-webconfigurationproperty '/system.applicationHost/sites/site[@name="DemoSite"]' -PSPath IIS:\ -Name Bindings -Value (@{protocol="http";bindingInformation=*:80:DemoSite1”},@{protocol="http";bindingInformation="*:80:DemoSite2"})

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft