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

Table of Contents (Start)

Metadata Quick Start Guide

SevOne Documentation

All documentation is available from the IBM SevOne Support customer portal.

© Copyright International Business Machines Corporation 2024.

All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of IBM and its respective licensors. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of IBM.

IN NO EVENT SHALL IBM, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IBM DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

IBM, the IBM logo, and SevOne are trademarks or registered trademarks of International Business Machines Corporation, in the United States and/or other countries. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on ibm.com/trademark.

About

Metadata is data that provides information about other data, but not the content of the data, such as the text of a message or the image itself. With Microsoft Word, metadata makes it easy to find details about the author's user name, when a file was created and last modified, the file size, the total editing time, etc. For MP3 files, metadata allows you to view and edit information about tracks, such as the song title, artist's name, album title, release year, and track number. Social media also uses metadata.

SevOne NMS also uses metadata for device names, names of peers polling devices, number of objects, and object names. SevOne NMS allows you to create custom metadata attributes for your devices, objects, device groups, device types, and object groups.

This document discusses the following topics.

  • Create namespaces and metadata attributes

  • Populate metadata attributes

  • Create a report on metadata attributes

SevOne Metadata

SevOne's Metadata features give you flexibility to specify exactly what information you would like to include. You can say just about anything you want about a given device, object, device group, device type, or object group. You can use metadata attributes to provide site locations, software version information, IP addresses, MAC addresses, local contact information, and serial numbers, along with other details. You can even create a metadata attribute to describe the color of your devices!

The following are just a few examples of information you can include for all your company's routers, switches, servers, etc., using metadata.

  • Location

  • Contact person

  • Contact phone

  • Clickable link to service records

  • IP address

  • MAC address

  • Serial number

  • Installation date

  • Software version

Another great benefit of SevOne Metadata is instant access to important information. If you notice a problem with a router, you can instantly view all the essential information for it. If the router is at a remote location, and you need a reset, you immediately know where the router is located. You also know who to call and how to reach them. The information is readily available and there is no need to open a separate application for this.

Configuration

Please refer to SevOne NMS System Administration Guide > section Metadata Schema for details on how to create metadata namespace(s) and attributes.

After creating attributes for metadata namespace(s), the attributes need to be populated with meaningful data so that a report can be created based on the metadata attributes.

Populate Metadata Attributes

This section describes how to populate the metadata attributes created with meaningful data.

  1. From the navigation bar, click Devices and select Device Manager.
    images/download/attachments/174603849/metadataDevMgr-version-1-modificationdate-1707109637816-api-v2.png

  2. Select one or more devices and click images/download/attachments/17469967/image2015-5-28-16_59_1-version-1-modificationdate-1432846741751-api-v2.png to display the Edit Metadata pop-up for it.
    images/download/attachments/174603849/metadataDevice-version-1-modificationdate-1707109637871-api-v2.png

    You can edit metadata values for multiple devices at the same time. First, select the check boxes for the devices. In the upper left corner of the table, click images/download/attachments/174603849/image2016-1-15-16_1_51-version-1-modificationdate-1707109638276-api-v2.png and select Tools, then Edit Metadata. The Edit Metadata pop-up appears, enabling you to edit metadata values for all of the selected devices.

  3. Under the namespace, locate the attribute name you created. For example, in section Metadata Schema (in SevOne NMS System Administration Guide), the example shows that namespace, ns, has an attribute Site Location.

  4. Click images/download/attachments/17469967/image2015-5-28-17_8_39-version-1-modificationdate-1432847319490-api-v2.png to edit the values for Site Location.
    images/download/attachments/174603849/metadataSiteLocation-version-1-modificationdate-1707109637896-api-v2.png

  5. In the Latitude field, you must enter a decimal value between -90.00 and 90.00. For our example, 32.7833.

  6. In the Longitude field, you must enter a decimal value between -180.00 and 180.00. For example, 79.9333.

  7. Click Update to apply the changes.

  8. Locate the Site Contact Phone attribute and click images/download/attachments/17469967/image2015-5-28-17_8_39-version-1-modificationdate-1432847319490-api-v2.png to edit the value for it. For example, 843-555-5309.
    images/download/attachments/174603849/metadataSiteContactPhone-version-1-modificationdate-1707109637887-api-v2.png

  9. Click Update.

  10. Locate the Service Record attribute and click images/download/attachments/17469967/image2015-5-28-17_8_39-version-1-modificationdate-1432847319490-api-v2.png to edit the values for it.
    images/download/attachments/174603849/metadataServiceRecord-version-1-modificationdate-1707109637884-api-v2.png

  11. In the Link display text field, enter a name for the link. For example, Service Record for localhost.

  12. In the URL field, enter a URL for the link. You can enter any working URL for the example.

  13. Click Update.

  14. Before continuing, click the link for the URL (for example, Service Record for localhost) to confirm that the URL is correct.

  15. Click Save.
    images/download/attachments/174603849/metadataDeviceConfigured-version-1-modificationdate-1707109637868-api-v2.png

Create a Report on Metadata Attributes

Create a report for example, TopN, for the device populated in the section above. The report results will show the Most utilized Interfaces along with metadata information for the device.

  1. From the navigation bar, click Reports and select Create Report.
    images/download/attachments/18554317/reportAttachmentWizard-version-1-modificationdate-1448918618453-api-v2.png

  2. The Sources page is set to TopN by default. That's what we want. Click Next.

  3. On the Resources page, click the Type drop-down and select Device.
    images/download/attachments/174603849/metadataTopNResources-version-1-modificationdate-1707109637865-api-v2.png

  4. Click the Device drop-down and select the device that you edited metadata values for in the previous section. For example, localhost.

  5. On the left side of the page, click Visualizations to jump ahead to the Visualizations page.
    images/download/attachments/174603849/metadataTopNViz-version-1-modificationdate-1707109637863-api-v2.png

  6. The Table visualization should be selected by default. Click images/download/attachments/18554317/icon_downwardArrow-version-1-modificationdate-1448918617506-api-v2.png to view the Table settings.
    images/download/attachments/174603849/metadataTopNVizTable-1-version-1-modificationdate-1707109637850-api-v2.png

  7. To the right of Columns, you will see two lists of columns - Available and Using. Under Available, scroll down until you see the namespace you created earlier. For example, namespace ns. Below the namespace, you will see the namespace's attributes available as columns.

  8. Select all of the rows under your namespace: Service Record, Site Contact Phone, and Site Location.
    images/download/attachments/174603849/metadataTopNVizTable-2-version-1-modificationdate-1707109637847-api-v2.png

  9. Click images/download/attachments/17469967/image2015-5-28-17_59_0-version-1-modificationdate-1432850341042-api-v2.png to add the rows to Using.

  10. Click Finish.

  11. Your TopN report results will include the Site Contact Phone and Site Location coordinates for the device along with a link to the device's Service Record.
    images/download/attachments/174603849/metadataTopNReport-version-1-modificationdate-1707109637822-api-v2.png

Terms

Attribute

In the context of SevOne NMS metadata, a piece of information that specifies the expected input for a field.

Metadata

Data that describes other data.

Namespace

  • In the context of SevOne NMS metadata, a grouping or collection of metadata attributes.

  • In the context of SevOne NMS metadata, an area or category where a specific attribute can be used.