Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To use this functionality, you create a custom script on the device that retrieves the desired data and sets the value of the relevant device attribute accordingly.

...

Note

Note that you must use the UMS internal name of an attribute, not the display name. The UMS internal identifier is displayed in the UMS Console under UMS Administration > Global Configuration > Device Attributes; see also Managing Device Attributes for IGEL OS Devices

Also, note that permission to change attribute values must be granted by the UMS. This is the case if the Overwrite Rule is set to Devices or All in the UMS Console under UMS Administration > Global Configuration > Device Attributes; see also Managing Device Attributes for IGEL OS Devices.

Info

The character limit for device attributes is 100 characters. Longer entries will not be synchronized with the UMS.

Environment

For OS 11 Devices

  • IGEL UMS 6.10 or higher

  • Devices with IGEL OS 11.07.100 or higher

For OS 12 Devices

  • IGEL UMS 12.03.100 or higher

  • Devices with IGEL OS 12.3.0 or higher

Command Reference

List All Device Attributes

Code Block
/sbin/rmagent-devattrs-enum

Lists all device attributes including the current value for this device. The enumeration is ordered according to the attribute's order id. 

Example:Image Removed

...

Device Attribute of the Type "List": List All Possible Values

Code Block
/sbin/rmagent-devattrs-enum-range <ATTRIBUTE_NAME>

Enumerates entries of the given range. The enumeration is ordered according to the range item's order id. 

Example:Image Removed

...

Print Attribute Type

Code Block
/sbin/rmagent-devattrs-get-type <ATTRIBUTE_NAME>

Prints the type of the given attribute. Possible types are:

  • string

  • number

  • date (format: yyyy-mm-dd)

  • range

Example:Image Removed

...

Print Attribute Value

Code Block
/sbin/rmagent-devattrs-get <ATTRIBUTE_NAME>

Prints the current value of the given attribute.

Example:Image Removed

...

Set Attribute Value

Code Block
/sbin/rmagent-devattrs-set <ATTRIBUTE_NAME> <ATTRIBUTE_VALUE>

Sets the given attribute to the specified value. If the overwrite rule for this attribute does not permit the device to change the value, an error is returned. Note that this command does not check the value type.

Example:Image Removed

...

Reset Attribute Value

Code Block
/sbin/rmagent-devattrs-reset <ATTRIBUTE_NAME>

Resets the given attribute to an empty value.

Example:Image Removed

...

Send Attributes to UMS If a Value Has Been Changed by Device

Code Block
/sbin/rmagent-devattrs-sync

If any of the attribute values have been changed by the device, the complete set of attributes is sent to the UMS. 

Send Attributes to UMS

Code Block
/sbin/rmagent-write-device-attributes

...