Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Add-WebConfiguration

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

Add-WebConfiguration

Adds a collection element to an IIS configuration collection.

Syntax

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




Detailed Description

The Add-WebConfiguration cmdlet adds a collection element to an existing IIS configuration collection.

Parameters

-AtElement<Hashtable>

The element in the collection location at which the value is inserted.


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 value is inserted.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-AtName<String>

The name at which the value is inserted.


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[]>

Can be a configuration section, or an XPath query that returns either a configuration section or a configuration element that contains a collection.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Forces the creation of configuration, and overrides existing element settings.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Location<String[]>

The location to which the configuration is written.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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 to add to the configuration collection. This can be a single value or a value/key combination in a hash table.


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.

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: Add a new Default Document --------------

This example adds a new Default Document to the Default Document collection of the Default Web Site. By using "-atIndex 0" the new Default Document is inserted at the top of the list.


IIS:\>Add-WebConfiguration //defaultDocument/files "IIS:\sites\Default Web Site" -atIndex 0 -Value @{value="new-index.html"}

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.