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

Returns information about the hosting providers configured 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.

Syntax

Get-CsHostingProvider [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsHostingProvider [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter Required Type Description

Identity

Optional

String

Unique identifier for the hosting provider to be returned. 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.).

If this parameter is not specified, Get-CsHostingProvider will return a collection of all the hosting providers configured for use in your organization.

Filter

Optional

String

Enables you to use wildcard values to return one or more hosting providers. For example, to return all the hosting providers that have an identity that ends with the string value ".com" use this syntax: -Filter "*.com". To return all the hosting providers that have an Identity that begins with the string "Fabri" use this syntax: -Filter "Fabri*".

LocalStore

Optional

Switch Parameter

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

The Get-CsHostingProvider cmdlet provides a way for you to return information about all the hosting providers that have been configured for use in your organization.

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

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

Examples

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

Copy Code
Get-CsHostingProvider

The preceding command returns a collection of all the hosting providers configured for use in the organization. Calling Get-CsHostingProvider without any additional parameters always returns the complete collection of hosting providers.

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

Copy Code
Get-CsHostingProvider -Identity Fabrikam.com

Example 2 returns the hosting provider that has the Identity Fabrikam.com. Because Identities must be unique among hosting providers this command will never return more than a single item.

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

Copy Code
Get-CsHostingProvider -Filter *.org

The command shown in Example 3 returns a collection of all the hosting providers that have an Identity that ends with the string value ".org" (for example, fabrikam.org, contoso.org, etc.).

-------------------------- Example 4 ------------------------

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

In Example 4, all the hosting providers that are currently enabled for use are returned. To do this, Get-CsHostingProvider is first called in order to return a collection of all the hosting providers currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to (-eq) True ($True).

-------------------------- Example 5 ------------------------

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

The preceding command returns all the hosting providers that have a shared address space and that host Communications Server 2010 users; by definition, that means that the command returns all the hosting providers that are part of a "split-domain" setup. (Split domain simply 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 Enabled property is equal to (-eq) True ($True); and, 2) the EnabledSharedAddressSpace property is equal to True.