MENU
      Get-NectarEndpointTestSummary
      • 21 Aug 2024
      • 6 Minutes to read

      Get-NectarEndpointTestSummary


      Article summary

      Returns summary information about Endpoint Client tests

      Description

      Returns summary information about Endpoint Client tests

      Syntax

      Get-NectarEndpointTestSummary
        -TimePeriod  <String>
        -TimePeriodFrom  <DateTime>
        -TimePeriodTo  <DateTime>
        -TestTypes  <String[]>
        -TestResults  <String[]>
        -HubOrEndpoint  <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>
      PowerShell

      Examples

      Example 1

      Get-NectarEndpointTestSummary -TimePeriod LAST_HOUR -TestTypes P2P -TestResults FAILED
      PowerShell

      Returns a summary of all Endpoint Client P2P tests that failed within the last hour grouped by endpoint

      Example 2

      Get-NectarEndpointTestSummary -TimePeriod LAST_DAY -Locations 'Head Office', Warehouse
      PowerShell

      Returns a summary of all Endpoint Client tests grouped by endpoint where either the caller or callee was in the corporate head office or the warehouse

      Example 3

      Get-NectarEndpointTestSummary -TimePeriod LAST_WEEK -CallerExtCities Chicago, Dallas
      PowerShell

      Returns a list of all Endpoint Client tests from the last week grouped by endpoint 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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueLAST_HOUR
      Accept pipeline input?false
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

      -HubOrEndpoint <String>

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueENDPOINT
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

      -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.

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default ValueNone
      Accept pipeline input?true (ByPropertyName)
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default Value1000
      Accept pipeline input?false
      Accept wildcard characters?false

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

      ParameterValue
      Requiredfalse
      Positionnamed
      Requiredfalse
      Default Value0
      Accept pipeline input?false
      Accept wildcard characters?false

      Was this article helpful?

      Changing your password will log you out immediately. Use the new password to log back in.
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      ESC

      Eddy AI, facilitating knowledge discovery through conversational intelligence