Get-LiquitScheduledTask
Synopsis
Displays a list of all scheduled tasks within Application Workspace. Alternatively, you can select a specific scheduled task.
Syntax
Get-LiquitScheduledTask
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitScheduledTask
[-ID] <guid[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitScheduledTask
[-EntityRef] <EntityRef[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitScheduledTask
[-Type] <string[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitScheduledTask
[-Search] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitScheduledTask
[-Name] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Examples
Example 1: Get-LiquitScheduledTask
Get-LiquitScheduledTask
This command displays all scheduled tasks available in the Application Workspace.
Example 2: Get-LiquitScheduledTask
Get-LiquitScheduledTask -type cleantasks
This command displays all scheduled tasks of the “Clean tasks” type.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Search | <string> |
This parameter serves a similar purpose to the search box found in the scheduled tasks 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 scheduled task name itself. | ||
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
New-LiquitScheduledTask
Synopsis
This command creates a new scheduled task in the Application Workspace.
Syntax
New-LiquitScheduledTask
[-Name] <string>
[-Type] <string>
[-Triggers <ScheduledTaskTrigger[]>]
[-Notifications <ScheduledTaskNotifications>]
[-Description <string>]
[-Enabled <bool>]
[-Settings <hashtable>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
New-LiquitScheduledTask -name "PowerShell Task" -Type cleantasks
This command creates a new scheduled task of the “Clean tasks” type, within Application Workspace.
For all available scheduled tasks, see Scheduled Tasks.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Name | <string> |
A friendly name for the scheduled task. | Yes | |
| Type | <string> |
The type of scheduled task you want to create. | Yes | |
| Triggers | <ScheduledTaskTrigger[]> |
The trigger used to initiate the scheduled task. | No | |
| Notifications | <ScheduledTaskNotifications> |
The notifications that should be sent when the scheduled task has been executed. | No | |
| Description | <string> |
The description of the scheduled task. | No | |
| Enabled | <bool> |
Determines if the scheduled task is active. | No | true |
| Settings | <hashtable> |
The settings of the scheduled task. | No | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
Set-LiquitScheduledTask
Synopsis
This command lets you edit the properties of a scheduled task.
Syntax
Set-LiquitScheduledTask
[-ScheduledTask] <ScheduledTask[]>
[-Name <string>]
[-Enabled <bool>]
[-Description <string>]
[-Triggers <ScheduledTaskTrigger[]>]
[-Notifications <ScheduledTaskNotifications>]
[-Settings <hashtable>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$scheduledTask = Get-LiquitScheduledTask -ID 00000000-0000-0000-0000-000000000000
Set-LiquitScheduledTask -ScheduledTask $scheduledTask -Settings @{Days=30}
This command sets the interval of the scheduled task to 30 days.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| ScheduledTask | <ScheduledTask> |
The scheduled task you want to edit. | Yes | |
| Name | <string> |
A friendly name for the scheduled task. | No | |
| Type | <string> |
The type of scheduled task you want to create. | Yes | |
| Triggers | <ScheduledTaskTrigger[]> |
The trigger used to initiate the scheduled task. | No | |
| Notifications | <ScheduledTaskNotifications> |
The notifications that should be sent when the scheduled task has been executed. | No | |
| Description | <string> |
The description of the scheduled task. | No | |
| Enabled | <bool> |
Determines if the scheduled task is active. | No | true |
| Settings | <hashtable> |
The settings of the scheduled task. | No | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
Start-LiquitScheduledTask
Synopsis
This command starts a scheduled task.
Syntax
Start-LiquitScheduledTask
[-ScheduledTask] <ScheduledTask[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Example
$scheduledTask = Get-LiquitScheduledTask -ID 00000000-0000-0000-0000-000000000000
Start-LiquitScheduledTask -ScheduledTask $scheduledTask
This command starts a scheduled task.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| ScheduledTask | <ScheduledTask> |
The scheduled task you want to start. | Yes | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
Remove-LiquitScheduledTask
Synopsis
This command removes a scheduled task.
Syntax
Remove-LiquitScheduledTask
[-ScheduledTask] <ScheduledTask[]>
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$scheduledTask = Get-LiquitScheduledTask -ID 00000000-0000-0000-0000-000000000000
Remove-LiquitScheduledTask -ScheduledTask $scheduledTask
This command removes the specified scheduled task.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| ScheduledTask | <ScheduledTask[]> |
The scheduled task you want to remove. | Yes | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |