Add-WebConfigurationProperty

Add-WebConfigurationProperty

Adds a property to an IIS configuration section.

Syntax

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

Detailed Description

Adds a property to an IIS configuration section. Globbing is supported.

Parameters

-AtElement<Hashtable>

The element at which the value is to be inserted.

-AtIndex<Int32>

The index at which the property is to be inserted.

-AtName<String>

The property name at which the property is to be inserted.

-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.

-Filter<String[]>

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

-Force

Forces the property to be written. If a lock exists, the property is written at a level in the configuration above the lock.

-Location<String[]>

Location of the configuration property 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.

-Name<String>

The name of the IIS configuration property to add.

-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.

-Type<String>

The type of property to add.

-Value<PSObject>

The value of the configuration property to add.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------- EXAMPLE 1: Adding a Default Document --------------

This command adds a new Default Document named new-index.html to the top of the list of existing documents.

IIS:\>Add-WebConfigurationProperty //defaultDocument/files "IIS:\sites\Default Web Site" -AtIndex 0 -Name collection -Value "new-index.html"

Related topics

Remove-WebConfigurationProperty