-
Notifications
You must be signed in to change notification settings - Fork 1
OLD_2. prosEO CLI: General Commands
This command is used in order to exit the CLI. Whether the user is logged in or not, the CLI will be exited if the command is used.
An example of the use in MS Windows 10's Command Prompt is shown below:
prosEO (no mission)> exit
C:\...>
The help page of the command, retrieved from the CLI, is hereunder:
prosEO (NM4T)> exit -h
Terminate the Command Line Interface
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --
The command is used in order to retrieve general information (complete help page) but also on the command and subcommand level.
The command, if used as is, can retrieve the complete help page:
prosEO (no mission)> help
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 name>=<attribute value>".
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".
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.)
Options for the 'proseo' command:
-V, --version Show the prosEO CLI version and exit (only for call from shell command line)
-u, --user The user name for login to prosEO.
-p, --password The password for login to prosEO (only valid if a user name for login is given).
-m, --mission The mission to login to (only valid if a user name for login is given)
Options for all commands:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Commands:
exit Terminate the Command Line Interface
help Show the prosEO Command Line Interface help information (this page; for subcommand help, type "<subcommand> --help")
clear Clear the terminal screen (but not the scrollback buffer)
login Log in to a mission in prosEO. All valid commands except for "mission show" require prior login.
logout Log out of prosEO. No commands except "mission show" and "login" will be accepted after logout.
mission Commands related to configuring an earth observation mission
orbit Commands for managing orbits for a given spacecraft
order 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.
job 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.
processor Commands for managing processor classes, processors, configurations and configured processors
configuration Commands for managing configurations of a specific processor class
productclass Commands for managing product classes
product Commands for managing products
ingest Ingest all products into the storage manager of the given processing facility
user 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)
group 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)
facility Commands for managing processing facilities
The command can also be used to retrieve the help page for any of the commands with 2 ways, adding the option -h or the option --help after the command:
prosEO (no mission)> exit -h
Terminate the Command Line Interface
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --
prosEO (no mission)> exit --help
Terminate the Command Line Interface
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --
The command can also retrieve information on the sub-commands with an example given here:
prosEO (no mission)> mission show -h
List all configured missions or only the given one
Options:
--format The output format (one of { JSON, XML, YAML }; default value YAML [human readable])
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
missionCode (optional) The code of the mission to list
Subcommands:
-- none --
prosEO (no mission)>
| NOTE |
|---|
| Some commands have sub-commands of sub-commands! The option -h can retrieve information about those as well! |
Extract of the help page of the command help:
prosEO (no mission)> help -h
Show the prosEO Command Line Interface help information (this page; for subcommand help, type "<subcommand> --help")
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --
The command clear is used to clear the text that appears on the screen and returns the prompt at the top of the window. It is similar to the command in UNIX/Linux.
Extract from the help page:
prosEO (NM4T)> clear -h
Clear the terminal screen (but not the scrollback buffer)
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --
The command login is used in order to login as a specific user to a specific mission. The user is prompted to enter a username and password. The command is granting the users the ability to have access to a series of commands that are not available while the users are logged out. The commands that can be used without login are: exit, help, clear, login, mission show. All the other commands require login.
The following example shows the user logging in to a test mission (NM4T) with a specific username(NM4Tuser1) and password:
prosEO (no mission)> login NM4T
Username (empty field cancels): NM4Tuser1
Password for user NM4Tuser1:
(I2821) User NM4Tuser1 logged in
prosEO (NM4T)>
As shown in the above use case, the system is not allowing the user to notice that the password is being typed/entered.
The extract from the help page is shown below:
prosEO (NM4T)> login -h
Log in to a mission in prosEO. All valid commands except for "mission show" require prior login.
Options:
-u, --user User name
-p, --password The user's password
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
missionCode (optional) The code of the mission to log in to (may be empty for user with prosEO Administrator privileges)
Subcommands:
-- none --
The command is used by the users in order to log themselves out of a mission. As mentioned previously, once logged out, the users can use only the following commands: exit, help, clear, login, mission show.
The below example is showing the process of the user NM4Tuser1 logging out of the mission NM4T:
prosEO (NM4T)> logout
(I2823) User NM4T-NM4Tuser1 logged out
prosEO (no mission)>
The extract from the help page is shown below:
prosEO (no mission)> logout -h
Log out of prosEO. No commands except "mission show" and "login" will be accepted after logout.
Options:
-h, --help Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
-- none --
Subcommands:
-- none --