Get-NectarRoom
- 18 Aug 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarRoom
- Updated on 18 Aug 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Return a list of Nectar monitored rooms
Syntax
Get-NectarRoom
-SearchQuery <String>
-OrderByField <String>
-OrderDirection <String>
-TenantName <String>
-PageSize <Int32>
Examples
Example 1
Get-NectarRoom
Returns a list of all rooms
Example 2
Get-NectarRoom -OrderByField HealthStatus -OrderDirection Descending
Returns a list of rooms sorted by Health Status
Parameters
-SearchQuery <String>
Limit the results to the specified search query. Will match against all fields.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-OrderByField <String>
Order the resultset by the specified field. Choose from id, type, lastTime, displayName, deviceName, description, eventId, time, delay, source, location, sourceId
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-OrderDirection <String>
Sort order. Pick from ASC or DESC
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| 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 | 4 |
| 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 | 5 |
| Required | false |
| Default Value | 1000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?