< Back

Set-AMTask

Sat Jan 11, 2020 3:36 am

NAME Set-AMTask



SYNOPSIS

Sets properties of an AutoMate Enterprise task.





SYNTAX

Set-AMTask -InputObject <Object> [-Notes <String>] [-AML <String>] [-CompletionState {InDevelopment | Testing |

Production | Archive}] [-WhatIf] [-Confirm] [<CommonParameters>]



Set-AMTask -Instance <Object> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set-AMTask can change properties of a task object.





PARAMETERS

-InputObject <Object>

The object to modify.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Instance <Object>

The task object to save directly to the server. This parameter takes a task that has been manually modified

to be saved as-is to the server.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AML <String>

The new AutoMate Markup Language (AML) to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CompletionState

The completion state (staging level) to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

The following AutoMate object types can be modified by this function:

Task





OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Change notes for a task



Get-AMTask "Delete Log Files" | Set-AMTask -Notes "Deletes old log files"









-------------------------- EXAMPLE 2 --------------------------



PS C:\\># Change AML for a task



Get-AMTask "Some Task" | Set-AMTask -AML (Get-AMTask "Some Other Task").AML











RELATED LINKS

https://github.com/AutomatePS/AutomatePS