Skip to main content
Version: Next

The tedge config command

tedge config
Configure Thin Edge

Usage: tedge config [OPTIONS] <COMMAND>

Commands:
get Get the value of the provided configuration key
set Set or update the provided configuration key with the given value
unset Unset the provided configuration key
add Append or set the provided configuration key with the given value
remove Remove value from the provided configuration key
list Print the configuration keys and their values
help Print this message or the help of the given subcommand(s)

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

Get​

tedge config get
Get the value of the provided configuration key

Usage: tedge config get [OPTIONS] <KEY>

Arguments:
<KEY>
Configuration key. Run `tedge config list --doc` for available keys

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--profile <PROFILE>
The cloud profile you wish to use, if accessing a cloud configuration (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles, or want to access the default profile, don't supply this.

[env: TEDGE_CLOUD_PROFILE]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

Set​

tedge config set
Set or update the provided configuration key with the given value

Usage: tedge config set [OPTIONS] <KEY> <VALUE>

Arguments:
<KEY>
Configuration key. Run `tedge config list --doc` for available keys

<VALUE>
Configuration value

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--profile <PROFILE>
The cloud profile you wish to use, if accessing a cloud configuration (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles, or want to access the default profile, don't supply this.

[env: TEDGE_CLOUD_PROFILE]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

List​

tedge config list
Print the configuration keys and their values

Usage: tedge config list [OPTIONS] [FILTER]

Arguments:
[FILTER]
Prints only the keys that contain the provided filter string

Options:
--all
Prints all the configuration keys, even those without a configured value

--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--doc
Prints all keys and descriptions with example values

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

Unset​

tedge config unset
Unset the provided configuration key

Usage: tedge config unset [OPTIONS] <KEY>

Arguments:
<KEY>
Configuration key. Run `tedge config list --doc` for available keys

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--profile <PROFILE>
The cloud profile you wish to use, if accessing a cloud configuration (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles, or want to access the default profile, don't supply this.

[env: TEDGE_CLOUD_PROFILE]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

Add​

tedge config add
Append or set the provided configuration key with the given value

Usage: tedge config add [OPTIONS] <KEY> <VALUE>

Arguments:
<KEY>
Configuration key. Run `tedge config list --doc` for available keys

<VALUE>
Configuration value

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--profile <PROFILE>
The cloud profile you wish to use, if accessing a cloud configuration (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles, or want to access the default profile, don't supply this.

[env: TEDGE_CLOUD_PROFILE]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

Remove​

tedge config remove
Remove value from the provided configuration key

Usage: tedge config remove [OPTIONS] <KEY> <VALUE>

Arguments:
<KEY>
Configuration key. Run `tedge config list --doc` for available keys

<VALUE>
Configuration value

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--profile <PROFILE>
The cloud profile you wish to use, if accessing a cloud configuration (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles, or want to access the default profile, don't supply this.

[env: TEDGE_CLOUD_PROFILE]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace. Logs with verbosity lower or equal to the selected level will be printed, i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')