Test-CsLisCivicAddress
Topic Last Modified: 2012-03-25
Tests one or more civic addresses against the Master Street Address Guide.
Syntax
Test-CsLisCivicAddress [-City <String>] [-Confirm [<SwitchParameter>]] [-Country <String>] [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-PostalCode <String>] [-PostDirectional <String>] [-PreDirectional <String>] [-State <String>] [-StreetName <String>] [-StreetSuffix <String>] [-UpdateValidationStatus <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
In an Enterprise Voice implementation with Enhanced 9-1-1 (E9-1-1), user locations are determined based on location maps that map a subnet, port, switch, or wireless access point to a location. (In the absence of a connection to a mapped location, the user may be asked to input their location manually.) The addresses of these locations must be validated against the Master Street Address Guide (MSAG) by the E9-1-1 Network Routing Provider. This cmdlet uses the web service of that provider to validate mapped addresses. You can set up a service provider by calling the Set-CsLisServiceProvider cmdlet.
If you want to update the MSAGValid property of the civic address, be sure to include the UpdateValidationStatus parameter in your call to Test-CsLisCivicAddress. Use the Get-CsLisCivicAddress cmdlet to retrieve civic addresses.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Test-CsLisCivicAddress 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 "Test-CsLisCivicAddress"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
City |
Optional |
String |
The location city. Maximum length: 64 characters. |
Country |
Optional |
String |
The country/region this location is in. Maximum length: 2 characters |
HouseNumber |
Optional |
String |
The house number of the location. For a company, this is the number on the street where the company is located. Maximum length: 10 characters |
HouseNumberSuffix |
Optional |
String |
Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. Maximum length: 5 characters |
PostalCode |
Optional |
String |
The postal code associated with this location. Maximum length: 10 characters |
PostDirectional |
Optional |
String |
The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. Maximum length: 2 characters |
PreDirectional |
Optional |
String |
The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. Maximum length: 2 characters |
State |
Optional |
String |
The state or province associated with this location. Maximum length: 2 characters |
StreetName |
Optional |
String |
The name of the street for this location. Maximum length: 60 characters |
StreetSuffix |
Optional |
String |
The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters |
UpdateValidationStatus |
Optional |
SwitchParameter |
Including this parameter will change the MSAGValid property of the civic address depending on whether the address is validated through this cmdlet. If the address is valid, MSAGValid will be set to True. Omitting this parameter will leave the MSAGValid value unchanged. |
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
Accepts pipelined input containing a Location Information Server (LIS) civic address object.
Return Types
This cmdlet does not return a value.
Example
-------------------------- Example 1 --------------------------
Test-CsLisCivicAddress -HouseNumber 1234 -HouseNumberSuffix "" -PreDirectional "" -StreetName Main -StreetSuffix St -PostDirectional "" -City Redmond -State WA -PostalCode 99999 -Country US -UpdateValidationStatus
This command validates the address with the properties matching the values specified in these parameters against the Master Street Address Guide. Notice the inclusion of the UdateValidationStatus parameter at the end: this will update the MSAGValid property of the address.
-------------------------- Example 2 --------------------------
Get-CsLisCivicAddress | Test-CsLisCivicAddress -UpdateValidationStatus
This example shows how to test all LIS civic addresses. The example begins with a call to Get-CsLisCivicAddress to retrieve all civic addresses defined in the location database. These addresses are piped to Test-CsLisCivicAddress, which uses the E9-1-1 Network Routing Provider web service to validate each address.