Edit

Share via

Add-WebConfiguration

  • Reference
Module:
WebAdministration

Adds a collection element to an IIS configuration collection.

Syntax

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

Description

The Add-WebConfiguration cmdlet adds a collection element to an existing Internet Information Services (IIS) configuration collection.

Examples

Example 1: Add a new default document

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

This command adds a new default document to the default document collection of the default website. By specifying a value of 0 for the atIndex parameter, the new default document is inserted at the top of the list.

Parameters

-AtElement

Specifies the element in the collection location at which this cmdlet inserts the value.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AtIndex

Specifies the index at which this cmdlet inserts the value.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AtName

Specifies the name at which this cmdlet inserts the value.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Specifies the location to which this cmdlet writes the configuration.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

Specifies the value to add to the configuration collection. You can specify a single value or a value/key combination in a hash table.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSObject

Outputs

PSObject