Device Collections

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

Get-LiquitDeviceCollection

Synopsis

This command displays a list of all device collections from the Application Workspace, or you can select a specific device collection.

Syntax

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

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

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

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

Examples

Example 1: Get-LiquitDeviceCollection

Get-LiquitDeviceCollection

This command lists all available device collections within Application Workspace.

Example 2: Get-LiquitDeviceCollection

Get-LiquitDeviceCollection -id 00000000-0000-0000-0000-000000000000

This command will select the device collection 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 device collections table from the Application Workspace UI. It enables users to search multiple columns within the table, such as Name and 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 collection name itself.
LiquitContext <LiquitContext> Determines the selected zone. No Default

New-LiquitDeviceCollection

Synopsis

This command creates a new device collection.

Syntax

New-LiquitDeviceCollection  
    -Dynamic 
    -Name <string> 
    -Filters <ContextFilters> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]   

New-LiquitDeviceCollection  
    -Dynamic 
    -Name <string> 
    -Script <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]   

New-LiquitDeviceCollection  
    -Dynamic 
    -Name <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]   
    
    New-LiquitDeviceCollection  
    -Name <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]

Example

New-LiquitDeviceCollection -name "DeviceCollection"

This command creates a new device collection named "DeviceCollection".

Name Value Description Required Default value
Dynamic Create a dynamic device collection. No
Name <string> Provide a name for the device collection. Yes
Script <string> The script to use for device selection. No
Filters <ContextFilters> Filters to use for device selection. No
Description <string> Provide a description for the device collection. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Set-LiquitDeviceCollection

Synopsis

This command updates a device collection.

Syntax


Set-LiquitDeviceCollection  
	[-DeviceCollection] <DeviceCollection[]>  
	[-Name] <string>  
	[-Description] <string>  
	[-Filters <ContextFilters>] 
	[-LiquitContext <LiquitContext>]   
	[-WhatIf] 
	[-Confirm] 
	[<CommonParameters>]     

Set-LiquitDeviceCollection  
	[-DeviceCollection] <DeviceCollection[]>  
	[-Name] <string>  
	[-Description] <string>  
	[-Script <string>] 
	[-LiquitContext <LiquitContext>]   
	[-WhatIf] 
	[-Confirm] 
	[<CommonParameters>]

Example

$DeviceCollection = Get-LiquitDeviceCollection -id 00000000-0000-0000-0000-000000000000 
Set-LiquitDeviceCollection -DeviceCollection $DeviceCollection -Name "Updated DeviceCollection"

This command updates the name of the device collection to "Updated DeviceCollection".

Name Value Description Required Default value
DeviceCollection <DeviceCollection>[] The device collection that needs to be updated. Yes
Name <string> Provide a name for the device collection. Yes
Script <string> Script to use for the device collection. No
Filters <ContextFilters> Filters to use for device collection. No
Description <string> Provide a description for the device collection. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Start-LiquitWakeDeviceCollection

Synopsis

This command wakes all devices from a device collection.

Syntax

Start-LiquitWakeDeviceCollection  
	[-ID] <guid[]>  
	[-LiquitContext <LiquitContext>]   
	[<CommonParameters>] 
  
Start-LiquitWakeDeviceCollection  
	[-DeviceCollection] <DeviceCollection[]>  
	[-LiquitContext <LiquitContext>]   
	[<CommonParameters>]

Example

Start-LiquitWakeDeviceCollection -id 00000000-0000-0000-0000-000000000000

This command wakes all devices inside the device collection with the ID 00000000-0000-0000-0000-000000000000.

Parameters

Name Value Description Required Default value
DeviceCollection <DeviceCollection[]> The device collection containing the devices you wish to wake. Yes
ID <guid[]> The ID of the device collection containing the devices you wish to wake. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitDeviceCollection

Synopsis

Removes a device collection from the Application Workspace.

Syntax

Remove-LiquitDeviceCollection  
	[-DeviceCollection] <DeviceCollection[]>  
	[-LiquitContext <LiquitContext>]  
	[-WhatIf]  
	[-Confirm]   
	[<CommonParameters>]

Example

$deviceCollection = Get-LiquitDeviceCollection -id 00000000-0000-0000-0000-000000000000 
Remove-LiquitDeviceCollection -DeviceCollection $deviceCollection

This command removes the selected device collection from Application Workspace.

Parameters

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