Tests the Location Information Server (LIS) configuration.
Syntax
Test-CsLisConfiguration -TargetFqdn <String> [-BssId <String>] [-ChassisId <String>] [-External <SwitchParameter>] [-Force <SwitchParameter>] [-Mac <String>] [-OutVerboseVariable <String>] [-PortId <String>] [-Subnet <String>] [-UserCredential <PSCredential>] |
Test-CsLisConfiguration -TargetUri <String> -UserCredential <PSCredential> [-BssId <String>] [-ChassisId <String>] [-Force <SwitchParameter>] [-Mac <String>] [-OutVerboseVariable <String>] [-PortId <String>] [-Subnet <String>] |
Test-CsLisConfiguration -Certificate <X509Certificate2> -TargetUri <String> [-BssId <String>] [-ChassisId <String>] [-Force <SwitchParameter>] [-Mac <String>] [-OutVerboseVariable <String>] [-PortId <String>] [-Subnet <String>] |
Test-CsLisConfiguration -UserCredential <PSCredential> -UserSipAddress <String> [-BssId <String>] [-ChassisId <String>] [-External <SwitchParameter>] [-Force <SwitchParameter>] [-Mac <String>] [-OutVerboseVariable <String>] [-PortId <String>] [-Subnet <String>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
TargetFqdn |
Required |
String |
The fully qualified domain name (in the form server.litwareinc.com) of the server against which you want to run the test. This parameter is required unless you specify either the TargetUri or UserSipAddress parameter. These three parameters are mutually exclusive. |
|
Certificate |
Required |
X509Certificate2 |
An object containing certificate information for accessing the LIS service. |
|
TargetUri |
Required |
String |
The URI of the LIS service. You can retrieve the URI of the LIS service by running the command Get-CsService –WebService | Select-Object LIServiceInternalUri If you specify a value for this parameter, the UserCredential parameter is also required. This parameter is required unless you specify either the TargetFqdn or UserSipAddress parameter. These three parameters are mutually exclusive. |
|
UserCredential |
Required |
PSCredential |
An object containing user credentials for accessing the LIS service. This object can be retrieved by calling the Get-Credential cmdlet and supplying the appropriate credentials. This parameter is required if either the TargetUri or UserSipAddress parameter is specified. |
|
UserSipAddress |
Required |
String |
The SIP address of a remote user who must obtain the LIS URI through in-band provisioning. If you specify a value for this parameter, the UserCredential parameter is also required. This parameter is required unless you specify either the TargetUri or TargetFqdn parameter. These three parameters are mutually exclusive. |
|
BssId |
Optional |
String |
The basic service set identifier (BSSID) of a wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. |
|
ChassisId |
Optional |
String |
The MAC address of a network switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. |
|
External |
Optional |
SwitchParameter |
This parameter is not supported for Location Information Service. |
|
Force |
Optional |
SwitchParameter |
|
|
Mac |
Optional |
String |
The MAC address of the port switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. |
|
PortId |
Optional |
String |
The ID of the port associated with the location to test. |
|
Subnet |
Optional |
String |
The IP address of a subnet. This value can be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0) or as an IPv6 address (digits separated by colons, such as 2001:1111:2222:3333:AAAA:BBBB:CCCC:FFFF). |
Detailed Description
This cmdlet determines whether the Location Information Service (LIS) web service can be contacted based on the information in the supplied parameters. If the web service can be contacted and a location is found that corresponds to any of the supplied parameters, the test is considered to have passed and the location will be displayed. If you call this cmdlet without supplying any of the optional parameters, the test will still pass as long as the web service can be contacted, but no location information will be returned.
Return Types
Test-CsLisConfiguration returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Test-CsLisConfiguration -TargetFqdn atl-cs-001.litwareinc.com -Subnet 192.168.0.0 |
|
This example tests the LIS configuration at the FQDN atl-cs-001.litwareinc.com. The test will be successful if a connection can be made with the current user credentials to the LIS web service at that FQDN. If a location can be found that maps to the subnet IP address 192.168.0.0 that location address will be returned.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
$uc = Get-Credential Test-CsLisConfiguration -TargetUri https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc -UserCredential $uc -Subnet 192.168.0.0 -Mac 0A-23-00-00-00-AA -PortId 4500 |
|
The first line of this example calls a Windows Powershell cmdlet, Get-Credential, that will prompt the user for a user ID and password. This information is stored securely in the variable $uc.
Line 2 tests the LIS configuration by making a call to the web service URI, using the credentials we obtained in line 1 by passing them to the UserCredential parameter. The test will be successful if a connection can be made with the given user credentials to the LIS web service at that URI. If a location can be found that maps to the subnet IP address 192.168.0.0, the MAC address 0A-23-00-00-00-AA or the Port ID 4500, that location address will be returned.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
$uc = Get-Credential Test-CsLisConfiguration -UserSipAddress sip:kenmyer@litwareinc.com -UserCredential $uc -Subnet 192.168.0.0 -Mac 0A-23-00-00-00-AA -PortId 4500 -ChassisId 0A-23-00-00-00-AA -BssId 0A-23-00-00-00-AA |
|
Example 3 begins just like Example 2, with a call to Get-Credential to retrieve a user ID and password. This information is again stored securely in the variable $uc.
In this example, the test begins by retrieving the LIS URI based on the SIP address of a remote user. The user credentials provided (in the $uc variable) will then be used to connect to the web service at that URI. The test will be successful if a connection can be made with the given user credentials to the LIS web service at the retrieved URI. If a location can be found that maps to the subnet IP address 192.168.0.0, the MAC address 0A-23-00-00-00-AA, the port ID 4500, the chassis ID 0A-23-00-00-00-AA, or the bss ID 0A-23-00-00-00-AA, that location address will be returned.