external help file: SitecoreInstallFramework-help.xml
online version:
schema: 2.0.0
---
Creates, updates, and removes web bindings.
Invoke-WebBindingTask [-SiteName] <String> [[-Add] <PSObject[]>] [[-Remove] <PSObject[]>]
[[-Update] <PSObject[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Supports adding, removing, and updating web bindings for a site.
You can add, remove, and update bindings at the same time. Changes are applied in the following order:
ADDING
When adding bindings, each binding entry must be supplied as an object in the following format:
@{
HostHeader =
IPAddress =
Port =
Protocol =
SSlFlags =
Thumbprint =
}
REMOVING
When removing bindings, each entry must be in the following format:
@{
HostHeader =
IPAddress =
Port =
Protocol =
}
Alternatively, you can provide information as:
@{
BindingInformation = '
Protocol =
}
Optionally, all bindings can be removed by passing '*' instead of binding information.
UPDATING
When updating bindings, each entry must be in the following format:
@{
HostHeader =
IPAddress =
Port =
PropertyName =
Value =
Thumbprint =
}
Alternatively, you can provide information as :
@{
BindingInformation = '
PropertyName =
Value =
}
NOTE: The 'propertyname' must be the name of the property to update, for example, HostHeader,IPAddress or Port
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Add @{ Port = 80 }
Adds a new web binding to a site. In this example, the binding matches the default '*:80:' binding.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Add @{ Port = 443; Protocol = 'https'; Thumbprint = '97A875E0F559AB380C1FDBEF3CB391E5C7ED87BA' }
Adds a new https binding to a site. In this example, the binding matches the default '*:443:' binding with a certificate.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Add @{ HostHeader = 'Example'; IPAddress = '127.0.0.1' }
Adds a binding for the localhost address restricted to the hostheader 'Example'.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Remove * -Add @{ Protocol = 'https' }
Removes all existing bindings before adding a default https binding. The binding is set to '*:443:'.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Remove @{ Protocol = 'http' }
Removes all existing bindings that use the 'http' protocol.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Update @{ Port = 80; PropertyName = 'Port'; Value = 81 }
Updates existing bindings using port 80 with an empty hostheader and no assigned IP to use port 81.
PS C:\> Invoke-WebBindingTask -SiteName ExampleSite -Update @{ Port = 443; Thumbprint = '97A875E0F559AB380C1FDBEF3CB391E5C7ED87BA' }
Updates existing binding on port 443 to use the certificate with thumbprint '97A875E0F559AB380C1FDBEF3CB391E5C7ED87BA'.
A collection of bindings to add.
See function description for the format.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A collection of bindings to remove.
See function description for the format.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The name of the site where bindings are modified.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Bindings that will be updated.
See function description for the format.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).