Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Add-WebConfigurationProperty

Windows Server 2012 R2 and Windows 8.1

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

The Add-WebConfigurationProperty cmdlet adds a property to an Internet Information Services (IIS) configuration section. Globbing is supported.

Parameters

-AtElement<Hashtable>

Specifies the element at which this cmdlet inserts the value.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-AtIndex<Int32>

Specifies the index at which this cmdlet inserts the property.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-AtName<String>

Specifies the property name at which this cmdlet inserts the property.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Clr<String>

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.


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

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Location<String[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the IIS configuration property to add.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PSPath<String[]>

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.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Type<String>

Specifies the type of property that this cmdlet adds.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Value<PSObject>

Specifies the value of the configuration property that this cmdlet adds.


Aliases

none

Required?

false

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 (http://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-------------- EXAMPLEExample 1: Adding a Default default Document document --------------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 -Filter "//defaultDocument/files" -PSPath "IIS:\sites\Default Web Site" -AtIndex 0 -Name "Collection" -Value "new-index.html"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft