Topic Last Modified: 2013-02-21

Creates a new 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 have been authorized to exchange instant messages and presence information with your Lync Server 2013 users. This cmdlet was introduced in Lync Server 2013.

Syntax


`New-CsXmppAllowedPartner -Domain <String> <COMMON PARAMETERS>`


`New-CsXmppAllowedPartner -Identity <XdsGlobalRelativeIdentity> <COMMON PARAMETERS>`


COMMON PARAMETERS: [-AdditionalDomains <PSListModifier>] [-Confirm [<SwitchParameter>]] [-ConnectionLimit <UInt32>] [-Description <String>] [-EnableKeepAlive <$true \| $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-PartnerType <Federated \| PublicVerified \| PublicUnverified>] [-ProxyFqdn <String>] [-SaslNegotiation <Required \| Optional \| NotSupported>] [-SupportDialbackNegotiation <$true \| $false>] [-TlsNegotiation <Required \| Optional \| NotSupported>] [-WhatIf [<SwitchParameter>]]

COMMON PARAMETERS: [-AdditionalDomains
<PSListModifier>] [-Confirm [<SwitchParameter>]]
[-ConnectionLimit <UInt32>] [-Description <String>]
[-EnableKeepAlive <$true | $false>] [-Force
<SwitchParameter>] [-InMemory <SwitchParameter>]
[-PartnerType <Federated | PublicVerified |
PublicUnverified>] [-ProxyFqdn <String>] [-SaslNegotiation
<Required | Optional | NotSupported>]
[-SupportDialbackNegotiation <$true | $false>]
[-TlsNegotiation <Required | Optional | NotSupported>]
[-WhatIf [<SwitchParameter>]]

Examples

Example 1

The command shown in Example 1 creates a new XMPP allowed partner: contoso.com. In this example, the PartnerType property is set to "PublicVerified".

	Copy Code
New-CsXmppAllowedPartner -Identity "contoso.com" -PartnerType "PublicVerified"

Example 2

Example 2 creates a new XMPP allowed partner with the Identity fabrikam.com. In addition to the root domain (fabrikam.com), the AdditionalDomains property is included to allow support for the child domain research.fabrikam2.com.

	Copy Code
New-CsXmppAllowedPartner -Identity "fabrikam.com" -AdditionalDomains "research.fabrikam2.com"

Detailed Description

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 "New-CsXmppAllowedPartner"}

Lync Server Control Panel: To create a new XMPP allowed partner using Lync Server Control Panel, click External User Access, click XMPP Federated Partners, and then click New.

Parameters

Parameter	Required	Type	Description
Domain	Required	System.String	Primary domain of the XMPP allowed partner; for example: -Domain "fabrikam.com" You can specify the primary domain by using either the Domain parameter or the Identity parameter. However, you cannot use both parameters in the same command. Additional domains can be specified by using the AdditionalDomains parameter.
Identity	Required	Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity	Primary domain of the XMPP allowed partner; for example: -Identity "fabrikam.com" You can specify the primary domain by using either the Identity parameter or the Domain parameter. However, you cannot use both parameters in the same command. Additional domains can be specified by using the AdditionalDomains parameter.
AdditionalDomains	Optional	System.Management.Automation.PSListModifier	Additional XMPP domains belonging to the allowed partner. Multiple domains can be specified by separated domain names by using commas; for example: -AdditionalDomains "fabrikam2.com","fabrikam3.com"
Confirm	Optional	System.Management.Automation.SwitchParameter	Prompts you for confirmation before executing the command.
ConnectionLimit	Optional	System.UInt32	Specifies the maximum number of simultaneous connections allowed to a specific partner.
Description	Optional	System.String	Enables administrators to provide additional text regarding the XMPP allowed partner. For example, the Description might include contact information for the partner.
EnableKeepAlive	Optional	System.Boolean	Indicates whether or not the XMPP partner should periodically transmit "keep alive" packets in order to verify that the connection is still active. The default value is True.
Force	Optional	System.Management.Automation.SwitchParameter	Suppresses the display of any non-fatal error message that might occur when running the command.
InMemory	Optional	System.Management.Automation.SwitchParameter	Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.
PartnerType	Optional	Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.PartnerType	Specifies the relationship between Lync Server 2013 and the XMPP partner. Allowed values are: * Federated (the XMPP partner is from a federated domain) * PublicVerified * PublicUnverified The default value is PublicUnverified.
ProxyFqdn	Optional	System.String	Full qualified domain name of the proxy server used by the XMPP partner.
SaslNegotiation	Optional	Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.SaslNegotiation	Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication. Allowed values are: * Required (SASL negotiation must be supported) * Optional (SASL will be used if available) * NotSupported (SASL negotiation will not be supported) The default value is Required.
SupportDialbackNegotiation	Optional	System.Boolean	Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity of Server A by contacting the authoritative DNS server for the domain that Server A claims to be from. Note that dialback negotiation is not as secure as SASL or TLS. Instead, it is primarily used in situations where certificates cannot be used to verify a server's identity. The default value is True.
TlsNegotiation	Optional	Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.TlsNegotiation	Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams. Allowed values are: * Required (TLS negotiation must be supported) * Optional (TLS will be used if available) * NotSupported (TLS negotiation will not be support The default value is Required.)
WhatIf	Optional	System.Management.Automation.SwitchParameter	Describes what would happen if you executed the command without actually executing the command.

Input Types

None. The New-CsXmppAllowedPartner cmdlet does not accept pipelined input.

Return Types

The New-CsXmppAllowedPartner cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object.