Versions Compared

Key

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

...

  • --controller-id
    • Specifies the Controller ID for which changes are applied.
    • The Controller ID must be specified. This applies to use of a Controller's or Agent's journal.
  • --journal-dir
    • Specifies the directory in which a Controller's or Agent's journal is available. Typically the state sub-directory of the data directory is used.
    • Permissions to read and to write to the directory and files are required.
  • --backup-dir
    • Specifies an existing directory to which backups of journal files will be added. Write permissions for the directory are required.
    • A sub-directory in the indicated directory will be created following the scheme: <backup-directory>/update-journal.<agent|controller>.<host>.<yyyy-MM-ddThh-mm-ss>
    • Example: /var/backups/js7/update-journal.controller.centostest_primary.2023-12-06T02-14-23
  • --agent-id
    • Specifies the Agent ID of an Agent that should be removed from a Controller's journal.. More than one Agent ID can be specified separated by comma.
    • Removing an Agent ID from the journal will remove any orders and workflows related to the given Agent from the same.
      • Workflows are removed only if the first job of the workflow is assigned the Agent to be removed.
      • To remove workflows holding later jobs assigned the specified Agent use the --workflow option.
    • One of the options --agent-id, --order-id or --workflow has to be specified.
  • --order-id
    • Specifies the Order ID that should be removed from the journal. More than one Order ID can be specified separated by comma.
    • One of the options --agent-id, --order-id or --workflow has to be specified.
  • --workflow
    • Specifies the workflow that should be removed from the journal. More than one workflow can be specified separated by comma.
    • This option expects the name of a workflow, not its path. Regular expression syntax can be used to specify a number of workflows, for example:
      • my-workflow.*   removes any workflows with a name starting with my-workflow followed by any characters (right truncation).
      • .*my-workflow   removes any workflows with a name starting with any characters ending with my-workflow (left truncation).
      • my-.*workflow   removes any workflows with a name starting with my- followed by any characters and ending with workflow.
    • One of the options --agent-id, --order-id or --workflow has to be specified.

...