Set-CsHostingProvider
Modifies a hosting provider currently in use in your organization. A hosting provider is a 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!, MSN and AOL) in that their services are not offered to the general public. This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsHostingProvider
[[-Identity] <XdsGlobalRelativeIdentity>]
[-Enabled <Boolean>]
[-EnabledSharedAddressSpace <Boolean>]
[-HostsOCSUsers <Boolean>]
[-IsLocal <Boolean>]
[-VerificationLevel <VerificationLevelType>]
[-Force]
[-WhatIf]
[-Confirm]
[-AutodiscoverUrl <String>]
[-SipClientPort <UInt64>]
[<CommonParameters>] Set-CsHostingProvider
[-Instance <PSObject>]
[-Enabled <Boolean>]
[-EnabledSharedAddressSpace <Boolean>]
[-HostsOCSUsers <Boolean>]
[-IsLocal <Boolean>]
[-VerificationLevel <VerificationLevelType>]
[-Force]
[-WhatIf]
[-Confirm]
[-AutodiscoverUrl <String>]
[-SipClientPort <UInt64>]
[<CommonParameters>] 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 Skype for Business. Skype for Business Server 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 that provides SIP communication services for other organizations; for example, Fabrikam, Inc. might host users from Contoso, Northwind Traders and Wingtip Toys. 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, 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 Skype for Business Server users have accounts hosted on-premises (that is, hosted on your local implementation of Skype for Business Server). Other users have their accounts maintained off-premises by the third-party hosting provider. Federating with the hosting provider enables 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 fully qualified domain name (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 Edge Servers are configured to use default routing rather than Domain Name System (DNS) server routing.
Examples
-------------------------- Example 1 ------------------------
Set-CsHostingProvider -Identity "Fabrikam.com" -VerificationLevel "AlwaysUnverifiable"Example 1 modifies the hosting provider with the Identity Fabrikam.com. In this example, the VerificationLevel property is set to AlwaysUnverifiable.
-------------------------- Example 2 ------------------------
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 ------------------------
Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.HostsOCSUsers -eq $True} | Set-CsHostingProvider -EnabledSharedAddressSpace $False -HostsOCSUsers $FalseIn 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.
In this example, Get-CsHostingProvider is first called in order to return a collection of all the available 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 True and 2) the EnabledSharedAddressSpace property is equal to True.
This filtered collection is then piped to Set-CsHostingProvider, which sets both the EnabledSharedAddressSpace and the HostsOCSUsers properties to 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.
Parameters
-AutodiscoverUrl
URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. The autodiscover service enables client applications such as Microsoft Lync Mobile to determine how to access resources such as a user's home pool.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Enabled
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-EnabledSharedAddressSpace
If True, indicates that the hosting provider is being used in a split domain scenario. The default value is False.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-HostsOCSUsers
If True, indicates that the hosting provider is used to host Skype for Business Server accounts. If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. The default value is False.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
Unique identifier for the hosting provider to be modified. The Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.).
| Type: | XdsGlobalRelativeIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Instance
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-IsLocal
If True, indicates that the proxy server used by the hosting provider is contained within your own Skype for Business Server topology. The default value is False.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-SipClientPort
Port used by the provider for communicating with SIP clients; the default value is 443.
Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet.
To see the SipClientPort, use a command similar to this:
Get-CsHostingProvider | Select-Object *
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-VerificationLevel
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 also in your Contacts 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.
The default value is AlwaysVerifiable.
| Type: | VerificationLevelType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object.
Set-CsHostingProvider accepts pipelined instances of the hosting provider object.
Outputs
Set-CsHostingProvider does not return a value or object.
Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object.