Export (0) Print
Expand All
Expand Minimize

Enable-CsPublicProvider

 

Topic Last Modified: 2012-03-23

Enables a public provider configured for use in your organization. A public provider is an organization that provides instant messaging, presence, and related services to the general public. Microsoft Lync Server 2010 ships with three public providers configured but not enabled: Yahoo!; AOL; and MSN.

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

Federation is a means by which two organizations can set up a trust relationship that facilitates communication between the two groups. When 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 Lync 2010. Lync 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 public provider is an organization which provides SIP communication services for the general public. When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. For example, if you federate with MSN, then your users will be able to exchange instant messages and presence information with anyone who has an MSN instant messaging account.

In order to federate with a public provider you need to create and enable a new public provider. (In addition, the public provider will need to create a federation relationship with you.) Public providers can be enabled at the time they are created, or they can be enabled after-the-fact by using the Enable-CsPublicProvider cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Enable-CsPublicProvider cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Enable-CsPublicProvider"}

 

Parameter Required Type Description

Identity

Optional

String

Unique identifier for the public provider to be enabled. The Identity is typically the name of the website providing the services (for example,, Yahoo!; AOL; and MSN).

Instance

Optional

DisplayPublicProvider object

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

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might occur 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.

Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. Enable-CsPublicProvider accepts pipelined instances of the public provider object.

None. Instead, the cmdlet enables instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object.

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

Enable-CsPublicProvider -Identity "MSN"

The command shown in Example 1 enables the public provider with the Identity MSN. This command will return an error if MSN is already enabled.

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

Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsPublicProvider

The preceding command enables all the public providers that are currently disabled. In order to carry out this task, the command first uses Get-CsPublicProvider to return a collection of all the public providers configured for use in the organization. That collection is piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False. The filtered collection is then piped to Enable-CsPublicProvider, which enables each provider in the collection.

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

Get-CsPublicProvider | Where-Object {$_.VerificationLevel -eq "AlwaysVerifiable" -and $_.Enabled -eq $False} | Enable-CsPublicProvider

Example 3 enables all the public providers that are not currently enabled, provided the verification level of those providers is set to AlwaysVerifiable. To do this, the command first calls Get-CsPublicProvider to return a collection of all the public providers currently in use in the organization. This collection is piped to Where-Object, which picks out those providers that meet two criteria: 1) the VerificationLevel property is equal to AlwaysVerifiable; and, 2) the Enabled property is equal to False. (The -and operator tells Where-Object that objects must meet all the specified criteria in order to be selected.) This filtered collection is then piped to Enable-CsPublicProvider, which enables each provider in the collection.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft