Removes 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
Remove-CsPublicProvider -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
String |
Unique identifier for the public provider to be removed. 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.). |
|
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 simply 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.) If you decide later on to terminate this relationship, you can use the Remove-CsPublicProvider cmdlet to delete the public provider. When you delete a public provider, the provider is removed from your list of federated partners; at that point, the only way to re-establish the relationship is to recreate the provider. If you want to temporarily suspend a relationship, use the Disable-CsPublicProvider cmdlet instead. When a public provider is disabled the provider is not deleted from the list if federated partners; instead, the provider is simply marked as disabled and communication between your organization and that provider is suspended. To re-establish the relationship you can simply use Enable-CsPublicProvider to re-enable the provider.
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
Deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.DisplayPublicProvider object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsPublicProvider -Identity "AOL" |
|
The preceding command deletes the public provider with the Identity AOL. After this command has completed, AOL will no longer appear in the list of configured public providers; at that point, the only way to re-establish federation with AOL is to re-create the provider.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsPublicProvider | Remove-CsPublicProvider |
|
Example 2 deletes all the public providers configured for use in the organization. To do this, the command first uses Get-CsPublicProvider to return a collection of all the public providers currently configured. This collection is then piped to Remove-CsPublicProvider, which, in turn, deletes each provider in the collection.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Remove-CsPublicProvider
|
|
In Example 3, all the public providers that are currently disabled are removed from the set of configured pubic providers. To carry out this task, the command first uses Get-CsPublicProvider to return a collection of all the public providers currently configured for use. This collection is piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False ($False). That filtered collection is then piped to Remove-CsPublicProvider, which deletes all the items in the collection.