Export (0) Print
Expand All
Expand Minimize

Remove-CsXmppAllowedPartner

Lync Server 2013
 

Topic Last Modified: 2013-02-21

Removes an existing XMPP allowed partner. The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Lync Server 2013 users. This cmdlet was introduced in Lync Server 2013.

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

Example 1 deletes the XMPP allowed partner with the Identity "contoso.com".

Remove-CsXmppAllowedPartner -Identity "contoso.com"

The command shown in Example 2 deletes all the XMPP allowed partners. To carry out this task the command first calls the Get-CsXmppAllowedPartner cmdlet to return a collection of all the XMPP allowed partners currently in use in the organization. This collection is then piped to the Remove-CsXmppAllowedPartner cmdlet, which removes each partner in the collection.

Get-CsXmppAllowedPartner | Remove-CsXmppAllowedPartner

In Example 3, all the XMPP allowed partners with a partner type of PublicUnverified are deleted. To do this, the command first uses the Get-CsXmppAllowedPartner cmdlet to return a collection of all the allowed partners. This collection is then piped to the Where-Object cmdlet, which picks out only those partners where the PartnerType property is equal to "PublicUnverified". The partners that meet that criterion are then piped to, and deleted by, the Remove-CsXmppAllowedPartner cmdlet.

Get-CsXmppAllowedPartner | Where-Object {$_.PartnerType -eq "PublicUnverified"} | Remove-CsXmppAllowedPartner

The Extensible Messaging and Presence Protocol (XMPP) is a standard communications protocol (based on XML) used for sending messages across the Internet. XMPP was originally named Jabber, and is supported by a number of Internet messaging and communication applications, including Google Talk and Facebook Chat.

In order for your users to be able to exchange instant messages and presence information with users on an XMPP network, that network must be configured as an XMPP allowed partner. (You must also assign your users an external access policy that allows XMPP access.) By design, your users will be allowed to communicate with users on any XMPP network that is listed on the allowed partners list. If you do not want users communicating with users from a given network then you must delete that network from the allowed partners list.

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 command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsXmppAllowedPartner"}

Lync Server Control Panel: To remove an XMPP allowed partner using the Lync Server Control Panel, click External User Access and then click XMPP Federated Partners. Select the partner to be removed, click Edit, and then click Delete.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity

Fully qualified domain name (FQDN) of the XMPP allowed partner to be deleted. For example:

-Identity "fabrikam.com"

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

The Remove-CsXmppAllowedPartner cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object.

None. Instead, the Remove-CsXmppAllowedPartner cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object.

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