Task Commands

uac task

Task management commands, including creating, updating, deleting, and launching tasks

uac task [OPTIONS] COMMAND [ARGS]...

create

Create a Task

uac task create [OPTIONS] sysId=value retainSysIds=value name=value
                resolveNameImmediately=value summary=value startHeld=value
                startHeldReason=value resPriority=value resPriorityVar=value
                holdResources=value credentials=value credentialsVar=value
                retryMaximum=value retryIndefinitely=value retryInterval=value
                retrySuppressFailure=value lsEnabled=value lsType=value
                lsTime=value lsDayConstraint=value lsNthAmount=value
                lsDuration=value lfEnabled=value lfType=value lfTime=value
                lfDayConstraint=value lfNthAmount=value lfDuration=value
                lfOffsetType=value lfOffsetPercentage=value
                lfOffsetDuration=value lfOffsetDurationUnit=value
                efEnabled=value efType=value efTime=value
                efDayConstraint=value efNthAmount=value efDuration=value
                efOffsetType=value efOffsetPercentage=value
                efOffsetDuration=value efOffsetDurationUnit=value
                userEstimatedDuration=value cpDuration=value
                cpDurationUnit=value twWaitType=value twWaitAmount=value
                twWaitTime=value twWaitDuration=value
                twWaitDayConstraint=value twDelayType=value
                twDelayAmount=value twDelayDuration=value twWorkflowOnly=value
                executionRestriction=value restrictionPeriod=value
                restrictionPeriodBeforeDate=value
                restrictionPeriodAfterDate=value
                restrictionPeriodBeforeTime=value
                restrictionPeriodAfterTime=value logLevel=value
                exclusiveWithSelf=value minRunTime=value maxRunTime=value
                avgRunTime=value lastRunTime=value minRunTimeDisplay=value
                maxRunTimeDisplay=value avgRunTimeDisplay=value
                lastRunTimeDisplay=value runCount=value runTime=value
                firstRun=value lastRun=value simulation=value
                enforceVariables=value lockVariables=value
                overrideInstanceWait=value timeZonePref=value type=value
                agent=value agentVar=value agentCluster=value
                agentClusterVar=value broadcastCluster=value
                broadcastClusterVar=value command=value commandOrScript=value
                script=value runtimeDir=value parameters=value exitCodes=value
                exitCodeProcessing=value exitCodeText=value
                exitCodeOutput=value outputType=value retryExitCodes=value
                waitForOutput=value outputFailureOnly=value
                outputReturnType=value outputReturnFile=value
                outputReturnSline=value outputReturnNline=value
                outputReturnText=value runAsSudo=value

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

sysId=value retainSysIds=value name=value resolveNameImmediately=value summary=value startHeld=value startHeldReason=value resPriority=value resPriorityVar=value holdResources=value credentials=value credentialsVar=value retryMaximum=value retryIndefinitely=value retryInterval=value retrySuppressFailure=value lsEnabled=value lsType=value lsTime=value lsDayConstraint=value lsNthAmount=value lsDuration=value lfEnabled=value lfType=value lfTime=value lfDayConstraint=value lfNthAmount=value lfDuration=value lfOffsetType=value lfOffsetPercentage=value lfOffsetDuration=value lfOffsetDurationUnit=value efEnabled=value efType=value efTime=value efDayConstraint=value efNthAmount=value efDuration=value efOffsetType=value efOffsetPercentage=value efOffsetDuration=value efOffsetDurationUnit=value userEstimatedDuration=value cpDuration=value cpDurationUnit=value twWaitType=value twWaitAmount=value twWaitTime=value twWaitDuration=value twWaitDayConstraint=value twDelayType=value twDelayAmount=value twDelayDuration=value twWorkflowOnly=value executionRestriction=value restrictionPeriod=value restrictionPeriodBeforeDate=value restrictionPeriodAfterDate=value restrictionPeriodBeforeTime=value restrictionPeriodAfterTime=value logLevel=value exclusiveWithSelf=value minRunTime=value maxRunTime=value avgRunTime=value lastRunTime=value minRunTimeDisplay=value maxRunTimeDisplay=value avgRunTimeDisplay=value lastRunTimeDisplay=value runCount=value runTime=value firstRun=value lastRun=value simulation=value enforceVariables=value lockVariables=value overrideInstanceWait=value timeZonePref=value type=value agent=value agentVar=value agentCluster=value agentClusterVar=value broadcastCluster=value broadcastClusterVar=value command=value commandOrScript=value script=value runtimeDir=value parameters=value exitCodes=value exitCodeProcessing=value exitCodeText=value exitCodeOutput=value outputType=value retryExitCodes=value waitForOutput=value outputFailureOnly=value outputReturnType=value outputReturnFile=value outputReturnSline=value outputReturnNline=value outputReturnText=value runAsSudo=value: Optional argument(s)

delete

Delete a Task

uac task delete [OPTIONS] taskid=value taskname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskid=value taskname=value: Required argument(s)

get

Read a Task

uac task get [OPTIONS] taskid=value taskname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskid=value taskname=value: Required argument(s)

launch

Launch a Task

uac task launch [OPTIONS] name=value hold=value hold_reason=value
                time_zone=value virtual_resource_priority=value
                virtual_resources=value launch_reason=value simulate=value
                variables=[comma separated values]

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

-w, --wait

-t, --timeout <timeout>

-i, --interval <interval>

-r, --return_rc

Arguments

name=value hold=value hold_reason=value time_zone=value virtual_resource_priority=value virtual_resources=value launch_reason=value simulate=value variables=[comma separated values]: Required argument(s)

list

List Tasks

uac task list [OPTIONS] name=value type=value business_services=value
              updated_time_type=value updated_time=value workflow_id=value
              workflow_name=value agent_name=value template_id=value
              template_name=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value type=value business_services=value updated_time_type=value updated_time=value workflow_id=value workflow_name=value agent_name=value template_id=value template_name=value: Optional argument(s)

list-advanced

List Tasks - Advanced

uac task list-advanced [OPTIONS] taskname=value agentname=value type=value
                       business_services=value workflowname=value
                       workflowid=value updated_time=value
                       updated_time_type=value templateid=value
                       templatename=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskname=value agentname=value type=value business_services=value workflowname=value workflowid=value updated_time=value updated_time_type=value templateid=value templatename=value: Optional argument(s)

list-workflow-list

List All Workflows That a Task Belongs To

uac task list-workflow-list [OPTIONS] taskname=value taskid=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

taskname=value taskid=value: Optional argument(s)

update

Modify a Task

uac task update [OPTIONS] sys_id=value exclude_related=value variables=value
                notes=value actions=value retain_sys_ids=value name=value
                resolve_name_immediately=value summary=value
                opswise_groups=value start_held=value start_held_reason=value
                res_priority=value hold_resources=value credentials=value
                credentials_var=value retry_maximum=value
                retry_indefinitely=value retry_interval=value
                retry_suppress_failure=value ls_enabled=value ls_type=value
                ls_time=value ls_day_constraint=value ls_nth_amount=value
                ls_duration=value lf_enabled=value lf_type=value lf_time=value
                lf_day_constraint=value lf_nth_amount=value lf_duration=value
                lf_offset_type=value lf_offset_percentage=value
                lf_offset_duration=value lf_offset_duration_unit=value
                ef_enabled=value ef_type=value ef_time=value
                ef_day_constraint=value ef_nth_amount=value ef_duration=value
                ef_offset_type=value ef_offset_percentage=value
                ef_offset_duration=value ef_offset_duration_unit=value
                user_estimated_duration=value cp_duration=value
                cp_duration_unit=value tw_wait_type=value tw_wait_amount=value
                tw_wait_time=value tw_wait_duration=value
                tw_wait_day_constraint=value tw_delay_type=value
                tw_delay_amount=value tw_delay_duration=value
                tw_workflow_only=value custom_field1=value custom_field2=value
                execution_restriction=value restriction_period=value
                restriction_period_before_date=value
                restriction_period_after_date=value
                restriction_period_before_time=value
                restriction_period_after_time=value
                restriction_period_date_list=value log_level=value
                exclusive_with_self=value min_run_time=value
                max_run_time=value avg_run_time=value last_run_time=value
                min_run_time_display=value max_run_time_display=value
                avg_run_time_display=value last_run_time_display=value
                run_count=value run_time=value first_run=value last_run=value
                simulation=value enforce_variables=value lock_variables=value
                override_instance_wait=value time_zone_pref=value
                virtual_resources=value exclusive_tasks=value type=value

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

sys_id=value exclude_related=value variables=value notes=value actions=value retain_sys_ids=value name=value resolve_name_immediately=value summary=value opswise_groups=value start_held=value start_held_reason=value res_priority=value hold_resources=value credentials=value credentials_var=value retry_maximum=value retry_indefinitely=value retry_interval=value retry_suppress_failure=value ls_enabled=value ls_type=value ls_time=value ls_day_constraint=value ls_nth_amount=value ls_duration=value lf_enabled=value lf_type=value lf_time=value lf_day_constraint=value lf_nth_amount=value lf_duration=value lf_offset_type=value lf_offset_percentage=value lf_offset_duration=value lf_offset_duration_unit=value ef_enabled=value ef_type=value ef_time=value ef_day_constraint=value ef_nth_amount=value ef_duration=value ef_offset_type=value ef_offset_percentage=value ef_offset_duration=value ef_offset_duration_unit=value user_estimated_duration=value cp_duration=value cp_duration_unit=value tw_wait_type=value tw_wait_amount=value tw_wait_time=value tw_wait_duration=value tw_wait_day_constraint=value tw_delay_type=value tw_delay_amount=value tw_delay_duration=value tw_workflow_only=value custom_field1=value custom_field2=value execution_restriction=value restriction_period=value restriction_period_before_date=value restriction_period_after_date=value restriction_period_before_time=value restriction_period_after_time=value restriction_period_date_list=value log_level=value exclusive_with_self=value min_run_time=value max_run_time=value avg_run_time=value last_run_time=value min_run_time_display=value max_run_time_display=value avg_run_time_display=value last_run_time_display=value run_count=value run_time=value first_run=value last_run=value simulation=value enforce_variables=value lock_variables=value override_instance_wait=value time_zone_pref=value virtual_resources=value exclusive_tasks=value type=value: Optional argument(s)