Get-CsMobilityPolicy
Topic Last Modified: 2012-04-23
Retrieves information about the mobility policies currently in use in an organization. Mobility policies determine whether or not a user can use Microsoft Lync 2010 Mobile. These policies also manage a user's ability to employ Call via Work, a feature that enables users to make and receive phone calls on their mobile phone by using their work phone number instead of their mobile phone number.
Syntax
Get-CsMobilityPolicy [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsMobilityPolicy [-Filter <String>] [-LocalStore <SwitchParameter>]
Detailed Description
Lync Mobile is a client application that enables users to run Microsoft Lync 2010 on their mobile phones. Call via Work provides a way for users to make calls on their mobile phone and yet have it appear as though the call originated from their work phone number instead of their mobile phone number. Users who have been enabled for Call via Work can achieve this either by dialing directly from their mobile phone or by using the dial-out conferencing option. With dial-out conferencing, a user effectively asks the Microsoft Lync Server 2010 Mobility Service server to make a call for them. The server will set up the call, and then call the user back on their mobile phone. After the user has answered, the server will then dial the party being called.
Both of these capabilities – the ability to run Lync 2010 Mobile and the ability to use Call via Work – are managed using mobility policies.
Mobility policies can be configured at the global, site, or the per-user scope, and information about those policies can be retrieved by using the Get-CsMobilityPolicy cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsMobilityPolicy cmdlet locally: RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
Unique identifier of the mobility policy to be returned. To refer to the global policy, use this syntax: -Identity global To refer to a site policy, use syntax similar to this: -Identity site:Redmond To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy If this parameter is not specified, then Get-CsMobilityPolicy returns a collection of all the mobility policies in use in the organization. |
Filter |
Optional |
String |
Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return all the policies configured at the site scope use this syntax: -Filter "site:*" To return a collection of all the per-user policies, use this syntax: -Filter "tag:*" |
LocalStore |
Optional |
SwitchParameter |
Retrieves the mobility policy data from the local replica of the Central Management store rather than from the Central Management store itself. |
Input Types
Get-CsMobilityPolicy does not accept pipelined input.
Return Types
Get-CsMobilityPolicy returns instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object.
Example
-------------------------- Example 1 --------------------------
Get-CsMobilityPolicy
The command shown in Example 1 returns information about all the mobility policies configured for use in your organization.
-------------------------- Example 2 --------------------------
Get-CsMobilityPolicy -Identity "site:Redmond"
Example 2 returns information about a single mobility policy: the policy with the Identity site:Redmond.
-------------------------- Example 3 --------------------------
Get-CsMobilityPolicy -Filter "tag:*"
In Example 3, information is returned for all of your per-user mobility policies. To do this, the Filter parameter is included along with the filter value "tag:*"; this returns any policy that has an Identity that begins with the string value "tag:". By definition, any policy that has an identity beginning with that string value is a per-user policy.
-------------------------- Example 4 --------------------------
Get-CsMobilityPolicy | Where-Object {$_.EnableOutsideVoice -eq $False}
The command shown in Example 4 limits the returned data to mobility policies where Call via Work has been disabled. To carry out this task, the command first calls the Get-CsMobilityPolicy cmdlet without any parameters; that returns a collection of all the mobility policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those policies where the EnableOutsideVoice property is equal to (-eq) False.