Device

rio device

Devices on Rapyuta.io

rio device [OPTIONS] COMMAND [ARGS]...

config

Device Configuration Variables

rio device config [OPTIONS] COMMAND [ARGS]...

create

Create a new config variable on the device

rio device config create [OPTIONS] DEVICE_NAME KEY VALUE

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

VALUE

Required argument

delete

Delete the config variable on the device

rio device config delete [OPTIONS] DEVICE_NAME KEY

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

list

List all the config variables on the Device

rio device config list [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

update

Update the config variable on the device

rio device config update [OPTIONS] DEVICE_NAME KEY VALUE

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

VALUE

Required argument

delete

Deletes one more devices

rio device delete [OPTIONS] [DEVICE_NAME_OR_REGEX]

Options

-f, --force, --silent

Skip confirmation

-a, --all

Delete all devices

-w, --workers <workers>

Number of parallel workers for deleting devices. Defaults to 10.

Arguments

DEVICE_NAME_OR_REGEX

Optional argument

deployments

Lists all the deployments running on the device.

rio device deployments [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

execute

Execute commands on the Device

rio device execute [OPTIONS] DEVICE_NAME [COMMAND]...

Options

--user <user>

--shell <shell>

Arguments

DEVICE_NAME

Required argument

COMMAND

Optional argument(s)

inspect

Inspect the device resource

rio device inspect [OPTIONS] DEVICE_NAME

Options

-f, --format <format_type>

Options:

json | yaml

Arguments

DEVICE_NAME

Required argument

labels

Device Labels

rio device labels [OPTIONS] COMMAND [ARGS]...

create

Create a label for the Device

rio device labels create [OPTIONS] DEVICE_NAME KEY VALUE

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

VALUE

Required argument

delete

Delete the label for the Device

rio device labels delete [OPTIONS] DEVICE_NAME KEY

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

list

List all the labels for the Device

rio device labels list [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

update

Update the label for the Device

rio device labels update [OPTIONS] DEVICE_NAME KEY VALUE

Arguments

DEVICE_NAME

Required argument

KEY

Required argument

VALUE

Required argument

list

List all the devices in the selected Project

rio device list [OPTIONS]

metrics

Device Metrics

rio device metrics [OPTIONS] COMMAND [ARGS]...

list

Lists all the available metrics for the Device

rio device metrics list [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

subscribe

Subscribes the metrics to start collecting it

rio device metrics subscribe [OPTIONS] DEVICE_NAME
                             {cpu|memory|disk|diskio|network|wireless}

Arguments

DEVICE_NAME

Required argument

METRIC

Required argument

unsubscribe

Un-subscribes the metrics to stop collecting it

rio device metrics unsubscribe [OPTIONS] DEVICE_NAME
                               {cpu|memory|disk|diskio|network|wireless}

Arguments

DEVICE_NAME

Required argument

METRIC

Required argument

migrate

Migrate the device from current project to the target project.

rio device migrate [OPTIONS] DEVICE_NAME PROJECT_NAME

Options

--enable-vpn

Enable VPN after migrating to the destination project.

--advertise-routes

Advertise subnets configured in project to VPN peers

Arguments

DEVICE_NAME

Required argument

PROJECT_NAME

Required argument

onboard

Generates the on-boarding script for the Device

To onboard the current device, run the following

exec $(rio device onboard {device-name})

rio device onboard [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

tools

rio device tools [OPTIONS] COMMAND [ARGS]...

init

Initialize device for use with device tools. This is required to be executed first before all tools sub-commands.

rio device tools init [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

port-forward

Forwards the port on the Device to local machine

rio device tools port-forward [OPTIONS] DEVICE_NAME REMOTE_PORT [LOCAL_PORT]

Arguments

DEVICE_NAME

Required argument

REMOTE_PORT

Required argument

LOCAL_PORT

Optional argument

scp

An scp like interface to copy files to and from the device

rio device tools scp [OPTIONS] SOURCE DESTINATION

Arguments

SOURCE

Required argument

DESTINATION

Required argument

service

System manager commands

rio device tools service [OPTIONS] COMMAND [ARGS]...

force-reload

rio device tools service force-reload [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

reload

rio device tools service reload [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

restart

rio device tools service restart [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

start

rio device tools service start [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

status

rio device tools service status [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

status-all

rio device tools service status-all [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

stop

rio device tools service stop [OPTIONS] DEVICE_NAME SERVICE_NAME

Arguments

DEVICE_NAME

Required argument

SERVICE_NAME

Required argument

ssh

SSH to the Device

rio device tools ssh [OPTIONS] DEVICE_NAME

Options

-u, --user <user>

Username for the SSH

-L, --local-port <local_port>

Port number on the local machine for forwarding SSH

-R, --remote-port <remote_port>

Port number on the Device on which SSH Server is listening

-X, --x-forward, --no-x-forward

Flag to enable X Forwarding over SSH

Arguments

DEVICE_NAME

Required argument

ssh-authorize

Authorize Public SSH Key

rio device tools ssh-authorize [OPTIONS] DEVICE_NAME [PUBLIC_KEY_FILE]

Options

-u, --user <user>

User for which SSH keys are added

Arguments

DEVICE_NAME

Required argument

PUBLIC_KEY_FILE

Optional argument

topics

ROS Topics on the Device

rio device topics [OPTIONS] COMMAND [ARGS]...

list

Lists all the available topics for the Device

rio device topics list [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

subscribe

Subscribes the topics to start collecting it

rio device topics subscribe [OPTIONS] DEVICE_NAME TOPIC {metric|log}

Arguments

DEVICE_NAME

Required argument

TOPIC

Required argument

KIND

Required argument

unsubscribe

Un-subscribes the topics to stop collecting it

rio device topics unsubscribe [OPTIONS] DEVICE_NAME TOPIC {metric|log}

Arguments

DEVICE_NAME

Required argument

TOPIC

Required argument

KIND

Required argument

uploads

Uploaded files from the Device

rio device uploads [OPTIONS] COMMAND [ARGS]...

cancel

rio device uploads cancel [OPTIONS] DEVICE_NAME FILE_NAME

Arguments

DEVICE_NAME

Required argument

FILE_NAME

Required argument

create

rio device uploads create [OPTIONS] DEVICE_NAME UPLOAD_NAME FILE_PATH

Options

--max-upload-rate <max_upload_rate>

Network bandwidth limit to be used for upload (Bytes per second)

--override

Flag to override destination file

--purge

Flag to enable purging the file, after it is uploaded

Arguments

DEVICE_NAME

Required argument

UPLOAD_NAME

Required argument

FILE_PATH

Required argument

delete

rio device uploads delete [OPTIONS] DEVICE_NAME FILE_NAME

Arguments

DEVICE_NAME

Required argument

FILE_NAME

Required argument

download

rio device uploads download [OPTIONS] DEVICE_NAME FILE_NAME

Arguments

DEVICE_NAME

Required argument

FILE_NAME

Required argument

list

rio device uploads list [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME

Required argument

share

rio device uploads share [OPTIONS] DEVICE_NAME FILE_NAME

Options

--expiry <expiry>

Flag to set the expiry date for the Shared URL [default: 7 days]

Arguments

DEVICE_NAME

Required argument

FILE_NAME

Required argument

status

rio device uploads status [OPTIONS] DEVICE_NAME FILE_NAME

Arguments

DEVICE_NAME

Required argument

FILE_NAME

Required argument

vpn

Enable or disable VPN client on the device

Examples:

1. Enable VPN on specific devices

   rio device vpn true –devices=amr01 –devices=edge01

2. Enable VPN on all devices in the project

   rio device vpn true

3. Disable VPN

   rio device vpn false

4. Skip confirmation

   rio device vpn false –silent true

rio device vpn [OPTIONS] ENABLE

Options

--devices <devices>

Device names to toggle VPN client

-f, --force, --silent

Skip confirmation

--advertise-routes

Advertise subnets configured in project to VPN peers

Arguments

ENABLE

Required argument