Configure web address settings (PowerShell)

  • Article

 

Applies To: Dynamics CRM 2013

This sample code is for Microsoft Dynamics CRM 2013. Download the Microsoft Dynamics CRM SDK package. It can be found in the following location in the download package:

SampleCode\PS1\ConfigureWebAddressSettings.ps1

Requirements

To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell.

Demonstrates

The following script will configure Web address settings - partner-hosted (IFD). You must specify the following parameters:

RootDomainScheme – The root domain scheme: http or https. .

DeploymentSdkRootDomain – The root domain for the deployment Web service (SDK).

DiscoveryRootDomain – The root domain for the discovery Web service.

NlbEnabled – A Boolean that specifies whether network load balancing (NLB) is enabled.

SdkRootDomain – The root domain for the organization Web service (SDK).

SslHeader – The secured sockets layer (SSL) header.

WebAppRootDomain – The root domain for the Web application.

Example

param
(
    #optional params
    [string]$RootDomainScheme,
    [string]$DeploymentSdkRootDomain,
    [string]$DiscoveryRootDomain,
    [boolean]$NlbEnabled,
    [string]$SdkRootDomain,
    [string]$SslHeader,
    [string]$WebAppRootDomain
)

$RemoveSnapInWhenDone = $False

if (-not (Get-PSSnapin -Name Microsoft.Crm.PowerShell -ErrorAction SilentlyContinue))
{
    Add-PSSnapin Microsoft.Crm.PowerShell
    $RemoveSnapInWhenDone = $True
}

$WebAddressSettings = Get-CrmSetting -SettingType WebAddressSettings

if($DeploymentSdkRootDomain) {$WebAddressSettings.DeploymentSdkRootDomain = $DeploymentSdkRootDomain}
if($DiscoveryRootDomain) {$WebAddressSettings.DiscoveryRootDomain = $DiscoveryRootDomain}
if($PSBoundParameters.ContainsKey('NlbEnabled')) {$WebAddressSettings.NlbEnabled = $NlbEnabled}
if($RootDomainScheme) {$WebAddressSettings.RootDomainScheme = $RootDomainScheme}
if($SdkRootDomain) {$WebAddressSettings.SdkRootDomain = $SdkRootDomain}
if($PSBoundParameters.ContainsKey('SslHeader')) {$WebAddressSettings.SslHeader = $SslHeader}
if($WebAppRootDomain) {$WebAddressSettings.WebAppRootDomain = $WebAppRootDomain}

Set-CrmSetting -Setting $WebAddressSettings

$WebAddressSettings

if($RemoveSnapInWhenDone)
{
    Remove-PSSnapin Microsoft.Crm.PowerShell
}

See Also

Administer the deployment using Windows PowerShell
Examples of Windows PowerShell commands
Get and set deployment configuration settings
Add a deployment administrator (PowerShell)
Create an organization (PowerShell)
Configure IFD settings (PowerShell)
Configure claims settings (PowerShell)
Delete a deployment administrator

© 2016 Microsoft Corporation. All rights reserved. Copyright