Edit

Share via


Test-CsLisCivicAddress

Tests one or more civic addresses against the Master Street Address Guide. This cmdlet was introduced in Lync Server 2010.

Syntax

Default (Default)

Test-CsLisCivicAddress
    [-City <String>]
    [-Country <String>]
    [-HouseNumber <String>]
    [-HouseNumberSuffix <String>]
    [-PostalCode <String>]
    [-PostDirectional <String>]
    [-PreDirectional <String>]
    [-State <String>]
    [-StreetName <String>]
    [-StreetSuffix <String>]
    [-UpdateValidationStatus]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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 the Test-CsLisCivicAddress cmdlet. Use the Get-CsLisCivicAddress cmdlet to retrieve civic addresses.

Examples

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 UpdateValidationStatus 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 the Get-CsLisCivicAddress cmdlet to retrieve all civic addresses defined in the location database. These addresses are piped to the Test-CsLisCivicAddress cmdlet, which uses the E9-1-1 Network Routing Provider web service to validate each address.

Parameters

-City

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The location city.

Maximum length: 64 characters.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Country

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The country/region this location is in.

Maximum length: 2 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-HouseNumber

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-HouseNumberSuffix

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PostalCode

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The postal code associated with this location.

Maximum length: 10 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PostDirectional

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW.

Maximum length: 2 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PreDirectional

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-State

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The state or province associated with this location.

Maximum length: 2 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StreetName

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The name of the street for this location.

Maximum length: 60 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StreetSuffix

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The type of street designated in a street name, such as Street, Avenue, or Court.

Maximum length: 10 characters

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UpdateValidationStatus

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

Accepts pipelined input containing a Location Information Server (LIS) civic address object.

Outputs

None

This cmdlet does not return a value.