Skip to main content

Properties

Properties are key-value pairs that can be attached to a device. They can be used to store arbitrary, free-form JSON data related to a device. Properties can be protected. Protected properties can only be read but not modified by the device. Properties can be used for everything from storing device configurations, to device state, and inventory information.

Reading and writing properties through Nexigon Agent:

nexigon-agent device properties set <property key> <property value>
nexigon-agent device properties get <property key>

Reading and writing properties through Nexigon CLI:

nexigon-cli devices properties set <device id> <property key> <property value>
nexigon-cli devices properties get <device id> <property key>

The property key is a a string and the property value is a JSON string.

To avoid conflicts with existing properties, we recommend using a domain prefix. For instance, we use dev.nexigon for properties whose structure is defined by Nexigon itself (e.g., system information under dev.nexigon.systemInfo).

Protected Properties​

Protected properties can only be read but not modified by the device. This is useful for storing device configurations and inventory information that must not be modified by the device itself (e.g., its serial number).