Set-CsMcxConfiguration
Topic Last Modified: 2012-04-23
Modifies an existing collection of Microsoft Lync Server 2010 Mobility Service configuration settings. The Mobility Service enables users of mobile phones such as iPhones and Windows Phones to do such things as exchange instant messages and presence information; store and retrieve voice mail internally instead of with their wireless provider; and take advantage of Microsoft Lync Server 2010 capabilities such as Call via Work and dial-out conferencing.
Syntax
Set-CsMcxConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-ExposedWebURL <External | Internal>] [-Force <SwitchParameter>] [-PushNotificationProxyUri <String>] [-SessionExpirationInterval <UInt32>] [-SessionShortExpirationInterval <UInt32>] [-WhatIf [<SwitchParameter>]]
Set-CsMcxConfiguration [-Confirm [<SwitchParameter>]] [-ExposedWebURL <External | Internal>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-PushNotificationProxyUri <String>] [-SessionExpirationInterval <UInt32>] [-SessionShortExpirationInterval <UInt32>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Microsoft Lync Server 2010 Mobility Service extends many of the capabilities of Microsoft Lync 2010 to mobile devices such as Apple iPhones, Windows Phone, Android phones, and Nokia phones. Among other things, users can use these phones to exchange instant message and presence information, and to receive notifications of new voice mails. Thanks to the push notification service (Apple Push Notification Service and Microsoft Lync Server 2010 Push Notification Service), users with iPhones or Windows Phones can receive these notifications even if Lync 2010 is running in the background. The Mobility Service also provides the opportunity for organizations to enable Call via Work. With Call via Work, users can make a call from their mobile phone and make it appear as though the call originated from their work phone; for example, Caller ID systems will display the user's work number instead of his or her mobile phone number.
The Mobility Service itself is managed by using Mobility Service configuration settings that can be applied to the global scope, the site scope, or the service scope (for the Web server service only). These settings control such things as the maximum length of time for a Mobility Service session; whether or not the Microsoft Lync Server 2010 Autodiscovery Service (which directs Mobility Service users to the appropriate Registrar pool) is available to users who log on outside the organization's firewall); and the location of the push notification service provider.
The Set-CsMcxConfiguration cmdlet provides a way for administrators to modify any of their existing Mobility Service configuration settings.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsMcxConfiguration cmdlet locally: RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
Represents the unique identifier of the collection of Mobility Service configuration settings to be modified. To modify the global settings, use the following syntax: -Identity global To modify settings at the site scope, use the prefix "site:" followed by the site name. For example: -Identity "site:Redmond" To modify settings configured at the service scope, use syntax like this: -Identity service:WebServer:atl-cs-001.litwareinc.com If this parameter is not specified, then Set-CsMcxConfiguration will modify the global settings. |
ExposedWebURL |
Optional |
ExposedWebURL object |
Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). Allowed values are: Internal or External. The default value is External. |
Instance |
Optional |
MCX Configuration object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
PushNotificationProxyUri |
Optional |
String |
URI of a service provider that can forward push notification requests to the Apple Push Notification Service and the Microsoft Lync Server 2010 Push Notification Service. The PushNotificationProxyUri must be in the form of a SIP address; for example: -PushNotificationProxyUri "sip:push@push.lync.com" |
SessionExpirationInterval |
Optional |
Integer |
Length of time, in seconds, of a mobile session for iPhone or Widows Phone users. If Lync 2010 is running in the background on these phones, users will receive push notifications as long as the session expiration interval has not expired. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. If it does not, the device will be listed as inactive and the user will have to log back on to the system. This property can be set to any integer value between 120 and 4294967295, inclusive. The default value is 259200 seconds (3 days). Note that the value of the SessionExpirationInterval property must be greater than the value of the SessionShortExpirationInterval property. |
SessionShortExpirationInterval |
Optional |
Integer |
Length of time, in seconds, of a mobile session for Android or Nokia phone users. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. If it does not, the device will be listed as inactive and the user will have to log back on to the system. This property can be set to any integer value between 120 and 4294967295, inclusive. The default value is 259200 seconds (3 days). Note that the value of the SessionExpirationInterval property must be greater than the value of the SessionShortExpirationInterval property. |
Force |
Optional |
SwitchParameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. Set-CsMcxConfiguration accepts pipelined instances of the McxConfiguration object.
Return Types
None. Instead, Set-CsMcxConfiguration modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object.
Example
-------------------------- Example 1 --------------------------
Set-CsMcxConfiguration -Identity site:Redmond -ExposedWebURL External
In Example 1, the ExposedWebURL property for the Mobility Service configuration settings assigned to the Redmond site is set to External.
-------------------------- Example 2 --------------------------
Get-CsMcxConfiguration | Set-CsMcxConfiguration -ExposedWebURL External
Example 2 shows how a single command can assign the same property value to all the Mobility Service configuration settings currently in use in an organization. To do this, the command first uses the Get-CsMcxConfiguration cmdlet without any parameters in order to return a collection of all the existing Mobility Service configuration settings. That collection is then piped to the Set-CsMcxConfiguration, which sets the ExposedWebURL property for each item in the collection to External.
-------------------------- Example 3 --------------------------
Get-CsMcxConfiguration | Where-Object {$_.SessionShortExpirationInterval -gt 3600} | Set-CsMcxConfiguration -SessionShortExpirationInterval 3600
In the preceding example, all the Mobility Service configuration settings that have a SessionShortExpirationInterval of more than 3600 seconds are modified to set that property value to 3600; that effectively makes 3600 seconds the maximum value for all the Mobility Service configuration settings in the organization. To do this, the Get-CsMcxConfiguration cmdlet is first called (without any parameters) in order to return a collection of all the Mobility Service configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the SessionShortExpirationInterval property is greater than (-gt) 3600. This filtered collection is then piped to Set-CsMcxConfiguration, which sets the value of the SessionShortExpirationInterval property for each item in the collection to 3600.