Set-CsLocationPolicy
Topic Last Modified: 2012-03-26
Modifies an existing location policy.
Syntax
Set-CsLocationPolicy [-Identity <XdsIdentity>] [-ConferenceMode <Nullable>] [-ConferenceUri <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EmergencyDialMask <String>] [-EmergencyDialString <String>] [-EnhancedEmergencyServicesEnabled <$true | $false>] [-Force <SwitchParameter>] [-LocationRequired <Nullable>] [-NotificationUri <String>] [-PstnUsage <String>] [-UseLocationForE911Only <Nullable>] [-WhatIf [<SwitchParameter>]]
Set-CsLocationPolicy [-ConferenceMode <Nullable>] [-ConferenceUri <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EmergencyDialMask <String>] [-EmergencyDialString <String>] [-EnhancedEmergencyServicesEnabled <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-LocationRequired <Nullable>] [-NotificationUri <String>] [-PstnUsage <String>] [-UseLocationForE911Only <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The location policy is used to apply settings that relate to Enhanced 9-1-1 (E9-1-1) functionality and client location. The location policy determines whether a user is enabled for E9-1-1, and if so what the behavior is of an emergency call. For example, you can use the location policy to define what number constitutes an emergency call (911 in the United States), whether corporate security should be automatically notified, and how the call should be routed. This cmdlet modifies an existing location policy.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsLocationPolicy cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsLocationPolicy"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
The unique identifier of the location policy you want to modify. To modify the global location policy, use a value of Global. For a policy created at the site scope, this value will be in the form site:<site name>, where site name is the name of a site defined in the Microsoft Lync Server 2010 deployment (for example, site:Redmond). For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. |
Instance |
Optional |
LocationPolicy |
A reference to a location policy object. This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy, which can be retrieved by calling Get-CsLocationPolicy. Retrieve this object, change the properties in memory, and then pass the object reference as a value to this parameter to update that location policy. |
ConferenceMode |
Optional |
ConferenceModeEnum |
If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are: - oneway: Third party can only listen to the conversation between the caller and the Public Safety Answering Point (PSAP) operator. - twoway: Third party can listen in and participate in the call between the caller and the PSAP operator. |
ConferenceUri |
Optional |
String |
The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property). The string must be from 1 to 256 characters in length and must begin with the prefix sip:. |
Description |
Optional |
String |
A detailed description of this location. For example, “Building 30, 3rd Floor, Northeast corner”. |
EmergencyDialMask |
Optional |
String |
A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of "212" and EmergencyDialString has a value of "911", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region’s number rather than the number for the country/region they’re currently in). You can define multiple emergency dial masks by separating the values with semicolons. For example, -EmergencyDialMask “212;414”. IMPORTANT. Ensure that the specified dial mask value is not the same as a number in a call park orbit range. Call park routing will take precedence over emergency dial string conversion. To see the existing call park orbit ranges, call the Get-CsCallParkOrbit cmdlet. Maximum length of the string is 100 characters. Each character must be a digit 0 through 9. |
EmergencyDialString |
Optional |
String |
The number that is dialed to reach emergency services. In the United States this value is “911”. The string must be made of the digits 0 through 9 and can be from 1 to 10 characters in length. |
EnhancedEmergencyServicesEnabled |
Optional |
Boolean |
Specifies whether the users associated with this policy are enabled for E9-1-1. Set the value to True to enable E9-1-1, so Lync Server clients will retrieve location information on registration and include that information when an emergency call is made. |
LocationRequired |
Optional |
LocationRequiredEnum |
If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. This parameter accepts the following values: - no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. - yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP (that is, the 911 operator). - disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.) This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). Users will not be prompted for location information. |
NotificationUri |
Optional |
String |
One or more SIP Uniform Resource Identifiers (URIs) to be notified when an emergency call is made. For example, the company security office could be notified through an instant message whenever an emergency call is made. If the caller’s location is available that location will be included in the notification. Multiple SIP URIs can be included as a comma-separated list. For example, -NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com. Keep in mind that distribution lists and group URIs are not supported. The string must be from 1 to 256 characters in length and must begin with the prefix sip:. |
PstnUsage |
Optional |
String |
The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route 911 calls from clients using this profile. The route associated with this usage should point to a SIP trunk dedicated to emergency calls. The usage must already exist in the global list of PSTN usages. Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. To create a new usage, call the Set-CsPstnUsage cmdlet. |
UseLocationForE911Only |
Optional |
Boolean |
Location information can be used by the Microsoft Lync 2010 client for various reasons (such as notifying teammates of current location). Set this value to True to ensure location information is available only for use with an emergency call. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
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.WritableConfig.Policy.Location.LocationPolicy object. Accepts pipelined input of location policy objects.
Return Types
This cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object.
Example
-------------------------- Example 1 --------------------------
Set-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True
This command uses the Set-CsLocationPolicy cmdlet to modify the location policy with the Identity site:Redmond. (In other words, it modifies the location policy applied to the Redmond site.) In this case, the command sets the value of the EnhancedEmergencyServicesEnabled property to True, which will enable E9-1-1 functionality for all users connected to (in this case) the Redmond site.
-------------------------- Example 2 --------------------------
Get-CsLocationPolicy | Where-Object {$_.ConferenceUri -ne $null} | Set-CsLocationPolicy -ConferenceMode twoway
Example 2 modifies all the location policies in use in the organization that have defined a conferencing URI to have a conferencing mode of two-way. To carry out this task, the command first uses Get-CsLocationPolicy to return a collection of all the location policies currently defined. This collection is then piped to the Where-Object cmdlet to narrow the collection down to only those location policies that have a ConferenceUri property that is not empty (not equal to Null). This results in a collection of location policies that have ConferenceUri values. This collection is then piped to Set-CsLocationPolicy, which then modifies the value of the ConferenceMode property for each policy in the collection by setting the value to twoway.