Devices

  • Published on Apr 16, 2025
  • 1 minute(s) read
Prev Next

Get-LiquitDevice

Synopsis

This command displays a list of all devices from the Application Workspace.

Syntax

 Get-LiquitDevice 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

 Get-LiquitDevice 
    [-ID] <guid[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

 Get-LiquitDevice 
    [-IdentityRef] <IdentityRef[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]
    
 Get-LiquitDevice
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

 Get-LiquitDevice
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Examples

Example 1: Get-LiquitDevice

 Get-LiquitDevice

This command lists all devices available within the Application Workspace.

Example 2: Get-LiquitDevice

 Get-LiquitDevice -id 00000000-0000-0000-0000-000000000000

This command will select the device with the ID 00000000-0000-0000-0000-000000000000.

Parameters

Name Value Description Required Default value
Search <string> This parameter serves a similar purpose to the search box found in the devices table from the Application Workspace UI. It enables users to search multiple columns within the table, such as Name and Agent type. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes.
Name <string> Searches on the device name itself.
LiquitContext <LiquitContext> Determines the selected zone. No Default

Start-LiquitWakeDevice

Synopsis

This command wakes a device.

Syntax

 Start-LiquitWakeDevice
	[-ID] <guid[]> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

 Start-LiquitWakeDevice
	[-Device] <Device[]> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

Example

 Start-LiquitWakeDevice -id 00000000-0000-0000-0000-000000000000

This command wakes the device with the ID 00000000-0000-0000-0000-000000000000

Parameters

Name Value Description Required Default value
Device <Device[]> The device that should be woken. Yes
ID <guid[]> The id of the device that should be woken. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitDevice

Synopsis

Removes a device from the Application Workspace.

Syntax

 Remove-LiquitDevice 
	[-Device] <Device[]> 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

 $device = Get-LiquitDevice -id 00000000-0000-0000-0000-000000000000
 Remove-LiquitDevice -Device $device

This command removes the selected device from the Application Workspace.

Parameters

Name Value Description Required Default value
Device <Device[]> The device that should be removed. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default