Edit

Share via

Set-WebConfiguration

Module:
WebAdministration Module

Changes the value of an IIS configuration element.

Syntax

InputPSObject (Default) 

Set-WebConfiguration
    [-Filter] <String[]>
    [[-PSPath] <String[]>]
    -Value <PSObject>
    [-Metadata <String>]
    [-Clr <String>]
    [-Force]
    [-Location <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject 

Set-WebConfiguration
    [-Filter] <String[]>
    [[-PSPath] <String[]>]
    -InputObject <Object>
    [-Metadata <String>]
    [-Clr <String>]
    [-Force]
    [-Location <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-WebConfiguration cmdlet changes the value of an Internet Information Services (IIS) configuration element. Specify an element as a configuration section or an XPath query.

Examples

Example 1: Set new bindings on an existing website

IIS:\> Set-WebConfiguration -Filter "/system.applicationHost/sites/site[@name=" DemoSite"]/bindings" -PSPath "IIS:\" -Value (@{protocol="http";bindingInformation="*:80:DemoSite1"},@{protocol="http";bindingInformation="*:80:DemoSite2"})

This command replaces the existing bindings of the Web site named DemoSite with new bindings.

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Specifies the IIS configuration section or an XPath query that returns a configuration element.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Indicates that the cmdlet causes the configuration setting to be set at a level in the configuration hierarchy above a lock in the configuration.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies an input object that contains values to set for configuration elements.

Parameter properties

Type:Object
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Metadata

If this parameter is specified, configuration metadata such as encryption or locking settings can be changed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Value

Specifies the value of the configuration setting to change.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:v, val

Parameter sets

InputPSObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

PSObject

Outputs

PSObject