Set-TSTMGMTFolder

Update the details of a folder within the Management Platform.

Written by Giuseppe

Last published at: February 19th, 2020

Update the details of a folder within the Management Platform.


SYNTAX

Set-TSTMGMTFolder

-Folder <Folder> [-FolderName <string>] [-DeviceState {Normal | Disabled | Uninstall}] [-DeviceStateMessage <string>] [-Interface<guid>] [-Timeout <int>]


DESCRIPTION

Updates properties of an existing folder within the Management Platform.


EXAMPLES

1. Modifies a folder called 'Testing' to a folder called 'Testing Powershell' using folderName

        Get-TSTMGMTFolder -folderName '\Devices\Testing' | Set-TSTMGMTFolder -folderName 'Testing PowerShell'

2. Disable the folder called 'Testing Powershell' and add a message to it.

Get-TSTMGMTFolder -folderName '\Devices\Testing PowerShell' | Set-TSTMGMTFolder -DeviceState Disabled -DeviceStateMessage 'Folder is now disabled'



PARAMETERS


-Folder

Folder object to update

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


-FolderName

 The new name of the folder

Type: String
Required: No
Accept Pipeline Input: No


-DeviceState

Set the DeviceState of the folder. The acceptable values for this parameter are:

  • Disabled - Devices in this folder will be disabled
  • Uninstall - Devices in this folder will automatically uninstall ThinKiosk or Secure Remote Worker software
Type: String
Required: No
Accept Pipeline Input: No
Accepted values: Disabled, Uninstall


-DeviceStateMessage

A custom message that is displayed to the user when they use a device that has been disabled or set to uninstall

Type: String
Required: No
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.Folder


OUTPUTS

ThinScale.Management.DataObjects.Folder