Devices

Device Properties

Introduction to Device Properties

Note: Properties can also be set for instances, often referred to as instance level properties (ILPs). For more information on instance properties, see Instance Properties.

In addition to using properties to define authentication credentials, you can use properties to define a custom port, associate a location with your infrastructure, set a custom polling interval, or just to associate information with one or more devices. You can set properties at the instance level, device level, device group level, and at the root group (account) level.

You can view a device's properties from its Info Tab.

Note: Any values assigned to properties with names ending in .pass, .auth, .key, or password will be obfuscated throughout the LogicMonitor interface for security purposes. Values assigned to the snmp.community, snmp.privtoken, and snmp.authtoken properties, as well as the aws.accesskey property, will also be obfuscated.

All system.xxx properties are originally set by LogicMonitor based on how you've configured your device (preferred collector, device groups, name, etc.). As a general rule, you cannot directly edit the values of system.xxxx properties. However, there are two exceptions to this rule as noted next:

  • You can use the device's management interface to manually customize the system.categories property. For example, you could customize the system.categories property to indicate that a collector is installed on the device.
  • You can use the !hostproperty debug command (available from the Collector Debug Facility) to add, update, or delete any system property for a device.

Understanding Property Hierarchies

Before you set properties for your devices, you should understand where to set them, which depends on how many devices that property applies to. For example, if you have the same SNMP community string set for all of your Linux devices, it doesn't make sense to go and set that as a property individually for each Linux device in your account. It may be better to instead set this community string at the account level so that it applies to all Linux devices (and instances).

Properties set at the device level will override properties set at the group level, and properties set at the group level override properties set at the global (account) level. As a best practice, we recommend that you set global credentials and override them as needed for groups of devices or individual devices.

Understanding property hierarchies

Note: A device that is a member of multiple groups with the same property defined uses the properties set at the deepest level group. If the same property is set in two groups at the same level, and a device is a member of both these groups, the selection of which property that the device will take effect is nondeterministic. 

Adding a Property

The following set of steps illustrate how to manually add a property to a device, a device group, or the device tree root.

Note: LogicMonitor supports the auto-assignment of properties at the device level. For more information on the benefits and methods of automating property assignment, see Creating PropertySources.

  1. Navigate to the Devices tab
  2. Navigate to the level that you want to set the property - the root level for your device tree, a group, or a device
  3. Click the Manage button for that group or device
  4. From the Manage dialog you can change the value for a property by clicking on the value field or add a new property by clicking the '+':

    Adding a property

  5. Click Save for the property, and then save for the manage dialog. Remember that the value you set is inherited downward in the hierarchy until it is overridden at a deeper level. For example, applying location at the global level will attempt to use that location for all devices except those with the location propertydefined at the group or device level.

Common Properties

Property Name

Meaning

Notes

location The physical location of your device, used by the map dashboard widget. For more information about the map widget, see Google Map Widget.
system.categories Arbitrary string to match hasCategory() parameters LogicMonitor assigns this property to devices automatically based on how the device sysOID matches up to LogicMonitor's sysOID maps, or can be set manually. For example, to tell LogicMonitor your device is a collector you can add 'Collector' to the system.categories property and LogicMonitor's Collector DataSources will automatically apply to the device. .


Other Common Purposes for Properties

  • Dynamically group devices. Define properties for your devices such that you can dynamically group the devices based on the properties. For example, you may add the following property to all production devices: 'production= true'. You can then create a dynamic group that includes all devices that have the property 'production = true'. If you add the property to new production devices they will be automatically added to the dynamic group. This can be useful if you're referencing the dynamic group in dashboards, reports, alert rules, or other areas of your account.
  • Apply DataSources. Define properties for your devices such that you can apply DataSources based on these properties. This can be useful if you'd like to apply a DataSource to a subset of devices. For example, you may clone a DataSource and customize it for a subset of devices using a custom port. If you add a property to that subset of devices along the lines of 'MySqlPort= 3307', you can apply the customized DataSource to all devices with that property.