Get-NectarEndpointTest

Returns information about Endpoint Client tests

Description

Returns information about Endpoint Client tests

Syntax

Get-NectarEndpointTest
  -TimePeriod  <String>
  -TimePeriodFrom  <DateTime>
  -TimePeriodTo  <DateTime>
  -TestTypes  <String[]>
  -TestResults  <String[]>
  -ResponseCodes  <String[]>
  -Users  <String[]>
  -FromUsers  <String[]>
  -ToUsers  <String[]>
  -UserIDs  <String[]>
  -FromUserIDs  <String[]>
  -ToUserIDs  <String[]>
  -Locations  <String[]>
  -CallerLocations  <String[]>
  -CalleeLocations  <String[]>
  -ExtCities  <String[]>
  -CallerExtCities  <String[]>
  -CalleeExtCities  <String[]>
  -ExtCountries  <String[]>
  -CallerExtCountries  <String[]>
  -CalleeExtCountries  <String[]>
  -ExtISPs  <String[]>
  -CallerExtISPs  <String[]>
  -CalleeExtISPs  <String[]>
  -OrderByField  <String>
  -OrderDirection  <String>
  -TenantName  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarEndpointTest -TimePeriod LAST_HOUR -TestTypes P2P -TestResults FAILED

Returns a list of all Endpoint Client P2P tests that failed within the last hour

Example 2

Get-NectarEndpointTest -TimePeriod LAST_DAY -Locations 'Head Office', Warehouse

Returns a list of all Endpoint Client tests where either the caller or callee was in the corporate head office or the warehouse

Example 3

Get-NectarEndpointTest -TimePeriod LAST_WEEK -CallerExtCities Chicago, Dallas

Returns a list of all Endpoint Client tests from the last week where the caller was in either Chicago or Dallas

Parameters

-TimePeriod <String>
The time period to show session data from. Select from 'LAST_HOUR','LAST_DAY','LAST_WEEK','LAST_MONTH','CUSTOM'.
CUSTOM requires using TimePeriodFrom and TimePeriodTo parameters.

-TimePeriodFrom <DateTime>
The earliest date/time to show session data from. Must be used in conjunction with -TimePeriod CUSTOM and TimePeriodTo parameters. Use format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'. All time/dates in UTC.

-TimePeriodTo <DateTime>
The latest date/time to show session data from. Must be used in conjunction with -TimePeriod CUSTOM and TimePeriodFrom parameters. Use format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'. All time/dates in UTC.

-TestTypes <String[]>
The types of EPC tests to return. Choose from one or more of 'P2P', 'PING', 'AUDIO', or 'VIDEO'

-TestResults <String[]>
The result type to return. Choose from one or more of 'PASSED','FAILED', 'INCOMPLETE' or 'UNKNOWN'

-ResponseCodes <String[]>
Show tests that match one or more SIP response codes. Accepts numbers from 0 to 699

-Users <String[]>
Show sessions where the selected user was either caller or callee. Can query for multiple users.

-FromUsers <String[]>
Show sessions where the selected user was the caller. Can query for multiple users.

-ToUsers <String[]>
Show sessions where the selected user was the callee. Can query for multiple users.

-UserIDs <String[]>
Show sessions where the selected user ID was either caller or callee. Can query for multiple user IDs.

-FromUserIDs <String[]>
Show sessions where the selected user ID was the caller. Can query for multiple user IDs.

-ToUserIDs <String[]>
Show sessions where the selected user ID was the callee. Can query for multiple user IDs.

-Locations <String[]>
Show sessions where the selected location was used by either caller or callee. Can query for multiple locations.

-CallerLocations <String[]>
Show sessions where the selected location was used by the caller. Can query for multiple locations.

-CalleeLocations <String[]>
Show sessions where the selected location was used by the callee. Can query for multiple locations.

-ExtCities <String[]>
Show sessions where the caller or callee was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

-CallerExtCities <String[]>
Show sessions where the caller was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

-CalleeExtCities <String[]>
Show sessions where the callee was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

-ExtCountries <String[]>
Show sessions where the caller or callee was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

-CallerExtCountries <String[]>
Show sessions where the caller was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

-CalleeExtCountries <String[]>
Show sessions where the callee was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

-ExtISPs <String[]>
Show sessions where the caller or callee was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

-CallerExtISPs <String[]>
Show sessions where the caller was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

-CalleeExtISPs <String[]>
Show sessions where the callee was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

-OrderByField <String>
Sort the output by the selected field

-OrderDirection <String>
Sort direction. Use with OrderByField. Not case sensitive. Choose from:
ASC, DESC

-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.

-PageSize <Int32>
The size of the page used to return data. Defaults to 1000

-ResultSize <Int32>
The total number of results to return. Defaults to 1000. Maximum result size is 9,999,999 results