Set-TSTMGMTDeviceNotes

Update the Notes of a device within the Management Platform.

Written by Giuseppe

Last published at: August 20th, 2020

Update the notes of a device within the Management Platform


SYNTAX

Set-TSTMGMTDeviceNotes

        -Device <Device> -Notes <string> [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Modify the device notes field within the Management Platform.


EXAMPLES

1. Modify a Notes from a device at index 4 ' from 'TEST' to 'Powershell Notes'

$allDevices = Get-TSTMGMTAllData

$allDevices.Devices[4]  



        $allData.Devices[4] | Set-TSTMGMTDeviceNotes -Notes 'Powershell Notes' 



        2. Add the same notes to all Devices 

        Connect-TSTMGMTServer -Uri "https://yourserver/TSTMgmt" -Username "Administrator" -Password "XXXXXXXXXXXX"

        $allData = Get-TSTMGMTAllData

        foreach ($devices in $allData.Devices)                                                                                                                                                            {
         $devices | Set-TSTMGMTDeviceNotes -Notes 'New Notes'  
        }

PARAMETERS


-Device

 Device object to update

Type: ThinScale.Management.DataObjects.Device
Required: Yes
Accept Pipeline Input: Yes


-Notes

New notes for the device

Type: String
Required: Yes
Accept Pipeline Input: No



-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

Type: Guid
Required: No
Accept Pipeline Input: No


-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No


INPUTS

ThinScale.Management.DataObjects.Device


OUTPUTS

ThinScale.Management.DataObjects.Device