New-CsLocationPolicy
Topic Last Modified: 2012-03-26
Creates a new location policy for use with location identification for the Enhanced 9-1-1 (E9-1-1) service and general client location. The E9-1-1 service enables those who answer 911 calls to determine the caller’s geographic location.
Syntax
New-CsLocationPolicy -Identity <XdsIdentity> [-ConferenceMode <Nullable>] [-ConferenceUri <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EmergencyDialMask <String>] [-EmergencyDialString <String>] [-EnhancedEmergencyServicesEnabled <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-LocationRequired <Nullable>] [-NotificationUri <String>] [-PstnUsage <String>] [-UseLocationForE911Only <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The location policy is used to apply settings that relate to E9-1-1 functionality and location settings to users or contacts. 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 creates a new location policy at the site or per-user scope. (A policy at the global scope already exists.)
IMPORTANT: The location policy behaves differently from other policies in Lync Server 2010 in terms of order of scope. For all other policies, if a policy is defined at the per-user scope, the policy is applied to any user granted that policy. If the user has not been granted a per-user policy, the site policy is applied. If there is no site policy, the global policy is applied. Location policies are applied in the same way, with one exception: a per-user location policy can also be assigned to a network site. (A network site consists of a group of subnets.) If the user is making the emergency call from a location that is mapped to a network site within the organization, the user-level policy assigned to that network site is used. This functionality will override a per-user policy that has been granted to that user. If the user calls from a location that is unknown or unmapped in the organization, the standard policy scoping will be applied.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-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 "New-CsLocationPolicy"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
A unique identifier for the location policy. This cmdlet can be used to create policies at the site or per-user scope. (A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must 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. A policy created at the per-user scope can be assigned any string value, such as Reno. |
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, “Reno corporate users”. |
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 digits in length. |
EnhancedEmergencyServicesEnabled |
Required |
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 2010 clients will retrieve location information on registration and include that information when an emergency call is made. Default Value: False |
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 operator (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 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 emergency 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. |
InMemory |
Optional |
SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
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
None.
Return Types
Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy.
Example
-------------------------- Example 1 --------------------------
New-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True
Example 1 uses New-CsLocationPolicy to create a new location policy for the Redmond site that enables all users on that site for E9-1-1. To create this policy, New-CsLocationPolicy is called along with two parameters: one to set the Identity, which in this case is the string site: followed by the name of the site to which this policy will apply; the other to set the value of the EnhancedEmergencyServicesEnabled property to True.
-------------------------- Example 2 --------------------------
New-CsLocationPolicy -Identity Reno -Description "All users located at the Reno site" -EnhancedEmergencyServicesEnabled $True -PstnUsage Emergency -EmergencyDialString 911
This example creates a per-user location policy. (Per-user policies must be specifically granted to individual users or groups.) This policy has an Identity of Reno. We’ve added a more detailed description of the policy by using the Description parameter. The next parameter we supply is EnhancedEmergencyServicesEnabled, which is set to True to turn on E9-1-1 functionality for all users to which this policy is granted. The next parameter is PstnUsage, in this case with a value of Emergency. This value must match a value in the list of PSTN usages. (This list can be retrieved by calling Get-CsPstnUsage.) The usage should be associated with a voice route that will be used for emergency calls. (You can retrieve voice routes by calling the Get-CsVoiceRoute cmdlet.) The final parameter used in this example is EmergencyDialString, which specifies the number that is dialed to make an emergency call.