SevOne logo
You must be logged into the NMS to search.

Table of Contents (Start)

Metadata Schema

The Metadata Schema page enables you to manage metadata attributes that are specific to your network. SevOne NMS metadata attributes display in italic font. You cannot edit or delete SevOne NMS metadata attributes.

To access the Metadata Schema page from the navigation bar, click the Administration menu and select Metadata Schema.

images/download/attachments/163973091/metadataschema-version-1-modificationdate-1693243121593-api-v2.png

Metadata List Filters

Filters enable you to limit the metadata that appear in the list. All filters are optional and cumulative.

  1. Select a namespace from the left-navigation bar.

  2. Click Apply Filter to display the Filter Options pop-up.

  3. Click the Target drop-down and select a target.

  4. Click the Type drop-down and select a type.

  5. Click Apply.

Add / Edit Namespaces

Namespace(s) must be created before you can define the attributes.

Add Namespace

  1. Click Add Namespace in the left-navigation bar to add a namespace.
    images/download/attachments/163973091/addMetadataNamespace-version-1-modificationdate-1693243121605-api-v2.png

  2. In Add Namespace pop-up, enter a name for the namespace in field Name.

  3. Click Save.

Edit Namespace

  1. To edit the namespace, click images/download/attachments/163973091/editnew-version-1-modificationdate-1693243121596-api-v2.png next to the namespace you want to edit.
    images/download/attachments/163973091/editMetadataNamespace-version-1-modificationdate-1693243121607-api-v2.png

  2. Edit Namespace pop-up appears.

  3. In the Edit Namespace pop-up, enter the namespace name you want to change it to in field Name.

  4. Click Save.

Add / Edit Attributes

Each metadata attribute is grouped by namespace and can have multiple targets. The attribute target provides the ability to edit the value for each attribute. The attribute type determines what data the attribute presents.

Add Attributes

  1. Select a namespace in the left-navigation bar to which you want to add the attributes.

  2. Click Add Attribute. It displays the Add Metadata Attribute pop-up.
    images/download/attachments/163973091/addMetadataAttributesToNamespace-version-1-modificationdate-1693243121609-api-v2.png

  3. Target - refers to the areas in SevOne NMS that you can apply a specific metadata attribute to. . Each metadata attribute can have multiple targets. Click the Target drop-down.

    Example

    Assume that your company has several offices throughout the United States. One of your offices is in San Diego, and you want to provide a site contact phone number for all of the devices at the San Diego location. In this case, you will select Device as a target. This gives you the ability to use your site contact phone number attribute for individual devices.

    Besides Device, you can also select Object, Device Group, Object Group, Object Type, and Indicator Type as targets.

    1. Select Device to enable the association of values from the Device Manager for specific devices.

    2. Select Object to enable the association of values from the Object Manager for specific objects.

    3. Select Device Group to enable the association of values from the Device Groups page for specific device groups and from the Device Types page for specific device types.

    4. Select Object Group to enable the association of values from the Object Groups page for specific object groups.

    5. Select Object Type to enable the association of values from the Object Types for specific object types.

    6. Select Indicator Type to enable the association of values for specific indicator types.

      The following sections can be found in SevOne NMS System Administration Guide.

      • Device Types

      • Object Groups

      • Object Types

      The following sections can be found in SevOne NMS User Guide.

      • Device Groups

      • Device Manager

      • Object Manager

  4. Type - is the kind of data the attribute presents. Click the Type drop-down.

    Type is used to validate entry inputs. It specifies the format of the data that users will provide for a specific attribute. If you would like to include the installation date for a device, for example, you may create a metadata attribute and call it Installation Date. Because you want it to be in date format, you would select the attribute type Date/Time. This means that data provided for the Installation Date attribute must conform to the Date/Time format.

    Additional attribute types include IP Address, MAC Address, Integer, Latitude and Longitude, Regular Expression, and URL. There is also an attribute type called Text, which you can use for any number of things, such as phone numbers, names of people, serial numbers, notes, etc.

    1. Select Date/Time to enable the value to be in a date/time format.

    2. Select Integer to enable the value to be numeric.

    3. Select IP Address to enable the value to be an IP address.

    4. Select Latitude and Longitude to enable the value to be a latitude and longitude.

    5. Select MAC Address to enable the value to be a MAC address.

    6. Select Text (Validated) to enable the entry of a regular expression that is validated for accuracy. A Regular Expression field appears to enable you to enter the regular expression on which to validate the attribute values.

      The input for the Regular Expression field needs to be a full regular expression with delimiters and modifiers.

    7. Select Text to enable the value to be text.

    8. Select URL to present the value as a clickable link to a valid URL.

  5. Name - is the name of the metadata attribute.

    For example, if you have an attribute for providing the location of a device, you may name it Site Location.

    Create the following attributes,

    For NetflowDeviceIP,

    • field Target, select Device from the drop-down.

    • field Type, select IP Address from the drop-down.

    • field Name, enter NetflowDeviceIp as the attribute name. Only name NetflowDeviceIp must be used here.


    For NetflowInterfaceIndex,

    • field Target, select Object from the drop-down.

    • field Type, select Integer from the drop-down.

    • field Name, enter NetflowInterfaceIndex as the attribute name. Only name NetflowInterfaceIndex must be used here.


    For NetflowInterfaceName,

    • field Target, select Object from the drop-down.

    • field Type, select Text from the drop-down.

    • field Name, enter NetflowInterfaceName as the attribute name. Only name NetflowInterfaceName must be used here.

    As of SevOne NMS 6.6.0, flow devices and interfaces can now be automatically associated with the SNMP-managed device / object / indicator that uses enterprise-specific MIB and custom IP. Manual associations are no longer required if Allow Mapping field is enabled.

    for automatic Device Mapping,

    After a metadata namespace is created, a device metadata attribute, NetflowDeviceIp, is applied to devices and will be used for determining the IP address of a SevOne NMS device when establishing the device mapping. When a device has this metadata attribute set, the default IP address of the device is overridden by the value of the metadata attribute. When adding a metadata attribute for this, please make sure that field Name is set to NetflowDeviceIp for this metadata namespace.

    • field Target, select Device from the drop-down.

    • field Type, select IP Address from the drop-down.

    • field Name, enter NetflowDeviceIp as the attribute name. Only name NetflowDeviceIp must be used here.


    for automatic Object Mapping,

    After a metadata namespace is created, a object metadata attribute, NetflowInterfaceIndex, is applied to objects and will be used for determining the Interface Name of a SevOne NMS object when establishing the object mapping. When an object has this metadata attribute set, the default Interface integer number of the object is overridden by the object name. When adding a metadata attribute for this, please make sure that field Name is set to NetflowInterfaceIndex for this metadata namespace.

    • field Target, select Object from the drop-down.

    • field Type, select Integer from the drop-down.

    • field Name, enter NetflowInterfaceIndex as the attribute name. Only name NetflowInterfaceIndex must be used here.

  6. Click Save.
    images/download/attachments/163973091/metadataAttributeAdded-1-version-1-modificationdate-1693243121611-api-v2.png

Edit Attributes

  1. Select a namespace in the left-navigation bar for which you want to edit the attributes.

  2. Click images/download/attachments/163973091/editnew-version-1-modificationdate-1693243121596-api-v2.png under Actions column for the Metadata Attribute you want to edit. It displays Edit Metadata Attribute pop-up.
    images/download/attachments/163973091/editMetadataAttributesToNamespace-version-1-modificationdate-1693243121614-api-v2.png

    Please refer to Metadata Attributes for details on the fields you want to edit.

  3. Click Save after you have modified the metadata attribute(s).


  • To add additional attributes to a namespace, please refer to section Add Attributes.

    Additional attributes Site Location, Site Contact Phone, and Service Record added to namespace 'ns'

    images/download/attachments/163973091/metadataAttributeAdded-2-version-1-modificationdate-1693243121616-api-v2.png

  • To edit existing attributes in a namespace, please refer to section Edit Attributes.

Created with Scroll Wiki HTML Exporter for Confluence.