Get-NectarPlatformItemSummary
- 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarPlatformItemSummary
- Updated on 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Return summary information about a specific platform item
Syntax
Get-NectarPlatformItemSummary
-ClusterID <String>
-Platform <String>
-Source <String>
-TimePeriod <String>
-TimePeriodFrom <String>
-TimePeriodTo <String>
-TenantName <String>
-PageSize <Int32>
-ResultSize <Int32>
Examples
Example 1
Get-NectarPlatformItemSummary -Platform CISCO -ClusterID 3_1
Parameters
-ClusterID <String>
The ID of a cluster to return summary information
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Platform <String>
Show information about selected platform. Choose one or more from: 'AVAYA_MEDIA_GATEWAY','AVAYA_SESSION_MANAGER','AVAYA_VOICE_PORTAL','CISCO','CISCO_CMS','CISCO_VKM','SKYPE','SKYPE_ONLINE','TEAMS'
| Parameter | Value |
|---|---|
| Required | true |
| Position | 2 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Source <String>
Show information about either events, current status or both
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | All |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TimePeriod <String>
The time period to show event data from. Select from 'LAST_HOUR','LAST_DAY','LAST_WEEK','LAST_MONTH','CUSTOM'.
CUSTOM requires using TimePeriodFrom and TimePeriodTo parameters.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | LAST_HOUR |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TimePeriodFrom <String>
The earliest date/time to show event 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. Use date-time format as in 2020-04-20T17:46:37.554
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TimePeriodTo <String>
The latest date/time to show event 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. Use date-time format as in 2020-04-20T17:46:37.554
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-PageSize <Int32>
The size of the page used to return data. Defaults to 1000
| Parameter | Value |
|---|---|
| Required | false |
| Position | 8 |
| Required | false |
| Default Value | 1000 |
| 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
| Parameter | Value |
|---|---|
| Required | false |
| Position | 9 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?