The general syntax for commands is:
command [subcommand...] [option...] [parameter...]
Commands can be entered after the "prosEO>" command prompt. They can also be invoked on the shell command line
following the name of the prosEO executable (e. g. "proseo") and at least one whitespace character.
Commands may have subcommands, which precede all options and parameters.
Commands may have options (--option, a short form -o may be given as alias) and parameters
(passed as values without the parameter name).
Modal options can be combined into one option, i. e. "-a -b -c" is the same as "-abc".
Options with values are either of the form "-ovalue" or "--option=value";
in the case of multiple values "--option=value,value,value".
Parameters are positional, except (implicitly) for attribute parameters of the form "=".
Attribute values may be comma-separated string lists, but they cannot represent attributes of more complex types. To set
complex object attributes use the "--file" option and pass a Json, XML or Yaml file.
Options and parameters containing blanks and/or quotes must be quoted, e. g. "-ovalue with blanks" or 'My "quoted" parameter'.
All date-time values must conform to the ISO date-time format ("YYYY-MM-DD[THH:MM:SS.ssssssZ]"), with or without a second,
a fraction of second and/or a time zone, e. g. the following are valid:
"2020-04-08", "2020-04-08T11:30+0200", "2020-04-08T11:30:45.123456Z".
Value parts not specified will be set to zero, i. e. "2020-04-08" will be interpreted as "2020-04-08T00:00:00.000000" in UTC.
Therefore when specifying a time interval using "from"/"to" parameters, be sure to specify the end of the interval correctly,
e. g. to cover the whole day 2020-04-08 (in UTC), "2020-04-08" may be specified for the "from" parameter, but the "to" parameter
must read "2020-04-08T23:59:59.999999" or "2020-04-09".
For all commands except "mission show" a user login is required, all commands except "mission show", "mission create",
"user create" and all facility-related commands require login to a specific mission.
Caution 1: Typing ^C (Control-C) terminates the Command Line Interface immediately.
Caution 2: When run in non-interactive mode (e. g. with input redirection) prompts for missing mandatory attributes do not work.
In this case mandatory attributes must be specified on the command line or in an input file.
(Exception: Selection rules can be read from input redirection.)
Table of Contents
Global Options
| Option | help |
| Short form | h |
| Type | boolean |
| Description | Show help information for the current command/subcommand level (top level commands, when called from the shell command line). |
Options
| Option | version |
| Short form | V |
| Type | boolean |
| Description | Show the prosEO CLI version and exit (only for call from shell command line). |
| Option | identFile |
| Short form | i |
| Type | string |
| Description | Path to a file containing user name (without mission prefix) and password (in two separate lines);
the file will only be read, if it is only readable by the current system user (as far as warranted by the operating system)
. |
| Option | mission |
| Short form | m |
| Type | string |
| Description | The mission to login to (only valid if a user name for login is given). |
Commands
| Command | exit |
| Description | Terminate the Command Line Interface. |
| Subcommands | |
| Options | |
| Parameters | |
| Command | help |
| Description | Show the prosEO Command Line Interface help information (this page; for subcommand help, type " --help"). |
| Subcommands | |
| Options | |
| Parameters | |
| Command | clear |
| Description | Clear the terminal screen (but not the scrollback buffer). |
| Subcommands | |
| Options | |
| Parameters | |
| Command | login |
| Description | Log in to a mission in prosEO. All valid commands except for "mission show" require prior login.. |
| Subcommands | |
| Options | | Option | identFile | | Short form | i | | Type | string | | Description | Path to a file containing user name (without mission prefix) and password (in two separate lines);
the file will only be read, if it is only readable by the current system user (as far as warranted by the operating system)
. |
|
| Parameters | | Parameter | missionCode (optional) | | Type | string | | Description | The code of the mission to log in to (may be empty for user with prosEO Administrator privileges). |
|
| Command | logout |
| Description | Log out of prosEO. No commands except "mission show" and "login" will be accepted after logout.. |
| Subcommands | |
| Options | |
| Parameters | |
| Command | mission |
| Description | Commands related to configuring an earth observation mission. |
| Subcommands | | Command | show | | Description | List all configured missions or only the given one. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give mission details, otherwise show only mission code and name. |
| | Parameters | | Parameter | missionCode (optional) | | Type | string | | Description | The code of the mission to list. |
|
| Command | create | | Description | Create a new earth observation mission in prosEO. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the mission definitions from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | missionCode (optional) | | Type | string | | Description | The code of the mission (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A mission attribute to update in the form "=", overrides values given in the mission definition file. |
|
| Command | update | | Description | Update the mission attributes. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the updated mission definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the mission definition file and/or the command parameters. |
| | Parameters | | Parameter | attribute (optional, repeatable) | | Type | string | | Description | A mission attribute to update in the form "=", overrides values given in the mission definition file. |
|
| Command | delete | | Description | Delete the named mission (optionally including configured items and stored products). | | Subcommands | | | Options | | Option | force | | Type | boolean | | Description | Also delete all configured items (spacecrafts, orbits, processor classes, processors, configurations, configured processors and product classes) for this mission, but no products. |
| Option | delete-products | | Type | boolean | | Description | Also delete all products for this mission (this will also remove the products from any processing facility), valid only if "force" is specified, too (both options need to be specified to avoid unintended data loss). |
| | Parameters | | Parameter | missionCode | | Type | string | | Description | The code of the mission to delete. |
|
| Command | spacecraft | | Description | Commands to manage the spacecrafts for a mission. | | Subcommands | | Command | add | | Description | Add a spacecraft to the mission list of spacecrafts; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the updated mission definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | spacecraftCode (optional) | | Type | string | | Description | The code of the spacecraft to remove (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A spacecraft attribute to set in the form "=". |
|
| Command | remove | | Description | Remove a spacecraft from the mission list of spacecrafts. | | Subcommands | | | Options | | | Parameters | | Parameter | spacecraftCode | | Type | string | | Description | The code of the spacecraft to remove. |
|
| | Options | | | Parameters | |
|
| Options | |
| Parameters | |
| Command | orbit |
| Description | Commands for managing orbits for a given spacecraft. |
| Subcommands | | Command | show | | Description | Lists orbits, optionally restricted to a given orbit number range. | | Subcommands | | | Options | | Option | from | | Type | integer | | Description | Lower bound of orbit number range. |
| Option | to | | Type | integer | | Description | Upper bound of orbit number range. |
| Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give orbit details, otherwise show only spacecraft code, orbit number and start/stop times. |
| | Parameters | | Parameter | spacecraftCode | | Type | string | | Description | The code of the spacecraft the orbits belong to. |
|
| Command | create | | Description | Add or update a set of orbits for the given spacecraft (existing orbits will be updated). | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the orbit definitions from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | spacecraftCode (optional) | | Type | string | | Description | The code of the spacecraft the orbits belong to (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | An orbit attribute to update in the form "=", only allowed if no orbit file is given (i. e. a single orbit is created). |
|
| Command | update | | Description | Update a set of orbits for the given spacecraft. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the orbit definitions from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | spacecraftCode (optional) | | Type | string | | Description | The code of the spacecraft the orbits belong to (mandatory if not read from file). |
| Parameter | orbitNumber (optional) | | Type | string | | Description | The number of the orbit to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | An orbit attribute to update in the form "=", only allowed if no orbit file is given (i. e. a single orbit is updated). |
|
| Command | delete | | Description | Deletes orbits in a given orbit range. | | Subcommands | | | Options | | | Parameters | | Parameter | spacecraftCode | | Type | string | | Description | The code of the spacecraft the orbits belong to. |
| Parameter | from | | Type | integer | | Description | Lower bound of orbit range. |
| Parameter | to (optional) | | Type | integer | | Description | Upper bound of orbit range. |
|
|
| Options | |
| Parameters | |
| Command | order |
| Description | Commands for managing processing orders; some commands can only be issued, if the order is in the correct status. Order status sequence is Initial - Approved - Planned - Released - Running - Completed/Failed - Closed. Additionally an order may be in status "Suspending" after issuing a "suspend" command, until all running job steps are finished.. |
| Subcommands | | Command | show | | Description | Lists orders, optionally restricted to a given time range or a specific processing order. | | Subcommands | | | Options | | Option | from | | Type | datetime | | Description | Lower bound of order start time (rounded down to next full second). |
| Option | to | | Type | datetime | | Description | Upper bound of order start time (rounded up to next full second). |
| Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give order details, otherwise show only order identifier, UUID, start/stop times, mode and state. |
| | Parameters | | Parameter | orderId (optional) | | Type | string | | Description | The order identifier (overrides --from and --to options). |
|
| Command | create | | Description | Create a new processing order (in status Initial); if the input is not from a file, the user will be prompted for mandatory attributes not given on the command line (when prompted for orbits, orbit ranges may be given, e. g. "3000-3003,3005,3009-3011"). | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the order definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | orderId (optional) | | Type | string | | Description | The order identifier for user reference (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | An order attribute to update in the form "=", overrides values given in the order definition file. |
|
| Command | update | | Description | Update a processing order (only allowed in status Initial). | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the order definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the order definition file and/or the command parameters. |
| | Parameters | | Parameter | orderId (optional) | | Type | string | | Description | The order identifier for user reference (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | An order attribute to update in the form "=", overrides values given in the order definition file. |
|
| Command | approve | | Description | Approve the named processing order for planning (must be in status Initial, new status is Approved). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | plan | | Description | Plan the jobs for the named processing order (must be in status Approved, new status is Planned). | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format for the resulting job list (one of { NONE, PLAIN, JSON, XML, YAML }; default value PLAIN), NONE suppresses result output, PLAIN format gives job and job step identifiers only, the other formats give full output of all planned jobs and job steps (may be very verbose!). |
| | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
| Parameter | facility | | Type | string | | Description | The processing facility, on which the order shall be run. |
|
| Command | reset | | Description | Reset the named processing order to initial state (must be in status Approved or Planned, new status is Initial). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | release | | Description | Release the jobs of the named processing order for processing (must be in status Planned, new status is Released; order status will change to Running, when execution of the first job step starts; when all job steps are finished, the status will change again to Completed, if all job steps finished successfully, or Failed, if at least one job step failed). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | suspend | | Description | Suspend starting of further jobs for the named processing order (must be in status Released or Running, new status is Suspending, then Planned, when all running job steps are finished). | | Subcommands | | | Options | | Option | force | | Short form | F | | Type | boolean | | Description | Force the suspend by immediately terminating all running job steps. |
| | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | resume | | Description | Resume starting of jobs for the named processing order after suspend (order must be in status Planned, new status is Released [actually the same command as "release"]). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | cancel | | Description | Cancel the named processing order (remaining jobs are not executed, order state changes to Failed; order must be in status Planned, i. e. it may be necessary to issue a "suspend" command first). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | retry | | Description | Retry the named processing order (failed job steps and jobs are set to status Initial, the order itself is set to status Planned, order must be in status Failed). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | close | | Description | Close the named processing order (must be in status Completed or Failed, new status is Closed). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
| Command | delete | | Description | Delete the named processing order (only allowed in status Initial or Closed). | | Subcommands | | | Options | | | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
|
|
| Options | |
| Parameters | |
| Command | job |
| Description | Commands for managing jobs; some commands can only be issued, if the job is in the correct status. Job status sequence is Initial - Released - Started - Completed/Failed. Additionally a job may be in status "On Hold" after issuing a "suspend" command, until all running job steps are finished.. |
| Subcommands | | Command | show | | Description | Lists jobs for an order, optionally restricted to a specific job state. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give job details including job steps, otherwise show only job database ID, start/stop times and state. |
| | Parameters | | Parameter | orderId | | Type | string | | Description | The order identifier. |
| Parameter | jobState (optional) | | Type | string | | Description | The job state (one of { INITIAL, RELEASED, STARTED, ON_HOLD, COMPLETED, FAILED }). |
|
| Command | suspend | | Description | Suspend starting of further job steps for the named job (must be in status Released or Started, new status is On Hold, then Initial, when all running job steps are finished). | | Subcommands | | | Options | | Option | force | | Short form | F | | Type | boolean | | Description | Force the suspend by immediately terminating all running job steps. |
| | Parameters | | Parameter | jobId | | Type | integer | | Description | The persistent database ID of the job. |
|
| Command | resume | | Description | Resume starting of job steps for the named job after suspend (job must be in status Initial, new status is Released). | | Subcommands | | | Options | | | Parameters | | Parameter | jobId | | Type | integer | | Description | The persistent database ID of the job. |
|
| Command | cancel | | Description | Cancel the named job (remaining job steps are not executed, job state changes to Failed; job must be in status Initial, i. e. it may be necessary to issue a "suspend" command first). | | Subcommands | | | Options | | | Parameters | | Parameter | jobId | | Type | integer | | Description | The persistent database ID of the job. |
|
| Command | retry | | Description | Retry the named job (failed job steps and the job itself are set to status Initial, job must be in status Failed). | | Subcommands | | | Options | | | Parameters | | Parameter | jobId | | Type | integer | | Description | The persistent database ID of the job. |
|
| Command | step | | Description | Commands for managing job steps; some commands can only be issued, if the job step is in the correct status. Job step status sequence is Initial - [Waiting Input -] Ready - Running - Completed/Failed.. | | Subcommands | | Command | show | | Description | Lists job steps for a job, optionally restricted to a specific job step state. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give job step details, otherwise show only job step database ID, output product class and state. |
| | Parameters | | Parameter | jobId | | Type | integer | | Description | The persistent database ID of the job. |
| Parameter | jobStepState (optional) | | Type | string | | Description | The job step state (one of { INITIAL, WAITING_INPUT, READY, RUNNING, COMPLETED, FAILED }). |
|
| Command | suspend | | Description | Suspend the named job step (must be in status Ready or Running). | | Subcommands | | | Options | | Option | force | | Short form | F | | Type | boolean | | Description | Force the suspend by immediately terminating the job step, if it is already running. |
| | Parameters | | Parameter | jobStepId | | Type | integer | | Description | The persistent database ID of the job step. |
|
| Command | resume | | Description | Resume a previously suspended job step (job step must be in status Initial, new status is Waiting Input or Ready). | | Subcommands | | | Options | | | Parameters | | Parameter | jobStepId | | Type | integer | | Description | The persistent database ID of the job step. |
|
| Command | cancel | | Description | Cancel the named job step (job step state changes to Failed; job step must be in status Initial or Running, i. e. it may be necessary to issue a "suspend" command first). | | Subcommands | | | Options | | | Parameters | | Parameter | jobStepId | | Type | integer | | Description | The persistent database ID of the job step. |
|
| Command | retry | | Description | Retry the named job step (job step state changes to Initial, job step must be in status Failed). | | Subcommands | | | Options | | | Parameters | | Parameter | jobStepId | | Type | integer | | Description | The persistent database ID of the job step. |
|
| | Options | | | Parameters | |
|
| Options | |
| Parameters | |
| Command | processor |
| Description | Commands for managing processor classes, processors, configurations and configured processors. |
| Subcommands | | Command | class | | Description | Commands for managing processor classes. | | Subcommands | | Command | show | | Description | Show all processor classes for the current mission and optionally a given class name. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give processor class details , otherwise show only processor class name. |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor class to show. |
|
| Command | create | | Description | Create a new processor class for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processor class definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor class to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A processor class attribute to set in the form "=". |
|
| Command | update | | Description | Update a processor class for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processor class definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor classes to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A processor class attribute to set in the form "=". |
|
| Command | delete | | Description | Remove the named processor class from the current mission. | | Subcommands | | | Options | | | Parameters | | Parameter | processorClass | | Type | string | | Description | The name of the processor classes to update (mandatory if not read from file). |
|
| | Options | | | Parameters | |
| Command | show | | Description | Show all processor versions for the current mission or only the selected ones. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give processor details, otherwise show only processor class name and processor version. |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The class name of the processor to show. |
| Parameter | processorVersion (optional) | | Type | string | | Description | The version of the processor to show. |
|
| Command | create | | Description | Create a new processor version for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processor version definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The class name of the processor to create (mandatory if not read from file). |
| Parameter | processorVersion (optional) | | Type | string | | Description | The version of the processor to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A processor attribute to set in the form "=". |
|
| Command | update | | Description | Update a processor version for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processor version definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the order definition file and/or the command parameters. |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The class name of the processor to update (mandatory if not read from file). |
| Parameter | processorVersion (optional) | | Type | string | | Description | The version of the processor to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A processor attribute to set in the form "=". |
|
| Command | delete | | Description | Delete a processor version from the current mission. | | Subcommands | | | Options | | | Parameters | | Parameter | processorClass | | Type | string | | Description | The class name of the processor to delete. |
| Parameter | processorVersion | | Type | string | | Description | The version of the processor to delete. |
|
| Command | configuration | | Description | Commands to manage configured processors (combinations of processor versions and processor class configurations). | | Subcommands | | Command | show | | Description | Show all configured processors for the current mission or only the one identified. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give configured processor details, otherwise show only identifier, UUID and and key data for linked processor and configuration. |
| | Parameters | | Parameter | configuredProcessorIdentifier (optional) | | Type | string | | Description | The identifier of the configured processor. |
|
| Command | create | | Description | Create a new configured processor by combining a processor version and a (processor class) configuration; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the configured processor definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | configuredProcessorIdentifier (optional) | | Type | string | | Description | The identifier of the configured processor. |
| Parameter | processorClass (optional) | | Type | string | | Description | The class name of the processor (mandatory if not read from file). |
| Parameter | processorVersion (optional) | | Type | string | | Description | The version of the processor (mandatory if not read from file). |
| Parameter | configurationVersion (optional) | | Type | string | | Description | The version of the processor class configuration (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A configured processor attribute to set in the form "=". |
|
| Command | update | | Description | Update a configured processor; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the configured processor definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | configuredProcessorIdentifier (optional) | | Type | string | | Description | The identifier of the configured processor (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A configured processor attribute to set in the form "=". |
|
| Command | delete | | Description | Delete a configured processor. | | Subcommands | | | Options | | | Parameters | | Parameter | configuredProcessorIdentifier | | Type | string | | Description | The identifier of the configured processor to delete. |
|
| | Options | | | Parameters | |
|
| Options | |
| Parameters | |
| Command | configuration |
| Description | Commands for managing configurations of a specific processor class. |
| Subcommands | | Command | show | | Description | Show all configurations for the current mission and optionally the given processor class and configuration version. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give configuration details, otherwise show only processor class name and configuration version. |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor class for the configurations. |
| Parameter | configurationVersion (optional) | | Type | string | | Description | The configuration versions to show. |
|
| Command | create | | Description | Create a new configuration for the given processor class in the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the configuration definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor class (mandatory if not read from file). |
| Parameter | configurationVersion (optional) | | Type | string | | Description | The version of the configuration to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A configuration attribute to set in the form "=". |
|
| Command | update | | Description | Update a configuration for the given processor class in the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the configuration definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the order definition file and/or the command parameters. |
| | Parameters | | Parameter | processorClass (optional) | | Type | string | | Description | The name of the processor class (mandatory if not read from file). |
| Parameter | configurationVersion (optional) | | Type | string | | Description | The version of the configuration to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A configuration attribute to set in the form "=". |
|
| Command | delete | | Description | Remove a configuration from the given processor class in the current mission. | | Subcommands | | | Options | | | Parameters | | Parameter | processorClass | | Type | string | | Description | The name of the processor class. |
| Parameter | configurationVersion | | Type | string | | Description | The version of the configuration to delete. |
|
|
| Options | |
| Parameters | |
| Command | workflow |
| Description | Commands for managing workflows. |
| Subcommands | | Command | show | | Description | Show all workflows for the current mission or only the selected ones. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give workflow details, otherwise show only workflow name and workflow version. |
| Option | input-product-class | | Type | string | | Description | The input product class of the workflow to show. |
| | Parameters | | Parameter | name (optional) | | Type | string | | Description | The name of the workflow to show. |
| Parameter | workflowVersion (optional) | | Type | string | | Description | The version of the workflow to show. |
|
| Command | create | | Description | Create a new workflow for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the workflow definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | name (optional) | | Type | string | | Description | The name of the workflow to create (mandatory if not read from file). |
| Parameter | workflowVersion (optional) | | Type | string | | Description | The version of the workflow to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A workflow attribute to set in the form "=". |
|
| Command | update | | Description | Update a workflow for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the workflow definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the workflow definition file and/or the command parameters. |
| | Parameters | | Parameter | name (optional) | | Type | string | | Description | The name of the workflow to update (mandatory if not read from file). |
| Parameter | workflowVersion (optional) | | Type | string | | Description | The version of the workflow to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A workflow attribute to set in the form "=". |
|
| Command | delete | | Description | Delete a workflow from the current mission. | | Subcommands | | | Options | | | Parameters | | Parameter | workflowClass | | Type | string | | Description | The name of the workflow to delete. |
| Parameter | workflowVersion | | Type | string | | Description | The version of the workflow to delete. |
|
|
| Options | |
| Parameters | |
| Command | productclass |
| Description | Commands for managing product classes. |
| Subcommands | | Command | show | | Description | Show all product classes for the current mission or only the selected ones. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give product class details, otherwise show only product class name. |
| | Parameters | | Parameter | productClass (optional) | | Type | string | | Description | The name of the product class to show. |
|
| Command | create | | Description | Create a new product class for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product class definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | productClass (optional) | | Type | string | | Description | The name of the product class name to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A product class attribute to set in the form "=". |
|
| Command | update | | Description | Update a product class for the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product class definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the product class definition file and/or the command parameters. |
| | Parameters | | Parameter | productClass (optional) | | Type | string | | Description | The name of the product class name to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A product class attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the named product class from the current mission. | | Subcommands | | | Options | | | Parameters | | Parameter | productClass | | Type | string | | Description | The name of the product class to delete. |
|
| Command | rule | | Description | Commands for managing selection rules. | | Subcommands | | Command | show | | Description | Show all selection rules for the current mission and the given target and source product classes. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { PLAIN, JSON, XML, YAML }; default value PLAIN [rule language]).. |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give rule details including job steps, otherwise show rule as in PLAIN format. |
| | Parameters | | Parameter | targetProductClass | | Type | string | | Description | The product class using the selection rules. |
| Parameter | sourceProductClass (optional) | | Type | string | | Description | The product class requested by the selection rules. |
|
| Command | create | | Description | Create a new selection rule for the given target product class; the user will be prompted for mandatory attributes not given on the command line. If no file name is given, the user will be prompted to enter the selection rule in Rule Language.. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the selection rule definition from. |
| Option | format | | Type | string | | Description | The file format (one of { PLAIN, JSON, XML, YAML }; default value JSON, or PLAIN if no input file is given). |
| | Parameters | | Parameter | targetProductClass (optional) | | Type | string | | Description | The target product class name (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A selection rule attribute to set in the form "=". |
|
| Command | update | | Description | Update a selection rule for the given target class and configured processor; the user will be prompted for mandatory attributes not given on the command line. If no file name is given, the user will be prompted to enter the selection rule in Rule Language. If multiple rules exist for the target product class, the user will be prompted to select the rule to apply the update to.. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the selection rule definition from. |
| Option | format | | Type | string | | Description | The file format (one of { PLAIN, JSON, XML, YAML }; default value JSON, or PLAIN if no input file is given). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the selection rule definition file and/or the command parameters. |
| | Parameters | | Parameter | targetProductClass (optional) | | Type | string | | Description | The target product class name (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A selection rule attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the selection rule(s) for the given target class. | | Subcommands | | | Options | | | Parameters | | Parameter | targetProductClass | | Type | string | | Description | The product class name of the selection rule. |
| Parameter | ruleId | | Type | string | | Description | The database ID of the selection rule to delete. |
|
| | Options | | | Parameters | |
|
| Options | |
| Parameters | |
| Command | product |
| Description | Commands for managing products. |
| Subcommands | | Command | show | | Description | Show products for a mission and product class, optionally restricted to a given time range. | | Subcommands | | | Options | | Option | from | | Type | datetime | | Description | Lower bound of sensing start time (rounded down to next full second). |
| Option | to | | Type | datetime | | Description | Upper bound of sensing start time (rounded up to next full second). |
| Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give product details, otherwise show database ID, UUID and validity period only (verbose is assumed if product database ID is given as parameter). |
| | Parameters | | Parameter | productClass (repeatable) | | Type | string | | Description | The name of the product class to show. |
| Parameter | id (optional) | | Type | integer | | Description | The database ID of the product to show (overrides "from" and "to" parameters). |
|
| Command | create | | Description | Create a new product for the given product class in the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | productClass (optional) | | Type | string | | Description | The class name of the product to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A product attribute to set in the form "=". |
|
| Command | update | | Description | Update a product for the given product class in the current mission; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the product definition file and/or the command parameters. |
| | Parameters | | Parameter | id (optional) | | Type | integer | | Description | The database ID of the product to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A product attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the product with the given database ID. | | Subcommands | | | Options | | | Parameters | | Parameter | id | | Type | integer | | Description | The database ID of the product to delete. |
|
| Command | file | | Description | Commands for managing individual product files at a processing facility. | | Subcommands | | Command | show | | Description | Show the product files for a given product, optionally restricted to a processing facility. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give product file details, otherwise show processing facility and product filenames only (setting processing facility parameter implies verbose). |
| | Parameters | | Parameter | productId | | Type | integer | | Description | The database ID of the product, to which the product files belong. |
| Parameter | processingFacility (optional) | | Type | string | | Description | The processing facility, at which a product file is stored. |
|
| Command | delete | | Description | Delete a product file for a given product and processing facility. | | Subcommands | | | Options | | Option | noErase | | Short form | n | | Type | boolean | | Description | Do not erase the data file(s) from the storage area, e. g. if they are read-only (default "false"). |
| | Parameters | | Parameter | productId | | Type | integer | | Description | The database ID of the product, to which the product files belong. |
| Parameter | processingFacility | | Type | string | | Description | The processing facility, at which the product file is stored. |
|
| | Options | | | Parameters | |
|
| Options | |
| Parameters | |
| Command | ingest |
| Description | Ingest all products into the storage manager of the given processing facility. |
| Subcommands | |
| Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the ingested products from (mandatory). |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | noCopy | | Short form | n | | Type | boolean | | Description | If set, files will not be copied to a new location, if source and target storage types are equal. |
|
| Parameters | | Parameter | processingFacility | | Type | string | | Description | The name of the facility to ingest the products to. |
|
| Command | user |
| Description | Commands for managing users (note that user names are stored with a mission prefix in the user database, but the mission prefix is not used in the command-line interface). |
| Subcommands | | Command | show | | Description | Show user accounts for the current mission. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give user details, otherwise show usernames only (setting username parameter implies verbose). |
| | Parameters | | Parameter | userName (optional) | | Type | string | | Description | The name of the user account to show (without mission prefix). |
|
| Command | create | | Description | Create a new user account within the given mission. Unless the --identFile/-i option is given, the user will be prompted for a password (specifying the password in the user account file or on the command line is not supported for security reasons). | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the user account definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | mission | | Short form | m | | Type | string | | Description | The mission to create the user for (only valid if not yet logged in into a mission; basically intended for creating a single user with "ROLE_USERMGR" for a new mission). |
| Option | identFile | | Short form | i | | Type | string | | Description | Path to a file containing user name (without mission prefix) and password (in two separate lines);
the file will only be read, if it is only readable by the current system user (as far as warranted by the operating system)
. |
| | Parameters | | Parameter | userName (optional) | | Type | string | | Description | The name of the user account to create (without mission prefix; mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A user attribute to set in the form "=". |
|
| Command | update | | Description | Update the given user account; the user will be prompted for mandatory attributes not given on the command line. For security reasons, this command does not support changing passwords, please use the "password" command.. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the user account definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the user account definition file and/or the command parameters. |
| | Parameters | | Parameter | userName (optional) | | Type | string | | Description | The name of the user account to update (without mission prefix; mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A user account attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the user account with the given name. | | Subcommands | | | Options | | Option | mission | | Short form | m | | Type | string | | Description | The mission to delete the user from (only valid if not yet logged in into a mission; basically intended for removing the last user with "ROLE_USERMGR" from a mission before deletion). |
| | Parameters | | Parameter | userName | | Type | string | | Description | The name of the user account to delete (without mission prefix). |
|
| Command | enable | | Description | Enable the user account with the given name. | | Subcommands | | | Options | | | Parameters | | Parameter | userName | | Type | string | | Description | The name of the user account to enable (without mission prefix). |
|
| Command | disable | | Description | Disable the user account with the given name. | | Subcommands | | | Options | | | Parameters | | Parameter | userName | | Type | string | | Description | The name of the user account to disable (without mission prefix). |
|
| Command | grant | | Description | Grant authorities for the current mission directly to the user (not recommended, use of group authorities recommended). | | Subcommands | | | Options | | | Parameters | | Parameter | userName | | Type | string | | Description | The name of the user account to grant authorities to (without mission prefix; mandatory if not read from file). |
| Parameter | authority (repeatable) | | Type | string | | Description | An authority to grant (multiple authorities allowed). |
|
| Command | revoke | | Description | Revoke authorities for the current mission from the user (directly granted authorities only). | | Subcommands | | | Options | | | Parameters | | Parameter | userName | | Type | string | | Description | The name of the user account to revoke authorities from (without mission prefix; mandatory if not read from file). |
| Parameter | authority (repeatable) | | Type | string | | Description | An authority to revoke (multiple authorities allowed). |
|
|
| Options | |
| Parameters | |
| Command | password |
| Description | Interactively change the password of the logged in user, or of the named user,
if executed by a user with user manager permissions
. |
| Subcommands | |
| Options | |
| Parameters | | Parameter | userName (optional) | | Type | string | | Description | The name of the user account to change the password for (default is the logged in user). |
|
| Command | group |
| Description | Commands for managing groups (note that group names are stored with a mission prefix in the user database, but the mission prefix is not used in the command-line interface). |
| Subcommands | | Command | show | | Description | Show user groups for the current mission. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give user group details, otherwise show group names only (setting group name parameter implies verbose). |
| | Parameters | | Parameter | groupName (optional) | | Type | string | | Description | The name of the user group to show (without mission prefix). |
|
| Command | create | | Description | Create a new user group within the given mission. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the user group definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | groupName (optional) | | Type | string | | Description | The name of the user group to create (without mission prefix; mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A group attribute to set in the form "=". |
|
| Command | update | | Description | Update the given user group; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the user group definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the user group definition file and/or the command parameters. |
| | Parameters | | Parameter | groupName (optional) | | Type | string | | Description | The name of the user group to update (without mission prefix; mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A user group attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the group account with the given name. | | Subcommands | | | Options | | | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to delete (without mission prefix). |
|
| Command | grant | | Description | Grant authorities for the current mission to the user group. | | Subcommands | | | Options | | | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to grant authorities to (without mission prefix). |
| Parameter | authority (repeatable) | | Type | string | | Description | An authority to grant (multiple authorities allowed). |
|
| Command | revoke | | Description | Revoke authorities for the current mission from the user group. | | Subcommands | | | Options | | | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to revoke authorities from (without mission prefix). |
| Parameter | authority (repeatable) | | Type | string | | Description | An authority to revoke (multiple authorities allowed). |
|
| Command | members | | Description | List the user accounts of a user group (for the current mission only, users may have different group associations in different missions). | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give user details, otherwise show user names only. |
| | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to list the users for (without mission prefix). |
|
| Command | add | | Description | Add user accounts to the user group (for the current mission only, users may have different group associations in different missions). | | Subcommands | | | Options | | | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to add users to (without mission prefix). |
| Parameter | userName (repeatable) | | Type | string | | Description | The name of a user account to add (without mission prefix; multiple user names allowed). |
|
| Command | remove | | Description | Remove user accounts from the user group (for the current mission only). | | Subcommands | | | Options | | | Parameters | | Parameter | groupName | | Type | string | | Description | The name of the user group to remove users from (without mission prefix). |
| Parameter | userName (repeatable) | | Type | string | | Description | The name of a user account to add (without mission prefix; multiple user names allowed). |
|
|
| Options | |
| Parameters | |
| Command | facility |
| Description | Commands for managing processing facilities. |
| Subcommands | | Command | show | | Description | Show all processing facilities or a specific one. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give facility details, otherwise show facility names only (setting facilityName parameter implies verbose). |
| Option | showPasswords | | Short form | s | | Type | boolean | | Description | If set, show passwords for Processing Facility users, otherwise show placeholder. |
| | Parameters | | Parameter | facilityName (optional) | | Type | string | | Description | The name of the processing facility to show. |
|
| Command | create | | Description | Create a new processing facility; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processing facility definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | facilityName (optional) | | Type | string | | Description | The name of the facility to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A facility attribute to set in the form "=". |
|
| Command | update | | Description | Update a processing facility; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the processing facility definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the processing facility definition file and/or the command parameters. |
| | Parameters | | Parameter | facilityName (optional) | | Type | string | | Description | The name of the facility to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A facility attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the processing facility with the given name. | | Subcommands | | | Options | | | Parameters | | Parameter | facilityName | | Type | string | | Description | The name of the facility to delete. |
|
|
| Options | |
| Parameters | |
| Command | archive |
| Description | Commands for managing product archive. |
| Subcommands | | Command | show | | Description | Show all product archives or a specific one. | | Subcommands | | | Options | | Option | format | | Type | string | | Description | The output format (one of { JSON, XML, YAML }; default value YAML [human readable]). |
| Option | verbose | | Short form | v | | Type | boolean | | Description | If set, give product archive details, otherwise show product archive names only (setting archiveName parameter implies verbose). |
| Option | showPasswords | | Short form | s | | Type | boolean | | Description | If set, show passwords for Product Archive users, otherwise show placeholder. |
| | Parameters | | Parameter | archiveName (optional) | | Type | string | | Description | The name of the product archive to show. |
|
| Command | create | | Description | Create a new product archive; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product archive definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| | Parameters | | Parameter | archiveName (optional) | | Type | string | | Description | The name of the archive to create (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A archive attribute to set in the form "=". |
|
| Command | update | | Description | Update a product archive; the user will be prompted for mandatory attributes not given on the command line. | | Subcommands | | | Options | | Option | file | | Short form | f | | Type | string | | Description | Path to file to read the product archive definition from. |
| Option | format | | Type | string | | Description | The file format (one of { JSON, XML, YAML }; default value JSON). |
| Option | delete-attributes | | Type | boolean | | Description | Delete non-mandatory attributes not given in the product archive definition file and/or the command parameters. |
| | Parameters | | Parameter | archiveName (optional) | | Type | string | | Description | The name of the archive to update (mandatory if not read from file). |
| Parameter | attribute (optional, repeatable) | | Type | string | | Description | A archive attribute to set in the form "=". |
|
| Command | delete | | Description | Delete the product archive with the given name. | | Subcommands | | | Options | | | Parameters | | Parameter | archiveName | | Type | string | | Description | The name of the archive to delete. |
|
|
| Options | |
| Parameters | |