Parameter

rio parameter

Configuration parameters for your devices and deployments.

The configuration parameters are file based configs that are stored in a directory-like structure. You can upload, download, and apply these configurations to your devices and deployments.

The platform ensures the availability of the configurations at predefined paths on the devices and deployments as well as the deployments in the cloud.

rio parameter [OPTIONS] COMMAND [ARGS]...

apply

Apply a set of configuration parameter trees to a list of devices.

You can either specify the device names using the --devices flag or use the --device-name-pattern flag to apply configurations to devices.

Note that the --devices flag will be ignored if the --device-name-pattern flag is provided.

You can specify the trees to apply using the --tree-names flag.

Skip the confirmation prompt by using the --force or --silent or the -f flag.

Usage Examples:

Apply configurations to a list of devices

$ rio parameter apply –devices device1 –devices device2 –tree-names tree1

Apply configurations to devices using a regex pattern

$ rio parameter apply –device-name-pattern ‘amr.*’ –tree-names params

rio parameter apply [OPTIONS]

Options

--devices <devices>

Device names to apply configurations. If –device_name_pattern isprovided, this will be ignored.

--device-name-pattern <device_name_pattern>

Device name regex pattern to apply configurations. Does not work with –devices.

--tree-names <tree_names>

Tree names to apply to the device(s)

--retry-limit <retry_limit>

Retry limit

-f, --force, --silent

Skip confirmation

delete

Delete a configuration parameter tree.

You can skip the confirmation prompt by using the --force or --silent or -f flag.

rio parameter delete [OPTIONS] TREE

Options

-f, --force, --silent

Skip confirmation

Arguments

TREE

Required argument

diff

Diff between the local and cloud configuration trees.

You can specify the tree names to diff using the --tree-names flag.

rio parameter diff [OPTIONS] [PATH]

Options

--tree-names <tree_names>

Tree names to fetch

Arguments

PATH

Optional argument

download

Download configuration parameter trees from rapyuta.io.

You can specify the tree names to download using the --tree-names flag.

If you do not specify any tree names, all the trees will be downloaded.

You can also specify the --overwrite or --delete-existing flag to overwrite the existing parameter tree on the local machine.

rio parameter download [OPTIONS] [PATH]

Options

--tree-names <tree_names>

Tree names to fetch

--overwrite, --delete-existing

Overwrite existing parameter tree

Arguments

PATH

Optional argument

list

List the configuration parameter trees in current project.

rio parameter list [OPTIONS]

upload

Upload directories as configuration parameter trees.

You can upload one or more directories as configuration parameter trees on rapyuta.io. If you do not wish to upload all the directories as a tree you can specify the directory names using the --tree-names flag. Directories that match the tree names will be parsed and uploaded.

You can also specify the --recreate or --delete-existing flag to overwrite the existing parameter tree on rapyuta.io.

You can skip the confirmation prompt by using the --force or --silent or the -f flag.

Usage Examples:

Upload all directories as configuration parameter trees

$ rio parameter upload .

Upload only the directories “config” and “secrets”

$ rio parameter upload . –tree-names config –tree-names secrets

Recreate the existing parameter tree

$ rio parameter upload . –recreate

rio parameter upload [OPTIONS] PATH

Options

--tree-names <tree_names>

Directory names to upload

--recreate, --delete-existing

Overwrite existing parameter tree

-f, --force, --silent

Skip confirmation

Arguments

PATH

Required argument