ocpiremote

Usage:

$ ocpiremote [OPTIONS] COMMAND [ARGS]...

Options:

  • --log-level INTEGER RANGE: Set the logging level. Uses OCPI_LOG_LEVEL env var as default. [default: 4; 0<=x<=20]

  • --color / --no-color: Allow rich coloring of logs. [default: color]

  • --quiet: Set log level to 0.

  • --error: Set log level to 1.

  • --warn: Set log level to 4.

  • -v, --verbose: Set log level to 8.

  • --debug: Set log level to 10.

  • -d, --directory PATH: Specify directory to execute command within. [default: /home/user/opencpi]

  • --dry-run / --no-dry-run: [default: no-dry-run]

  • --install-completion: Install completion for the current shell.

  • --show-completion: Show completion for the current shell, to copy it or customize the installation.

  • --help: Show this message and exit.

Commands:

  • create: Create the server package for the remote…

  • load: Send the server package to the remote…

  • unload: Delete a server sandbox directory

  • reload: Delete a server sandbox directory and then…

  • start: Start server on remoted device

  • restart: Stop and then start server on remote device

  • status: Get status of server on remote device

  • stop: Stop server on remote device

  • test: Test basic connectivity to remote device

  • log: Watch server log in realtime

  • reboot: Reboot the remote device

  • deploy: Deploy OpenCPI boot files to device and…

ocpiremote create

Create the server package for the remote sandbox directory

Usage:

$ ocpiremote create [OPTIONS] RCC Platform HDL Platform

Arguments:

  • RCC Platform: [required]

  • HDL Platform: [required]

Options:

  • -o, --output-dir TEXT: Output directory in which to save newly created server package

  • --valgrind: Load / use Valgrind

  • --optimize, --optimized: Use the optimized (vs. debug) version of the RCC/software platform

  • --help: Show this message and exit.

ocpiremote load

Send the server package to the remote sandbox directory

Usage:

$ ocpiremote load [OPTIONS] RCC Platform HDL Platform

Arguments:

  • RCC Platform: [required]

  • HDL Platform: [required]

Options:

  • -o, --output-dir TEXT: Output directory in which to save newly created server package

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • -r, --port INTEGER RANGE: Remote server port [0<=x<=65535]

  • --valgrind: Load / use Valgrind

  • --optimize, --optimized: Use the optimized (vs. debug) version of the RCC/software platform

  • --help: Show this message and exit.

ocpiremote unload

Delete a server sandbox directory

Usage:

$ ocpiremote unload [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • --help: Show this message and exit.

ocpiremote reload

Delete a server sandbox directory and then reload it

Usage:

$ ocpiremote reload [OPTIONS] RCC Platform HDL Platform

Arguments:

  • RCC Platform: [required]

  • HDL Platform: [required]

Options:

  • -o, --output-dir TEXT: Output directory in which to save newly created server package

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • -r, --port INTEGER RANGE: Remote server port [0<=x<=65535]

  • --valgrind: Load / use Valgrind

  • --optimize, --optimized: Use the optimized (vs. debug) version of the RCC/software platform

  • --help: Show this message and exit.

ocpiremote start

Start server on remoted device

Usage:

$ ocpiremote start [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • -b, --bitstream: Load the OpenCPI testbias bitstream manually whether or not there is one already loaded

  • -e, --environment TEXT: Specify environment settings to ocpiserve

  • -l, --log-level INTEGER RANGE: Specify log level [default: 0; 0<=x<=20]

  • --valgrind: Load / use Valgrind

  • -m, --memory INTEGER RANGE: Specify DMA memory allocation [default: 0; x>=0]

  • --help: Show this message and exit.

ocpiremote restart

Stop and then start server on remote device

Usage:

$ ocpiremote restart [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • -b, --bitstream: Load the OpenCPI testbias bitstream manually whether or not there is one already loaded

  • -e, --environment TEXT: Specify environment settings to ocpiserve

  • -l, --log-level INTEGER RANGE: Specify log level [default: 0; 0<=x<=20]

  • --valgrind: Load / use Valgrind

  • -m, --memory INTEGER RANGE: Specify DMA memory allocation [default: 0; x>=0]

  • --help: Show this message and exit.

ocpiremote status

Get status of server on remote device

Usage:

$ ocpiremote status [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • --help: Show this message and exit.

ocpiremote stop

Stop server on remote device

Usage:

$ ocpiremote stop [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • --help: Show this message and exit.

ocpiremote test

Test basic connectivity to remote device

Usage:

$ ocpiremote test [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • --help: Show this message and exit.

ocpiremote log

Watch server log in realtime

Usage:

$ ocpiremote log [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • --help: Show this message and exit.

ocpiremote reboot

Reboot the remote device

Usage:

$ ocpiremote reboot [OPTIONS]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • --help: Show this message and exit.

ocpiremote deploy

Deploy OpenCPI boot files to device and reboot

Usage:

$ ocpiremote deploy [OPTIONS] RCC Platform HDL Platform

Arguments:

  • RCC Platform: [required]

  • HDL Platform: [required]

Options:

  • -u, --user TEXT: User name for login on remote device [default: root]

  • -p, --password TEXT: User password for login on remote device [default: root]

  • -i, --ip-addr TEXT: Remote server IP address

  • -s, --ssh-options TEXT: ssh options for connecting to remote device [default: -q -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null]

  • -d, --remote-dir TEXT: Directory on remote device to create/use as the server sandbox, or the boot directory for the ‘deploy’ subcommand’ [default: sandbox]

  • --help: Show this message and exit.