< Back

Set-AMWorkflowProperty

Sat Jan 11, 2020 3:41 am

NAME Set-AMWorkflowProperty



SYNOPSIS

Sets the properties of an AutoMate Enterprise workflow.





SYNTAX

Set-AMWorkflowProperty [-InputObject] <Object> [-DefaultAgentPropertiesSpecified] [[-DefaultAgent] <Object>]

[-ErrorNotificationPropertiesSpecified] [[-ErrorNotifyEmailFromAddress] <String>] [[-ErrorNotifyEmailToAddress]

<String>] [-DisableOnFailure] [-ResumeFromFailure] [-TimeoutPropertiesSpecified] [-TimeoutEnabled] [[-Timeout]

<Int32>] [[-TimeoutUnit] {Seconds | Minutes | Hours | Days | Milliseconds}] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

Set-AMWorkflowProperty modifies workflow properties.





PARAMETERS

-InputObject <Object>

The workflow property to modify.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-DefaultAgentPropertiesSpecified [<SwitchParameter>]

Override the default agent property inheritance.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-DefaultAgent <Object>

The default agent.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ErrorNotificationPropertiesSpecified [<SwitchParameter>]

Override the error property inheritance.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ErrorNotifyEmailFromAddress <String>

The error email sender.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ErrorNotifyEmailToAddress <String>

The error email recipient.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisableOnFailure [<SwitchParameter>]

Whether the workflow should be automatically disabled on next failure.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ResumeFromFailure [<SwitchParameter>]

Whether the workflow should automatically resume from failure on next run.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-TimeoutPropertiesSpecified [<SwitchParameter>]

Override the timeout property inheritance.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-TimeoutEnabled [<SwitchParameter>]

Whether the timeout property is enabled.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Timeout <Int32>

The timeout duration.



Required? false

Position? 5

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-TimeoutUnit

The timeout unit.



Required? false

Position? 6

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



OUTPUTS





RELATED LINKS

https://github.com/AutomatePS/AutomatePS