Data Governance Guide
Also available as:
PDF
loading table of contents...

Managing Instances with the CLI

The following table provides information about CLI options you can use to manage feed or process instances:

Table 4.4. Instance Actions

Option

Definition

CLI Usage

continue

Continue a process instance in a terminal state such as SUCCEEDED, KILLED, or FAILED.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -continue -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"

help

Returns help on Falcon commands.

$FALCON_HOME/bin/falcon admin -help

kill

Kills all the instances of the specified process whose nominal time is between the given start time and end time.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -kill -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'

logs

Gets logs for instance actions.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -logs -start "yyyy-MM-dd'T'HH:mm'Z'" [-end "yyyy-MM-dd'T'HH:mm'Z'"] [-runid $runid]

rerun

Rerun a process instance in a terminal state such as SUCCEEDED, KILLED, or FAILED.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -re-run -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" [-file $properties file]

resume

Resumes any instance in a suspended state.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -resume -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"

running

Provides all running instances of the specified process.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -running

status

Gets the status of one or multiple instances of a process.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -status -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"

summary

Summary of the status of feeds or processes within the time periods specified.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -summary -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"

suspend

Suspends one or more instances for the given process. Pauses the parent workflow at the state.

$FALCON_HOME/bin/falcon instance -type $feed/process -name $name -suspend -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"

version

Returns current version of Falcon.

$FALCON_HOME/bin/falcon admin -version