New-CsXmppAllowedPartner
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 Skype for Business Server users. This cmdlet was introduced in Lync Server 2013.
Syntax
New-CsXmppAllowedPartner
-Domain <String>
[-AdditionalDomains <PSListModifier>]
[-Confirm]
[-ConnectionLimit <UInt32>]
[-Description <String>]
[-EnableKeepAlive <Boolean>]
[-Force]
[-InMemory]
[-PartnerType <PartnerType>]
[-ProxyFqdn <String>]
[-SaslNegotiation <SaslNegotiation>]
[-SupportDialbackNegotiation <Boolean>]
[-TlsNegotiation <TlsNegotiation>]
[-WhatIf]
[<CommonParameters>] New-CsXmppAllowedPartner
[-Identity] <XdsGlobalRelativeIdentity>
[-AdditionalDomains <PSListModifier>]
[-Confirm]
[-ConnectionLimit <UInt32>]
[-Description <String>]
[-EnableKeepAlive <Boolean>]
[-Force]
[-InMemory]
[-PartnerType <PartnerType>]
[-ProxyFqdn <String>]
[-SaslNegotiation <SaslNegotiation>]
[-SupportDialbackNegotiation <Boolean>]
[-TlsNegotiation <TlsNegotiation>]
[-WhatIf]
[<CommonParameters>] 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.
Skype for Business Server Control Panel: To create a new XMPP allowed partner using Skype for Business Server Control Panel, click External User Access, click XMPP Federated Partners and then click New.
Examples
-------------------------- Example 1 --------------------------
New-CsXmppAllowedPartner -Identity "contoso.com" -PartnerType "PublicVerified"The command shown in Example 1 creates a new XMPP allowed partner: contoso.com. In this example, the PartnerType property is set to "PublicVerified".
-------------------------- Example 2 --------------------------
New-CsXmppAllowedPartner -Identity "fabrikam.com" -AdditionalDomains "research.fabrikam2.com"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.
Parameters
-AdditionalDomains
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"
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-ConnectionLimit
Specifies the maximum number of simultaneous connections allowed to a specific partner.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Description
Enables administrators to provide additional text regarding the XMPP allowed partner. For example, the Description might include contact information for the partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Domain
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-EnableKeepAlive
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-Identity
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.
| Type: | XdsGlobalRelativeIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-InMemory
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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-PartnerType
Specifies the relationship between Skype for Business Server and the XMPP partner. Allowed values are:
Federated (the XMPP partner is from a federated domain)
PublicVerified
PublicUnverified
The default value is PublicUnverified.
| Type: | PartnerType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-ProxyFqdn
Full qualified domain name of the proxy server used by the XMPP partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-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.
| Type: | SaslNegotiation |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-SupportDialbackNegotiation
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-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.)
| Type: | TlsNegotiation |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015 |
Inputs
None.
The New-CsXmppAllowedPartner cmdlet does not accept pipelined input.
Outputs
The New-CsXmppAllowedPartner cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for