Set-CsMobilityPolicy
Topic Last Modified: 2012-04-23
Modifies an existing mobility policy. 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
Set-CsMobilityPolicy [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EnableMobility <$true | $false>] [-EnableOutsideVoice <$true | $false>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-CsMobilityPolicy [-Confirm [<SwitchParameter>]] [-Description <String>] [-EnableMobility <$true | $false>] [-EnableOutsideVoice <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Lync 2010 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. These policies can be modified at any time by using the Set-CsMobilityPolicy cmdlet.
Other than a description of the policy, mobility policies have only two properties. The first, EnableOutsideVoice, determines whether or not Call via Work is enabled; the second, EnableMobility, determines whether or not users are allowed to use Lync Mobile. Both of these properties must be set to true before a user can take advantage of Call via Work. If EnableMobility is set to True and EnableOutsideVoice is set to False, the user can run Microsoft Lync Mobile but will not be able to use Call via Work. If EnableMobility is set to False and EnableOutsideVoice is set to True the user will not be able to run Microsoft Lync Mobile. In turn, that means that the user will not be able to use Call via Work, regardless of the value of the EnableOutsideVoice property.
To use Call via Work, users must be managed by a voice policy that allows simultaneous ringing.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsMobilityPolicy cmdlet locally: RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
Unique identifier assigned to the policy when it was created. Mobility policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: -Identity global To refer to a policy at the site scope, use syntax similar to this: -Identity site:Redmond To refer to a per-user policy, use syntax similar to this: -Identity RedmondMobilityPolicy If you do not specify an Identity, then Set-CsMobilityPolicy will modify the global policy. |
Description |
Optional |
String |
Enables administrators to provide additional text to accompany a mobility policy. For example, the Description might include information about the users the policy should be assigned to. |
EnableMobility |
Optional |
Boolean |
When set to True, users are allowed to use Microsoft Lync 2010 Mobile. |
EnableOutsideVoice |
Optional |
Boolean |
When set to True, enables users to take advantage of Call via Work. When set to False, users cannot use Call via Work. The default value is True. |
Instance |
Optional |
Mobility object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
Force |
Optional |
SwitchParameter |
Suppresses the display of any non-fatal error message that might occur 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.Policy.Mobility.Mobility. Set-CsMobilityPolicy accepts pipelined instances of the Mobility object.
Return Types
None. Instead, Set-CsMobilityPolicy modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object.
Example
-------------------------- Example 1 --------------------------
Set-CsMobilityPolicy -Identity "site:Redmond" -EnableOutsideVoice $False
In Example 1, Call via Work is disabled in the mobility policy assigned to the Redmond site. This is done by setting the EnableOutsideVoice property to False.
-------------------------- Example 2 --------------------------
Get-CsMobilityPolicy -Filter "tag:*" | Set-CsMobilityPolicy -EnableOutsideVoice $False
The command shown in Example 2 disables Call via Work for all the mobility policies configured at the per-user scope. To carry out this task, the command first calls the Get-CsMobilityPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the returned data to policies that have an Identity that begins with the string value "tag:". That filtered collection of policies is then piped to the Set-CsMobilityPolicy cmdlet, which takes each policy in the collection and sets the EnableOutsideVoice property to False.
-------------------------- Example 3 --------------------------
Get-CsMobilityPolicy | Where-Object {$_.Description -eq $Null} | Set-CsMobilityPolicy -Description "Policy owner: kenmyer@litwareinc.com"
In the preceding command, a new description is added to any mobility policy property that does not currently have a description. To do this, the first uses Get-CsMobilityPolicy to return a collection of all the mobility policies currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the Description property is equal to (-eq) a null value. That filtered collection is then piped to the Set-CsMobilityPolicy cmdlet, which sets the Description property for each policy to the string value "Policy owner: kenmyer@litwareinc.com".