Get-RDMTask

Synopsis

Retrieve the list of tasks of the current workspace.

Syntax

__AllParameterSets

Get-RDMTask [-CaseSensitive] [-CreationDateEnd <datetime>] [-CreationDateStart <datetime>]
 [-Due <DateFilter>] [-DueDateEnd <datetime>] [-DueDateStart <datetime>] [-Entry <Object>]
 [-LiteralName <string[]>] [-Name <string[]>] [-Status <TodoStatus[]>] [-User <Object[]>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Allows to search tasks with differents parameters on the user's main and private vaults. This feature is only available for the following workspaces: Devolutions Server, Azure SQL, SQL Server, and SQLite. If the workspace does not support users, the parameter User will be simply ignored. If a virtual folder is involved, the user must have the add and edit rights to obtain the tasks.

Examples

Example 1

PS C:\> $tasks = Get-RDMTask -Entry AnEntry -CaseSensitive

Retrieves the tasks of the current workspace associated with the entry AnEntry (case sensitive) and stores it in the variable $tasks.

Example 2

PS C:\> Get-RDMTask -Name Task* -Due Today -Status Open, Assigned, InProgress, Default

Obtain all the tasks of the current workspace that are due Today and are still active.

Example 3

PS C:\> Get-RDMTask -CreationDateStart 2022/1/1 -CreationDateEnd 2022/2/1 -DueDateStart 2022/2/1 -DueDateEnd 2022/3/1

Obtain all the tasks of the current workspace that are due Today and are still active.

Example 4

PS C:\> $user = Get-RDMUser -Name AUser; Get-RDMTask -Status Assigned -User $user | Set-RDMTask -UnassignUser

Unassign all the tasks assigned the user AUser.

Parameters

-CaseSensitive

Case sensitive search when searching the name of the entry, task or user.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-CreationDateEnd

The upper bound for the task's creation date.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-CreationDateStart

The lower bound for the task's creation date.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Due

Filter the tasks based on their due date.

Type: Devolutions.RemoteDesktopManager.DateFilter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DueDateEnd

The upper bound for a custom due date.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DueDateStart

The lower bound for a custom due date.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Entry

Entry the task is assigned to. It can be specified by ID, by name or by PSConnection. Entries in the private vault are accessible. For virtual folders, the add and edit rights are required to get the tasks.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-LiteralName

Name of the task. No characters are interpreted as wildcards.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Name of the task.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Status

Filter the tasks based on the specified status. Multiple status are equivalent to an OR condition.

Type: Devolutions.RemoteDesktopManager.TodoStatus[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-User

Task assigned to those user. The users can be specified with their name, their email address, their ID or their PSUserInfo.

Type: System.Object[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Get-RDMTask -detailed". For technical information, type "Get-Help Get-RDMTask -full".