Topic Last Modified: 2013-02-22

Retrieves information about the Lync Server Mobility Service configuration settings currently in use in your organization. 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 Lync Server capabilities such as Call via Work and dial-out conferencing. This cmdlet was introduced in the cumulative update for Lync Server 2010: November 2011.

Syntax

Get-CsMcxConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsMcxConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

Examples

EXAMPLE 1

The command shown in Example 1 returns information about all the Mobility Service configuration settings currently in use in your organization.

Copy Code
Get-CsMcxConfiguration

EXAMPLE 2

In Example 2, information is returned only for the global collection of Mobility Service configuration settings.

Copy Code
Get-CsMcxConfiguration -Identity "global"

EXAMPLE 3

Example 3 returns information about all the Mobility Service configuration settings assigned to the service scope. To do this, the Filter parameter is included along with the string value "service:*". That filter value returns all the Mobility Service configuration settings that have an Identity that begins with the string value "service:".

Copy Code
Get-CsMcxConfiguration -Filter "service:*"

EXAMPLE 4

In Example 4, the only Mobility Service configuration settings returned are those where the ExposedWebURL property is equal to External. To do this, the command first calls the Get-CsMcxConfiguration cmdlet without any parameters in order to return a collection of all the Mobility Service configuration settings currently in use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the ExposedWebURL property is equal to (-eq) External.

Copy Code
Get-CsMcxConfiguration | Where-Object {$_.ExposedWebURL -eq "External"}

EXAMPLE 5

Example 5 returns any and all of the Mobility Service configuration settings where the SessionExpirationInterval property is set to a value less than the default value of 259200 seconds (72 hours). This is done by first using the Get-CsMcxConfiguration cmdlet to return a collection of all the existing Mobility Service configuration settings. That collection is then piped to the Where-Object cmdlet, which, in turn, selects only those settings where the SessionExpirationInterval property is less than 259200.

Copy Code
Get-CsMcxConfiguration | Where-Object {$_.SessionExpirationInterval -lt 259200}

Detailed Description

Lync Server Mobility Service extends many of the capabilities of Lync Server 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 Push Notification Service), users with iPhones or Windows Phones can receive these notifications even if Lync 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 see 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 Lync Server 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 Get-CsMcxConfiguration cmdlet provides a way for administrators to retrieve information about all the Mobility Service configuration settings currently in use in their organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsMcxConfiguration cmdlet locally: RTCUniversalServerAdmins.

Parameters

Parameter Required Type Description

Filter

Optional

System.String

Enables you to use wildcard characters in order to return a collection of Mobility Service configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax:

-Filter site:*

To return a collection of all the settings configured at the service scope, use this syntax:

-Filter service:*

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

Indicates the unique identifier for the collection of Mobility Service configuration settings you want to return. To refer to the global settings, use this syntax:

-Identity global

To refer to a collection configured at the site scope, use syntax similar to this:

-Identity site:Redmond

To refer to a collection configured at the service scope, use syntax like this:

-Identity service:WebServer:atl-cs-001.litwareinc.com

Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards then use the Filter parameter instead.

If this parameter is not specified, then the Get-CsMcxConfiguration cmdlet returns a collection of all the Mobility Service configuration settings in use in the organization.

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the Mobility Service configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

The Get-CsMcxConfiguration cmdlet does not accept pipelined input.

Return Types

The Get-CsMcxConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object.