Versions Compared

Key

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

...

  • help
  • restart
  • start
  • status
  • stop

help

Code Block
Usage: system help [<subcommand>]

...

Code Block
languagetext
$ mzsh system help <command>

restart

Code Block
Usage: system restart [--dry-run] [-services] [-t, --tag <tag>] [--timeout-seconds] [-v, --verbose] [<target path>]

...

OptionDescription

[--dry-run]

Lists the picos instances that are addressed by the command, but the command is not executed.

[-t, --tag <tag>]

Filter that excludes all pico instance that do not contain the specified tag.
[--timeout-seconds]

Sets the maximum allowed time for all calls to complete. The default value is 300 seconds.

[-v, --verbose]Use this option for detailed output from the command.

start

Code Block
Usage: system start [--dry-run] [-t, --tag <tag>] [--timeout-seconds] [-v, --verbose]

...

OptionDescription

[--dry-run]

Lists the picos instances that are addressed by the command, but the command is not executed.

[-t, --tag <tag>]

Includes pico instances in the target path that contain the specified tag.
[--timeout-seconds]

Sets the maximum allowed time for all calls to complete. The default value is 300 seconds.

[-v, --verbose]Use this option for detailed output from the command.

status

Code Block
Usage: system status [--dry-run] [-t, --tag <tag>] [--timeout-seconds] [-v, --verbose] [<target path>]

...

OptionDescription

[--dry-run]

Lists the picos instances that are addressed by the command, but the command is not executed.

[-t, --tag <tag>]

Filter that excludes all pico instance that do not contain the specified tag.
[--timeout-seconds]

Sets the maximum allowed time for all calls to complete. The default value is 300 seconds.

[-v, --verbose]Use this option for detailed output from the command.

stop

Code Block
Usage: system stop [--dry-run] [-t, --tag <tag>] [--timeout-seconds] [-v, --verbose] [<target path>]

...

OptionDescription

[--dry-run]

Lists the picos instances that are addressed by the command, but the command is not executed.

-t, --tag <tag>]

Includes pico instances in the target path that contain the specified tag.
[--timeout-seconds]

Sets the maximum allowed time for all calls to complete. The default value is 300 seconds.

[-v, --verbose]Use this option for detailed output from the command.

Return Codes

Listed below are the different return codes for the system command:

...