Manage Orion site custom properties in EOC
By default, every object monitored by Orion includes a list of properties used to describe entities, for example a device's IP address or host name. In addition to the default properties, you can also add custom properties based on user-defined fields, for example country, device serial number, or tags. These custom properties are useful to include in alerts, reports, views, and groups. as they can provide additional information not supplied by the default properties.
With EOC 2020.2, EOC is no longer a just web-server rolling up data from remote sites. You can now create and manage custom properties for Orion sites from a centralized location. For more information on custom properties, see Custom properties in the Orion Platform.
Access the Custom Properties Management page
- Log in to EOC as an administrator.
- Go to Settings > Node & Group Management > Manage Custom Properties.
The Custom Properties Manger allows you to add, delete, edit, assign values, and more, providing distributed custom property management from a centralized location. Open the manager to filter, browse, and configure properties for a specific remote site.
Filter and sort custom properties
From the left-pane of the Custom Properties Management page, select various filters to narrow down and find on what remote site a specific property lives. Filtering allows you to create, manipulate, and edit a property that may exist across multiple remote sites.
You can filter based on:
- The format of the property, for example, a date/time format.
- If the property is mandatory on the remote site.
- The connected remote site(s) on which a property lives.
- The source of the property, either local or global.
- The usage of the property on a remote site, for example: alerting, grouping, or reporting.
If you have a large number of remote sites managed by EOC, filtering makes navigating sites and their associated properties easier.
Global and local custom properties
You can filter custom properties by either a Local site entity or a Global entity.
- Global property: a property that is created by an EOC instance, and not by a remote Orion site. Multiple Global entities may exist under the source filter list. This indicates that different EOC instances were used to create the property.
- Local property: a property that is directly created on and stored by a remote Orion site. Under the source filter list, Local entities are displayed using the IP address, rather than "Global".
It is important to note that Global properties are not created or stored in EOC. When a property is created from the Custom Properties Manager in EOC, they are pushed from EOC and stored the remote sites selected during configuration. EOC only tracks and reads the source of a custom property, whether that is Global or Local.
Create custom properties on a remote Orion site
- On the Custom Properties Management page, click Add.
- On the Add custom property page, the left-side panel includes a drop-down of available entity types to create a custom property for. Alternatively, you can choose from a list of pre-configured templates to create properties.
- Configure the property details: property name, format, if the property must have a value and if a drop-down of values is available, usage, and the site(s) the property is used on.
Unique to EOC is the capability to specify one or more sites that a custom property is to be created and stored on.
The EOC Custom Property Manager requires that newly created properties are unique. If a custom property with the same name, attributes, and usage already exists on a remote Orion site, an error message is received which identifies the property and the sites that already include the property.
Assign values to custom properties
After a property has been configured, you can then proceed to assigning values. On the Custom Properties Management page, select the property to edit and click Assign.
From the property table, locate the column containing the name of the new property. Under this column, you can add values for each site that should be associated with the property.
Add value parameters to filters and columns
When assigning values you can add more filters and columns to assist you narrowing down the sites or conditions for which a value should be assigned.
- From the filter panel, click the menu icon and click Add filter.
- In the Add filter window, select or for the parameter to apply and click Add filter.
- New parameters are added to the panel to select and filter by. Additionally, they are added to the property table as new columns.
Modify and delete a custom property
From the Custom Properties Management page, you can modify or delete properties. This is done by selecting the property to delete from the property table, and clicking Edit or Delete, as appropriate. You can also search for a property using the quick-search bar on top-right of the table.
When you choose to Edit a property, the Edit custom properties page allows you to edit certain elements, such as the list of values or description. You cannot change the property name, format, or remove previously defined usages. However, you can add new usage options.
Deleting a custom property
There are scenarios in which you cannot delete a custom property. For example, if a custom property is in use by a more advanced process, such as view limitations on a remote site, the property cannot be deleted until that process no longer references the custom property.
Alternatively, if you attempt to delete a property that is in use by a minor process, such as an alert on a remote Orion site, EOC warns you that the property is in use, but only requires additional confirmation for deletion. If you delete a property that is used by other elements on a remote site, SolarWinds recommends that you update the element definitions.