> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell/powershell-commands/set-rdmtask.md). # Set-RDMTask ### Synopsis Save or update a task. ### Syntax #### \_\_AllParameterSets ``` Set-RDMTask [-Task] [-Comment ] [-Description ] [-DueDate ] [-Force] [-Name ] [-Priority ] [-Status ] [-UnassignUser] [-User ] [-ForcePromptAnswer ] [-WhatIf] [-Confirm] [] ``` ### Description Save or update a task of the current workspace. 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 save the tasks. To modify fields, this cmdlet parameters can be used or the PSTask can be modified directly. The confirmation impact (ConfirmImpact) is low. ### Examples #### Example 1 ```powershell PS C:\> Get-RDMTask -Name ATask | Set-RDMTask -Comment "Task completed" -Status Closed ``` Add the comment "Task completed" to task ATask and close it. If the name is not unique, all tasks named ATask will have the modifications. #### Example 2 ```powershell PS C:\> New-RDMTask -Name ATask -Entry AnEntry | Set-RDMTask -Force ``` Save a newly created task named ATask and associated with AnEntry without any confirmation prompt. #### Example 3 ```powershell PS C:\> $user = Get-RDMUser -Name AUser; Get-RDMTask -Status Assigned -User $user | Set-RDMTask -UnassignUser ``` Unassign all the tasks assigned the user AUser. #### Example 4 ```powershell PS C:\> $task = Get-RDMTask -Name ATask; $task.Task.CustomField1 = "Whatever"; Set-RDMTask $task ``` Store the uniquely named task ATask in $task. Add a value to the CustomField1 and save the modification using the only positional parameter. #### Example 5 ```powershell PS C:\> Get-RDMTask -Name ATask | Set-RDMTask $task -WhatIf -Verbose -Description 'NewDesc' -DueDate 2023/1/1 -Priority 3 ``` Using the WhatIf and Verbose parameters, it will allow to determine if the task is created or updated and where exactly (workspace name > entry name > task name). No modification will happen. ### Parameters #### -Comment Modify the comment of the task. ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Confirm Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: False SupportsWildcards: false Aliases: - cf ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Description Modify the description of the task. ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -DueDate Specify the deadline to accomplish the task. ```yaml 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: '' ``` #### -Force The task will be saved or created without confirmation. ```yaml 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: '' ``` #### -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. ```yaml 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: '' ``` #### -Name New name for the task. ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: true ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Priority Modify the priority of the task. ```yaml Type: System.Nullable`1[System.Int32] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Status Modify the status of the task. ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Task Task to add or modify. ```yaml Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: 0 IsRequired: true ValueFromPipeline: true ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -UnassignUser Remove the user assigned to the task. ```yaml 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: '' ``` #### -User Assign this user to the task. The user can be specified with their name, their email address, their ID or a PSUserInfo. ```yaml Type: System.Object DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: False SupportsWildcards: false Aliases: - wi 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](https://go.microsoft.com/fwlink/?LinkID=113216). ### Inputs #### RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask The task obtained from Get-RDMTask can be piped to the parameter Task. ### Notes For more information, type "Get-Help Set-RDMTask -detailed". For technical information, type "Get-Help Set-RDMTask -full". --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell/powershell-commands/set-rdmtask.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.