Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleUsage
Usage: cancel-orders.sh [Options] [Switches]

  Options:
    --url=<url>                   | required: JOC Cockpit URL
    --controller-id=<identifier>  | required: Controller ID
    --user=<account>              | required: JOC Cockpit user account
    --password=<password>         | optional: JOC Cockpit password
    --ca-cert=<path>              | optional: path to CA Certificate used for JOC Cockpit login
    --client-cert=<path>          | optional: path to Client Certificate used for login
    --client-key=<path>           | optional: path to Client Key used for login
    --date-to=<date>              | optional: orders scheduled before the given date will be cancelled, default: now
    --time-zone=<tz>              | optional: specifies the time zone for the given date, default: Europe/London<time-zone>
                                              see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    --states=<state[,state]>      | optional: list of states limiting orders that will be cancelled, default: SCHEDULED
                                              PLANNED, PENDING, SCHEDULED, INPROGRESS, RUNNING, SUSPENDED, WAITING, PROMPTING, FAILED, BLOCKED, UNKNOWN
    --folders=<path[,path]>       | optional: list of folders holding workflows for which scheduled orders will be cancelled
    --workflows=<path[,path]>     | optional: list of workflows for which scheduled orders will be cancelled
    --log-dir=<directory>         | optional: path to the directory holding the script's batch log files

  Switches:
    -h | --help                   | displays usage
    -v | --verbose                | displays verbose output
    -p | --password               | asks for password
    -r | --recursive              | specifies folders to be looked up recursively
    -k | --kill                   | specifies that tasks of running orders will be killed
    -t | --sigterm                | specifies that tasks of running orders will be sent a SIGTERM signal before SIGKILL
    --show-logs                   | shows log output if --log-dir is used
    --make-dirs                   | creates directories if they do not exist

...