Modifies a hosting provider currently in 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
Set-CsHostingProvider [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-EnabledSharedAddressSpace <$true | $false>] [-Force <SwitchParameter>] [-HostsOCSUsers <$true | $false>] [-IsLocal <$true | $false>] [-VerificationLevel <AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification>] [-WhatIf [<SwitchParameter>]] |
Set-CsHostingProvider [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-EnabledSharedAddressSpace <$true | $false>] [-Force <SwitchParameter>] [-HostsOCSUsers <$true | $false>] [-Instance <PSObject>] [-IsLocal <$true | $false>] [-VerificationLevel <AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
String |
Unique identifier for the hosting provider to be modified. 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.). |
Instance |
Optional |
DisplayHostingProvider object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
VerificationLevel |
Optional |
String |
Indicates the allowed verification level for messages sent to and from the hosted provider. The VerificationLevel must be set to one of the following values: AlwaysVerifiable. Indicates that all messages sent from the hosting provider are considered verifiable. That means that no messages from the hosting provider will be rejected. AlwaysUnverifiable. Indicates that all messages sent from the hosting provider are considered unverifiable. As a result, messages are passed only if the user on the hosting provider is in your contact list. UseSourceVerification. Relies on the verification level included in messages sent from the hosting provider. If this level is not specified, then the message will be rejected as being unverifiable. |
Enabled |
Optional |
Boolean |
Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. (The default value is False.) |
IsLocal |
Optional |
Boolean |
If True, indicates that the proxy server used by the hosting provider is contained within your own Communications Server 2010 topology. The default value is False. |
EnabledSharedAddressSpace |
Optional |
Boolean |
If True, indicates that the hosting provider is being used in a split domain scenario. The default value is False. |
HostsOCSUsers |
Optional |
Boolean |
If True, indicates that the hosting provider is used to host Communications Server 2010 accounts. If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. The default value is False. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
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 Communication 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.) After a hosting provider has been created you can use the Set-CsHostingProvider cmdlet to modify the properties of that provider. For example, you can use this cmdlet to change the FQDN of the provider’s proxy server, or use the cmdlet to change the verification level for that provider.
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
Set-CsHostingProvider does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.DisplayHostingProvider object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Set-CsHostingProvider -Identity "Fabrikam.com" -VerificationLevel "AlwaysUnverifiable" |
The preceding command modifies the hosting provider with the Identity Fabrikam.com. In this example, the VerificationLevel property is set to AlwaysUnverifiable.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsHostingProvider | Set-CsHostingProvider -VerificationLevel "AlwaysUnverifiable" |
Example 2 is a variation of the command shown in Example 1; in this case, however, the verification level for all the hosting providers is set to AlwaysUnverifiable. To do this, Get-CsHostingProvider is first used to return a collection of all the hosting providers configured for use in the organization. This collection is then piped to Set-CsHostingProvider, which modifies the VerificationLevel property for each provider in the collection.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.HostsOCSUsers -eq $True} | Set-CsHostingProvider -EnabledSharedAddressSpace $False -HostsOCSUsers $False |
In Example 3 all the hosting providers currently configured for use in a split domain setup are modified so that they are no longer used for split domain federation. (Split domain means that some of your Communications Server 2010 accounts are maintained on-premise while other accounts are maintained by a hosting provider.) In this example, Get-CsHostingProvider is first called in order 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 HostsOCSUsers property is equal to (-eq) True ($True); and, 2) the EnabledSharedAddressSpace property is equal to True. This filtered collection is then piped to Set-CsHostingProvider, which, in turn, sets both the EnabledSharedAddressSpace and the HostsOCSUsers properties to False ($False). When this is done any hosting providers in the collection will still be enabled for federation; however, they will no longer be used in a split domain scenario.