Update an existing Nectar monitored room
Description
Update an existing Nectar monitored room. Can change the name and the associated business units
Syntax
Set-NectarRoom
-ID <Int32>
-Name <String>
-BusinessUnitID <String[]>
-TenantName <String>
Examples
Example 1
Set-NectarRoom -RoomID 1 -RoomName 'Secondary Boardroom'
Changes the room name with ID 1 to 'Secondary Boardroom'
Example 2
Get-NectarRoom -SearchQuery 'Main Boardroom' | Set-NectarRoom -RoomName 'Secondary Boardroom'
Changes the room name from 'Main Boardroom' to 'Secondary Boardroom'
Example 3
Get-NectarRoom -SearchQuery Dallas | Set-NectarRoom -BusinessUnitID 3
Changes all rooms that have Dallas in any field to BusinessUnitID 3
Parameters
-ID <Int32>
The ID of the room to update. Can be obtained via Get-NectarRoom and will accept pipeline input
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Name <String>
The new name of the room
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-BusinessUnitID <String[]>
One or more business unit IDs to assign to the room. Business Unit IDs can be obtained via Get-NectarBusinessUnit
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| 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 |