Topic Last Modified: 2014-02-19

Verifies connectivity through the A/V Edge server. This cmdlet was introduced in Lync Server 2013.

Syntax

Test-CsAVEdgeConnectivity -TargetFqdn <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-RegistrarPort <Int32>] [-UserSipAddress <String>] <COMMON PARAMETERS>
Test-CsAVEdgeConnectivity -UserCredential <PSCredential> -UserSipAddress <String> [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] [-RegistrarPort <Int32>] [-TargetFqdn <String>] <COMMON PARAMETERS>
Test-CsAVEdgeConnectivity [-Authentication <TrustedServer | Negotiate | ClientCertificate | LiveID>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AVEdgeAddress <String>] [-AVEdgeTCPPort <UInt16>] [-AVEdgeUDPPort <UInt16>] [-Force <SwitchParameter>] [-OutLoggerVariable <String>] [-OutVerboseVariable <String>]

Examples

Example 1

The command shown in Example 1 verifies that a preconfigured test user can connect to the A/V Edge server configured for the pool atl-cs-001.litwareinc.com Note that this command will fail if you have not defined at least one health monitoring test user for atl-cs-001.litwareinc.com.

Copy Code 
Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com"

Example 2

In Example 2, the Test-CsAVEdgeConnectivity cmdlet verifies that the user with the SIP address sip:kenmyer@litwareinc.com is able to connect to the AV Edge server. To do this, the first command in the example uses the Get-Credential cmdlet to retrieve a Windows PowerShell credentials object for the user litwareinc\kenmyer; note that you supply the password for this account when obtaining this object. After the credentials object has been obtained, the second command uses the Test-CsAVEdgeConnectivity cmdlet to verify that the user can connect to the AV Edge server.

Copy Code 
$cred = Get-Credential "litwareinc\kenmyer"

Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" -UserSipAddress "sip:kenmyer@litwareinc.com" -UserCredential $cred

Detailed Description

The Test-CsAVEdgeConnectivity cmdlet verifies that a user can connect to the AV Edge Server assigned to a Registrar pool.

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 command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsAVEdgeConnectivity"}

Lync Server Control Panel: The functions carried out by the Test-CsAVEdgeConnectivity cmdlet are not available in the Lync Server Control Panel.

Parameters

Parameter Required Type Description

TargetFqdn

Required

System.String

Fully qualified domain name (FQDN) of the pool to be tested.

UserCredential

Required

System.Management.Automation.PSCredential

User credentials object for the account to be tested. The value passed to UserCredential must be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named

$x: $x = Get-Credential "litwareinc\kenmyer"

You need to supply the user password when running this command. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.

Authentication

Optional

Microsoft.Rtc.Management.SyntheticTransactions.SipSyntheticTransaction+AuthenticationMechanism

Type of authentication used in the test. Allowed values are:

* TrustedServer

* Negotiate

* ClientCertificate

* LiveID

AVEdgeAddress

Optional

System.String

PARAMVALUE: String

AVEdgeTCPPort

Optional

System.UInt16

PARAMVALUE: UInt16

AVEdgeUDPPort

Optional

System.UInt16

PARAMVALUE: UInt16

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

OutLoggerVariable

Optional

System.String

When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods – ToHTML and ToXML – that can then be used to save that output to either an HTML or an XML file.

To store output in a logger variable named $TestOutput use the following syntax:

-OutLoggerVariable TestOutput

Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this:

$TestOutput.ToHTML() > C:\Logs\TestOutput.html

To save the information stored in the logger variable to an XML file, use a command similar to this:

$TestOutput.ToXML() > C:\Logs\TestOutput.xml

OutVerboseVariable

Optional

System.String

When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax:

-OutVerboseVariable TestOutput

Do not use prepend a $ character when specifying the variable name.

RegistrarPort

Optional

System.Int32

SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.

UserSipAddress

Optional

System.String

SIP address for user account to be tested; for example: -UserSipAddress "sip:kenmyer@litwareinc.com". The UserSipAddress parameter must reference the same user account as UserCredential. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.

Input Types

None. The Test-CsAVEdgeConnectivity cmdlet does not accept pipelined input.

Return Types

The Test-CsAVEdgeConnectivity cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

See Also