Versions Compared

Key

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

...

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

Use system restart to stop and start pico instances in one or more containers. The Platform will be started if it is not already running. However, the command does not stop the Platform.

Option

Description

[--dry-run]

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

[-l, --local]

Use this option to select the local container, unless another container is specified in the target path.

[-t, --tag <tag>]

Filter that excludes all pico instances 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] [-l, --local] [-t, --tag <tag>] [--timeout-seconds] [-v, --verbose]

Use system start to start pico instances in one or more containers. The Platform will be started if it is not already running. 

Option

Description

[--dry-run]

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

[-l, --local]

Use this option to select the local container, unless another container is specified in the target path.

[-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.

...

stop

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

Use system status to retrieve the running status of stop to stop pico instances in one or more containers. The Platform will be started if it is not already running.   

Option

Description

[--dry-run]

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

[-

t

l, --

tag <tag>]

Filter that excludes all pico instances 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>]

Use system start to start pico instances in one or more containers. The Platform will be started if it is not already running. 

Option

Description

[--dry-run]

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

local]

Use this option to select the local container, unless another container is specified in the target path.

-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:

...