Export (0) Print
Expand All
Expand Minimize

Remove-CsPublicProvider

 

Topic Last Modified: 2012-03-26

Removes a public provider configured for use in your organization. A public provider is an organization that provides instant messaging (IM), 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.

Remove-CsPublicProvider -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

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 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.) 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 re-create 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 of 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 use Enable-CsPublicProvider to re-enable the provider.

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

 

Parameter Required Type Description

Identity

Required

String

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

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. Remove-CsPublicProvider accepts pipelined instances of the public provider object.

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

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

Remove-CsPublicProvider -Identity "MSN"

The preceding command deletes the public provider with the Identity MSN. After this command has completed, MSN will no longer appear in the list of configured public providers; at that point, the only way to re-establish federation with MSN is to re-create the provider.

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

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 for use. This collection is then piped to Remove-CsPublicProvider, which, in turn, deletes each provider in the collection.

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

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. That filtered collection is then piped to Remove-CsPublicProvider, which deletes all the items in the collection.

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