Get-NectarSession

Returns all session information.

Description

Returns all session information as presented on the SESSION LIST section of the CALL DETAILS page

Syntax

Get-NectarSession
  -TimePeriod  <String>
  -TimePeriodFrom  <String>
  -TimePeriodTo  <String>
  -SessionQualities  <String[]>
  -DurationFrom  <Int32>
  -DurationTo  <Int32>
  -Modalities  <String[]>
  -Protocols  <String[]>
  -ResponseCodes  <String[]>
  -SessionScenarios  <String[]>
  -SessionTypes  <String[]>
  -Codecs  <String[]>
  -CallerCodecs  <String[]>
  -CalleeCodecs  <String[]>
  -Devices  <String[]>
  -CallerDevices  <String[]>
  -CalleeDevices  <String[]>
  -DeviceVersions  <String[]>
  -CallerDeviceVersions  <String[]>
  -CalleeDeviceVersions  <String[]>
  -IPAddresses  <IPAddress[]>
  -CallerIPAddresses  <IPAddress[]>
  -CalleeIPAddresses  <IPAddress[]>
  -Locations  <String[]>
  -CallerLocations  <String[]>
  -CalleeLocations  <String[]>
  -ExtCities  <String[]>
  -CallerExtCities  <String[]>
  -CalleeExtCities  <String[]>
  -ExtCountries  <String[]>
  -CallerExtCountries  <String[]>
  -CalleeExtCountries  <String[]>
  -ExtISPs  <String[]>
  -CallerExtISPs  <String[]>
  -CalleeExtISPs  <String[]>
  -ExtConnectionTypes <String[]>
  -CallerExtConnectionTypes <String[]>
  -CalleeExtConnectionTypes <String[]>
  -NetworkTypes  <String[]>
  -CallerNetworkTypes  <String[]>
  -CalleeNetworkTypes  <String[]>
  -Platforms  <String[]>
  -Users  <String[]>
  -FromUsers  <String[]>
  -ToUsers  <String[]>
  -ConfOrganizers  <String[]>
  -VPN  <String[]>
  -CallerVPN  <String[]>
  -CalleeVPN  <String[]>
  -ParticipantsMinCount  <Int32>
  -ParticipantsMaxCount  <Int32>
  -FeedbackRating  <String[]>
  -Insights  <String[]>
  -OrderByField  <String>
  -OrderDirection  <String>
  -TenantName  <String>
  -Scope  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarSessions -TimePeriod LAST_HOUR -Platforms TEAMS -Modalities AUDIO -SessionQualities POOR

Returns a list of all Teams audio sessions for the past hour where the quality was rated Poor

Example 2

(Get-NectarSession -SessionTypes CONFERENCE -TimePeriod CUSTOM -TimePeriodFrom '2021-05-06' -TimePeriodTo '2021-05-07').Count

Returns a count of all conferences between May 6 and 7 (all times/dates UTC)

Example 3

Get-NectarSession -SessionTypes PEER2PEER,PEER2PEER_MULTIMEDIA -TimePeriod CUSTOM -TimePeriodFrom '2021-05-06 14:00' -TimePeriodTo '2021-05-06 15:00'

Returns a list of all P2P calls between 14:00 and 15:00 UTC on May 6

Example 4

Get-NectarSession -TimePeriod LAST_WEEK -SessionTypes CONFERENCE | Select-Object confOrganizerOrSpace | Group-Object confOrganizerOrSpace | Select-Object Name, Count | Sort-Object Count -Descending

Returns a list of conference organizers and a count of the total conferences organized by each, sorted by count.

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

-SessionQualities <String[]>
Show sessions that match a given quality rating. Case sensitive. Choose one or more from:
'GOOD','POOR_0_25','PARTIALLY_GOOD_25_50','PARTIALLY_GOOD_50_75','PARTIALLY_GOOD_75_100','UNAVAILABLE','UNKNOWN'

-DurationFrom <Int32>
The shortest call length (in seconds) to show session data.

-DurationTo <Int32>
The longest call length (in seconds) to show session data.

-Modalities <String[]>
Show sessions that match one or more modality types. Not case sensitive. Choose one or more from:
'AUDIO','VIDEO','APP_SHARING','FILE_TRANSFER','IM','UNKNOWN','TOTAL','VBSS','REMOTE_ASSISTANCE','APP_INVITE','FOCUS','UNKNOWN'

-Protocols <String[]>
Show sessions that match one or more network protocol types. Case sensitive. Choose one or more from:
'TCP','UDP','Unknown'

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

-SessionScenarios <String[]>
Show sessions that match one or more session scenarios. Not case sensitive. Choose one or more from:
'External','Internal','Internal-External','External-Internal','Federated','Internal-Federated','External-Federated','Unknown'

-SessionTypes <String[]>
Show sessions that match one or more session scenarios. Case sensitive. Choose one or more from:
'Conference','Peer To Peer','Peer To Peer (Multimedia)','PSTN/External'

-Codecs <String[]>
Show sessions where the selected codec was used by either caller or callee. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

-CallerCodecs <String[]>
Show sessions where the selected codec was used by the caller. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

-CalleeCodecs <String[]>
Show sessions where the selected codec was used by the callee. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

-Devices <String[]>
Show sessions where the selected device was used by either caller or callee. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices.

-CallerDevices <String[]>
Show sessions where the selected device was used by the caller. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices.

-CalleeDevices <String[]>
Show sessions where the selected device was used by the callee. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices.

-DeviceVersions <String[]>
Show sessions where the selected device version was used by either caller or callee. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions.

-CallerDeviceVersions <String[]>
Show sessions where the selected device version was used by the caller. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions.

-CalleeDeviceVersions <String[]>
Show sessions where the selected device version was used by the callee. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions.

-IPAddresses <IPAddress[]>
Show sessions where the selected IP address was used by either caller or callee. Can query for multiple IPs.

-CallerIPAddresses <IPAddress[]>
Show sessions where the selected IP address was used by the caller. Can query for multiple IPs.

-CalleeIPAddresses <IPAddress[]>
Show sessions where the selected IP address was used by the callee. Can query for multiple IPs.

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

-ExtConnectionTypes <String[]>
Show sessions that match the caller or callee external connection type (as detected via geolocating the user's external IP address). Can query for multiple types.

-CallerExtConnectionTypes <String[]>
Show sessions that match the caller external connection type (as detected via geolocating the user's external IP address). Can query for multiple types.

-CalleeExtConnectionTypes <String[]>
Show sessions that match the callee external connection type (as detected via geolocating the user's external IP address). Can query for multiple types.

-CallerNetworkTypes <String[]>
Show sessions where the selected network type was used by the caller. Can query for multiple network types. Case sensitive. Choose one or more from:
'Enterprise WiFi','Enterprise Wired','External Mobile','External WiFi','External Wired','Unknown','Unavailable'

-CalleeNetworkTypes <String[]>
Show sessions where the selected network type was used by the callee. Can query for multiple network types. Case sensitive. Choose one or more from:
'Enterprise WiFi','Enterprise Wired','External Mobile','External WiFi','External Wired','Unknown','Unavailable'

-Platforms <String[]>
Show sessions where the selected platform was used by either caller or callee. Can query for multiple platforms. Case sensitive. Choose one or more from:
'SKYPE','CISCO','CISCO_CMS','CISCO_VKM','TEAMS','SKYPE_ONLINE','CISCO_CMS_VKM','AVAYA_AURA_CM','RIG','LYNC_VKM','SKYPE_FOR_BUSINESS_VKM','CISCO_UNITY','CISCO_EXPRESSWAY','AVAYA_MEDIA_GATEWAY','AVAYA_SESSION_MANAGER','AVAYA_VOICE_PORTAL','ZOOM','ENDPOINT_CLIENT','MISCELLANEOUS'

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

-ConfOrganizers <String[]>
Show sessions hosted by a specified conference organizer. Can query for multiple organizers.

-VPN <String[]>
Show sessions where the selected VPN was used by either caller or callee.

-CallerVPN <String[]>
Show sessions where the selected VPN was used by the caller.

-CalleeVPN <String[]>
Show sessions where the selected VPN was used by the callee.

-ParticipantsMinCount <Int32>
Show sessions where the number of participants is greater than or equal to the entered value

-ParticipantsMaxCount <Int32>
Show sessions where the number of participants is less than or equal to the entered value

-FeedbackRating <String[]>
Show sessions where users provided specific feedback ratings from BAD to EXCELLENT.
Allowed values are BAD, POOR, FAIR, GOOD, EXCELLENT. Corresponds to ratings from 1 to 5 stars.

-Insights <String[]>
Show sessions that match one or more given insights. Choose from NORMAL_SESSION, VOICE_MAIL, HIGH_JITTER, HIGH_PACKET_LOSS, HIGH_ROUNDTRIP_DELAY

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

-Scope <String>

-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