Creates a new location policy for use with location identification for the Enhanced 911 (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>]] |
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. 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 Communications Server deployment. For example, site:Redmond. A policy created at the per-user scope can be assigned any string value, such as Reno. |
|
Description |
Optional |
String |
A detailed description of this location. For example, “Reno corporate users”. |
|
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 Communications Server 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 Information Server (LIS) 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 Public Safety Answer Point (PSAP – the 911 operator). - disclaimer: This option is the same as yes except that the user cannot dismiss the prompt without entering location information. The user can still complete a 911 call, but no other calls can be completed without entering the information. In addition, disclaimer text will be displayed to the user that can alert them 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. Valid values are: no, yes, and disclaimer. |
|
UseLocationForE911Only |
Optional |
Boolean |
Location information can be used by the Microsoft Communicator 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. |
|
PstnUsage |
Optional |
String |
The 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. |
|
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. |
|
EmergencyDialMask |
Optional |
String |
A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, a value of “212” would mean that 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 with a different emergency number attempts to dial that country’s number rather than the number for the country they’re currently in). Maximum length of the string is 100 characters. Each character must be a digit 0 through 9. |
|
NotificationUri |
Optional |
String |
The SIP URI 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. The string must be from 1 to 256 characters in length and must begin with the prefix sip:. |
|
ConferenceUri |
Optional |
String |
The SIP 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:. |
|
ConferenceMode |
Optional |
ConferenceModeEnum |
If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether the 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 PSAP operator. - twoway: Third party can listen in and participate in the call between the caller and the PSAP operator. Valid values are: oneway and twoway. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
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. |
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 Enhanced 911, 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, how the call should be routed, and so on. 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 Microsoft Communications Server 2010 in terms of order of scope. For all other policies, if the policy is defined at the per-user scope, the per-user policy is applied. If there is no per-user policy, the site policy is applied. If there is no site policy, the global policy is applied. This isn’t the case for location policies. The scope of the policy that is applied is dependent on the user’s location. If the user is making the emergency call from within a defined location (a mapped site or subnet within the organization), the site-level policy is used (or the global policy if no site policy is defined). This is the functionality even if a per-user policy has been granted to that user. If the user calls from a location that is unknown or unmapped in the organization, the per-user policy will be applied.
Available scopes: Host - Global, Site, Per-User
Return Types
Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
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 --------------------------
| Copy Code |
|
|---|---|
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 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 should match a value in the list of PSTN usages. (This list can be retrieved by calling Get-CsPhoneUsage.) 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 that indicates an emergency call.