[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Enables a hosting provider for use in your organization. A hosting provider is a private third-party organization that provides instant messaging, presence, and related services for a domain that you would like to federate with. Hosting providers differ from public providers (such as Yahoo!, Windows Live, and AOL) in that their services are not offered to the general public.


Enable-CsHostingProvider [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Enable-CsHostingProvider [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Unique identifier for the hosting provider to be enabled. The Identity is simply a string value; for example, the Identity could be the fully qualified domain name of the hosting provider (e.g., fabrikam.com) or perhaps the name of the company providing the services (Fabrikam Hosting, Inc.).



DisplayHostingProvider object

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Federation is a means by which two organizations can set up a trust relationship that facilitates communication between the two groups. When a federation has been established, users in the two organizations can send each other instant messages, subscribe for presence notifications, and otherwise communicate with one another using SIP applications such as Microsoft Communicator "14". Microsoft Communications Server 2010 allows for three types of federation: 1) direct federation between your organization and another; 2) federation between your organization and a public provider; and, 3) federation between your organization and a third-party hosting provider.

A hosting provider is an organization which provides SIP communication services for other organizations; for example, Fabrikam Hosting, Inc. might host users from Contoso, Northwind Traders, Wingtip Toys, and so on. When you establish a federation relationship with a hosting provider, you effectively establish federation with any organization hosted by that provider. For example, if you federate with Fabrikam Hosting, your users will be able to exchange instant messages and presence information with users from Contoso, Northwind Traders, and Wingtip Toys.

Hosting providers are also used in split domain scenarios. In a split domain scenario, some of your Communications Server users have accounts hosted on-premises (that is, hosted on your local implementation of Communications Server 2010). Other users have their accounts hosted "in the cloud"; that is, those accounts are maintained off-premises by the third-party hosting provider. Federating with the hosting provider enables your on-premises and off-premises users to communicate with one another.

In order to federate with a third-party hosting provider you need to create and enable a new hosting provider. (In addition, the third-party provider will need to create a federation relationship with you.) You can enable a hosting provider at the time that provider is created; alternatively, you can enable that provider after-the-fact by using the Enable-CsHostingProvider cmdlet

Note that you cannot federate with a hosting provider if your Access edge servers are configured to use default routing rather than DNS server routing. For more information, type "Get-Help Set-CsAccessEdgeConfiguration" (without the quote marks) at the Windows PowerShell prompt.

Return Types

Enables instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.DisplayHostingProvider object.


-------------------------- Example 1 ------------------------

Copy Code
Enable-CsHostingProvider -Identity Fabrikam.com

In Example 1, the hosting provider with the Identity Fabrikam.com is enabled for use. Note that this command will return an error if Fabrikam.com has already been enabled for use.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsHostingProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsHostingProvider

Example 2 shows how you can enable all the hosting providers that are currently disabled. To do this, the command first calls Get-CsHostingProvider (without any additional parameters) in order to return a collection of all the hosting providers currently configured for use in the organization. This collection is piped to the Where-Object cmdlet, which selects any provider where the Enabled property is equal to (-eq) False ($False); by definition, that is any provider that is currently disabled. This filtered collection is then piped to Enable-CsHostingProvider, which enables each of the items (providers) in the collection.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsHostingProvider | Where-Object {$.EnabledSharedAddressSpace -eq $True -and $_.Enabled -eq $False} | Enable-CsHostingProvider

In Example 3, all of the hosting providers used in a "split domain" setup are enabled for use. (Split domain means that some of your Communications Server 2010 accounts are maintained on-premise while other accounts are maintained by a hosting provider.) To carry out this task, the command first uses Get-CsHostingProvider to return a collection of all the currently-configured hosting providers. This collection is then piped to the Where-Object cmdlet, which selects only those providers that meet two criteria: 1) the EnabledSharedAddressSpace property is equal to True ($True); and, 2) the Enabled property is equal to (-eq) False. After that, the filtered collection is piped to Enable-CsHostingProvider, which enables each provider in the collection.