Share via

  • Article

Get-CsPublicProvider

 

Topic Last Modified: 2012-03-23

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

Syntax

Get-CsPublicProvider [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]

Get-CsPublicProvider [-Filter <String>] [-LocalStore <SwitchParameter>]

Detailed Description

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.) The Get-CsPublicProvider cmdlet enables you to return information about the public providers that have been configured for use in your organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsPublicProvider cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsPublicProvider"}

Parameters

Parameter Required Type Description

Identity

Optional

String

Unique identifier for the public provider to be returned. The Identity is typically the name of the web site providing the services (for example, Yahoo!; AOL; MSN; etc.).

You cannot use wildcards when specifying the Identity. To use wildcards to return one or more public providers, use the Filter parameter instead.

Filter

Optional

String

Enables you to use wildcard values in order to return one or more public providers. For example, to return a collection of all the public providers that have an Identity that begins with the letter Y, use this syntax: -Filter "Y*". To return a collection of all the public providers that include the string value "Windows" anywhere in their Identity, use this syntax: -Filter "*Windows*".

LocalStore

Optional

Switch Parameter

Retrieves the public provider data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsPublicProvider does not accept pipelined input.

Return Types

Returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object.

Example

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

Get-CsPublicProvider

The command shown in Example 1 returns a collection of all the public providers that are configured for use in the organization. Calling Get-CsPublicProvider without any additional parameters always returns the complete collection of public providers.

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

Get-CsPublicProvider -Identity "MSN"

In Example 2, all the public providers that have the Identity MSN are returned. Because Identities must be unique among public providers (and among hosting providers), this command will always return, at most, a single item.

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

Get-CsPublicProvider -Filter W*

The preceding command returns all the public providers that have an Identity that begins with the letter W. This is done by including the Filter parameter and the filter value "W*".

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

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

The command shown in Example 4 returns a collection of all the public providers that are currently disabled. To do this, the command first calls Get-CsPublicProvider to return a collection of all the public providers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False.

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

Get-CsPublicProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable"}

The preceding command returns all the public providers where the VerificationLevel property is set to either AlwaysUnverifiable or UseSourceVerification. (Verification levels can be set to AlwaysUnverifiable; UseSourceVerification; or AlwaysVerifiable.) To perform this task, the command first calls Get-CsPublicProvider to return a collection of all the public providers configured for use in the organization. This collection is then piped to Where-Object, which picks out only those providers where the VerificationLevel property is not equal to AlwaysVerifiable. The net effect: only providers where the VerificationLevel property is set to either AlwaysUnverifiable or UseSourceVerification will be selected.