Skip to content

Parameters

This configuration requires qbee-agent version >= 2023.41

This configuration allows definition of shared parameters and secrets which can be used in other configurations. Parameters defined on a certain level can be used by other configurations on the same level and all children levels.

qbee parameters configuration

Parameters and secrets can be used in other configurations by use of $(parameter) placeholders.

For example: In file distribution we can use it to select a source file or populate its template parameters with shared parameter value.

Using parameters in the file distribution template

Secrets

Secrets work just like parameters with the exception that they cannot be retrieved once saved and will be redacted from the logs created by the device. Only a device will receive values for secrets when requesting its configuration. From the API and UI perspective, only the internal reference of the secret will be returned.

For example: Setting a secret value to "abc123" (once saved), will return the secret's reference instead of its value.

qbee secrets are not shown in the configuration

The reference is just a random value used to identify the secret in qbee internal secret storage and cannot be used to guess the value of the secret.

Secrets are immutable, therefore setting a new value for a secret, will override the existing reference with a new reference value. Saving a secret reference, will keep the underlying secret value unchanged.

Extending parameters configuration

Parameters defined on a parent level can be overridden.

For example: Let's say that we have defined the following parameters on the "All devices" level:

  • brand="My Brand"
  • db-user="dbUser"

And decided that we need to change the branding only for devices under group_A. We would achieve that by setting only "brand" parameter to a new value - "Custom Brand". The result would be, that devices under group_A would now get the following parameters:

  • brand="Custom Brand"
  • db-user="dbUser"