[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

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 Communications Server 2010 ships with three public providers configured but not enabled: Yahoo!; AOL; and Windows Live.

Syntax

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

Parameters

Parameter Required Type Description

Identity

Optional

String

Unique identifier for the public provider to be enabled. 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.).

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 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". 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.) 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.

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

Enables instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.DisplayPublicProvider object.

Examples

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

Copy Code
Enable-CsPublicProvider -Identity "AOL"

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

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

Copy Code
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 (-eq) False ($False). The filtered collection is then piped to Enable-CsPublicProvider, which enables each provider.

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

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

Example 3 enables all the public providers (assuming these providers are not already enabled) where the verification level 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 (-eq) AlwaysVerifiable; and, 2) the Enabled property is equal to False ($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.