Set-CsXmppGatewayConfiguration
Modifies the XMPP gateway configuration settings in use in the organization. The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. XMPP gateways enable Skype for Business Server users to exchange instant message and presence information with users from IM and presence providers that employ XMPP. This cmdlet was introduced in Lync Server 2013.
Syntax
Identity
Set-CsXmppGatewayConfiguration
[[-Identity] <XdsIdentity>]
[-Confirm]
[-ConnectionLimit <UInt32>]
[-DialbackPassphrase <String>]
[-EnableLoggingAllMessageBodies <Boolean>]
[-Force]
[-KeepAliveInterval <UInt32>]
[-PartnerConnectionLimit <UInt32>]
[-StreamEstablishmentTimeout <UInt32>]
[-StreamInactivityTimeout <UInt32>]
[-SubscriptionRefreshInterval <UInt32>]
[-WhatIf]
[<CommonParameters>]
Instance
Set-CsXmppGatewayConfiguration
[-Confirm]
[-ConnectionLimit <UInt32>]
[-DialbackPassphrase <String>]
[-EnableLoggingAllMessageBodies <Boolean>]
[-Force]
[-Instance <PSObject>]
[-KeepAliveInterval <UInt32>]
[-PartnerConnectionLimit <UInt32>]
[-StreamEstablishmentTimeout <UInt32>]
[-StreamInactivityTimeout <UInt32>]
[-SubscriptionRefreshInterval <UInt32>]
[-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.
The XMPP gateway that enables Skype for Business to communicate with users on an XMPP network was originally released as an add-on to Microsoft Lync Server 2010; in Skype for Business Server, this functionality is built into the software. This means that your users can communicate with XMPP users provided that you:
Configure the XMPP gateway settings.
Configure the other XMPP network (for example, Google Talk) as an allowed XMPP partner.
Note that Skype for Business Server provides only a single, global set of XMPP configuration settings: you cannot selectively enable or disable XMPP for a given site or a given Registrar pool. In fact you cannot enable or disable XMPP at all: XMPP is always enabled. If you do not want users communicating with XMPP networks then you should remove all the allowed XMPP partners. Users can only communicate with an XMPP network if that network has been configured as an allowed partner.
Skype for Business Server Control Panel: The functions carried out by the Set-CsXmppGatewayConfiguration cmdlet are not available in the Skype for Business Server Control Panel
Examples
Example 1
Set-CsXmppGatewayConfiguration -Identity "global" -ConnectionLimit 1200
Example 1 modifies the ConnectionLimit property for the global collection of XMPP gateway settings.
Parameters
-Confirm
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ConnectionLimit
Applicable: Lync Server 2013, Skype for Business Server 2015
Total number of simultaneous connections allowed for all XMPP partners. The default value is 1000.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DialbackPassphrase
Applicable: Lync Server 2013, Skype for Business Server 2015
Password used when connecting to an XMPP partner over a TCP dialback connection. With TCP dialback, the partner contacts the XMPP gateway and then hangs up. The XMPP gateway calls the partner back, and the communication session can then begin.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableLoggingAllMessageBodies
Applicable: Lync Server 2013, Skype for Business Server 2015
When set to True, Skype for Business Server will log the actual content of all instant messages. For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files.
The default value is False.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2013, Skype for Business Server 2015
Suppresses the display of any non-fatal error message that might occur when running the command
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2013, Skype for Business Server 2015
Unique identifier for the XMPP gateway configuration settings to be modified.
Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Set-CsXmppGatewayConfiguration cmdlet.
If you prefer, however, you can use the following syntax to reference the global settings:
-Identity global
Parameter properties
| Type: | XdsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Instance
Applicable: Lync Server 2013, Skype for Business Server 2015
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Instance
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-KeepAliveInterval
Applicable: Lync Server 2013, Skype for Business Server 2015
Maximum amount of time (in seconds) that can elapse before the partner must send a "keep alive" message. (A keep alive message simply verifies that the connection is still active.) If the time interval expires before a keep alive message is received, the connection will be closed. The default value is 300 seconds.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PartnerConnectionLimit
Applicable: Lync Server 2013, Skype for Business Server 2015
Total number of simultaneous connections allowed for a single XMPP partner. The default value is 20.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StreamEstablishmentTimeout
Applicable: Lync Server 2013, Skype for Business Server 2015
Maximum amount of time (in seconds) allotted for the XMPP partner to establish an XMPP stream. If this timeout period is surpassed the connection will automatically be terminated. The default value is 60 seconds.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StreamInactivityTimeout
Applicable: Lync Server 2013, Skype for Business Server 2015
Maximum amount of time (in seconds) that an XMPP stream can be inactive before the connection is automatically terminated. The default value is 600 seconds (10 minutes).
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionRefreshInterval
Applicable: Lync Server 2013, Skype for Business Server 2015
Maximum amount of time (in seconds) that can elapse before the partner must refresh its presence subscription. The default value is 28800 seconds (8 hours).
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2013, Skype for Business Server 2015
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings
The Set-CsXmppGatewayConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object.
Outputs
None
Instead, the Set-CsXmppGatewayConfiguration cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object.