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 Communications Server 2010 ships with three public providers configured but not enabled: Yahoo!; AOL; and Windows Live.
Syntax
Get-CsPublicProvider [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsPublicProvider [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
String |
Unique identifier for the public provider to be returned. The Identity is simply a string value, and is typically the name of the Web site providing the services (e.g., Yahoo!; AOL; Windows Live; 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 |
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". 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 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 Windows Live, then your users will be able to exchange instant messages and presence information with anyone who has a Windows Live 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 enables you to return information about the public providers that have been configured for use in your organization.
Note that you cannot federate with a public 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.DisplayPublicProvider object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
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 will always return the complete collection of public providers.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsPublicProvider -Identity "AOL" |
|
In Example 2, all the public providers that have the Identity AOL 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 ------------------------
| Copy Code |
|
|---|---|
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 ------------------------
| Copy Code |
|
|---|---|
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 (-eq) False ($False).
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
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 (-ne) AlwaysVerifiable. The net effect: only providers where the VerificationLevel property is set to either AlwaysUnverifiable or UseSourceVerification will be selected.