Siddharth Sonaria

How to clone a topology plugin?

Overview

Under the Actions Tab, Select to display permissible actions for each topology plugin. After that, Select Clone Topology Plugin to start creating a duplicate of the topology plugin.

The screen to create a new topology plugin appears with the same parameters as the plugin you selected to clone.

Enter all the details as per your requirement. Refer Creating a Topology Plugin to find more details about the fields present in the screen.

Select the Test button to validate the credential profile against the monitor.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Siddharth Sonaria

How to Assign Topology Plugin to a Monitor?

Overview

In order to override the default plugin and use the custom plugin for Topology creation, you need to assign the plugin to the monitor.

Under the Actions Tab, Select to display permissible actions for each Topology plugin. After that, Select Assign Monitor to display the list of monitors to which the topology plugin can be assigned. The monitors using the same communication protocol as the plugin are displayed for assignment.

Steps to Assign a Topology Plugin

Steps to Assign Plugin to the Monitor

Select the monitors to which you need to assign the topology plugin using the check-box against it. You can select multiple monitors in case you need to assign the plugin to more than one monitor at once.

Select Assign Monitor to assign the plugin to the selected monitor(s).

Select Cancel if you do not wish to assign the plugin to the monitor(s).

How to Unassign Topology Plugin from a Monitor?

Overview

In case you don’t want to create Topology using a specific custom plugin anymore, you can unassign the plugin from the monitor.

Under the Actions Tab, Select to display permissible actions for each topology plugin. After that, Select Remove Assigned Monitor to display the list of monitors which are using the plugin.

Steps to Unassign the plugin

Select the monitors from which the selected plugin needs to be removed by using the check-box against it. You can select multiple monitors in case you need to remove the plugin from multiple monitors at once.

Select Unassign Monitor to remove the plugin from the selected monitor(s).

Select Cancel if you do not wish to remove the plugin from the monitor(s).

Siddharth Sonaria

How to Create a Topology Plugin?

Overview

A Network Topology is created with the help of routing protocols such as CDP, OSPF, etc. These routing protocols are embedded in the Topology plugins. When you execute a Topology run, AIOps creates a Topology map with the help of these plugins.

There might be a situation where a device in your network might not show up in the Topology map. This would generally mean that the device belongs to a vendor not recognized by any in-built Topology plugins. For such cases, you can create a topology plugin to identify devices.

Once you create a new topology plugin for the device, assign it to a monitor, and run the Topology scheduler, the Topology plugin will now be able to read the device and help create the Topology map for that device.

Go to Menu, Select Settings . After that, Go to Plugin Library . Select Topology. The topology plugin screen is displayed.

Select to start creating a topology plugin.

Parameters to Create Topology Plugin

The following parameters appear on the Create Topology Plugin screen:

Name Enter a unique name of the topology plugin you wish to create.
Vendor Select the vendor for which you are creating the plugin.
Make and Model Select the Make and Model of the monitor for which you are creating the plugin.
Monitor/Group

Select Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor you want to assign the runbook to from the dropdown titled Monitors.
  • Select Group if you wish to assign the runbook to a group of monitors. Select the group you wish to assign the runbook to from the dropdown titled Groups.

 
Layer Protocol

Select the layer protocol out of the following:

  • CDP
  • LLDP
  • ISIS
  • ISPF
  • BGP
  • Switch Port Mapper(This protocol is only available when the protocol type is selected as Custom Protocol)
Protocol Type

Select the type of discovery protocol from the following:

  • Custom Protocol
  • SNMP Protocol
Script Language Select the language (GO or Python) in which you will write your script
Timeout
Parser Script Enter the script to parse the OID details.
Add Variable Add a variable, if needed to be used in the script.
Siddharth Sonaria

Topology Plugin

Overview

Motadata AIOps provides multiple in-built Topology Plugins which help to build the Topology of your network. These plugins are discovery protocols like CDP, Cisco BGP etc. that are used to construct the Network Topology.

You can create new Topology Plugins and manage the existing ones on the Topology Plugin Screen. You can view the details of the topology plugins on this screen. Also, you can create new topology plugins over here.

Go to Menu, Select Settings . After that, Go to Plugin Library . Select Topology. The Topology Plugin screen is displayed.

Topology Plugin Screen

The following fields are then displayed on the screen:

Name The name of the Topology plugin which is used to identify it.
Protocol Type This indicates the type of the discovery protocol. They are categorized into the following:

  • Custom Protocol
  • SNMP Protocol
Used Count Indicates the total number of monitors that are using the topology plugin.
Actions Selecting displays permissible actions for each plugin. The following actions are available for each user:

  • Assign Monitor : This button is used to assign the topology plugin to a monitor.
  • Remove Assigned Monitor : This button is used to unassign a topology plugin from a monitor.
  • Clone Topology Plugin : This button is used to duplicate an existing Topology plugin in the system.
  • Edit Topology Plugin : This button is used to edit the details of a topology plugin.
Siddharth Sonaria

How to Assign Metric Plugin to a Monitor?

Overview

In order to retrieve metrics from a monitor using customized metric plugins, the plugin should be assigned to the Monitor. Once assigned, the plugin will work on the monitor and retrieve the metrics as per the configuration in the plugin. The metrics will be polled for the monitor on the next poll.

Under the Actions Tab, Select to display permissible actions for each metric plugin. After that, Select Assign Monitor to display the list of monitors to which the metric plugin can be assigned. The monitors using the same communication protocol as the plugin are displayed for assignment.

Steps to Assign the Metric Plugin

Select the monitors to which you need to assign the metric plugin using the check-box against it. You can select multiple monitors in case you need to assign the plugin to more than one monitor at once.

Select Assign Monitor to assign the plugin to the selected monitor(s).

Select Cancel if you do not wish to assign the plugin to the monitor(s).

How to Unassign a metric plugin from the Monitor?

Overview

In case you don’t want to poll the new metrics using the metric plugin anymore, you can unassign the plugin from the monitor.

Under the Actions Tab, Select to display permissible actions for each metric plugin. After that, Select Remove Monitors to display the list of monitors which are using the plugin.

Steps to Unassign the Metric Plugin

Select the monitors from which the selected plugin needs to be removed by using the check-box against it. You can select multiple monitors in case you need to remove the plugin from multiple monitors at once.

Select Unassign Monitor to remove the plugin from the selected monitor(s).

Select Cancel if you do not wish to remove the plugin from the monitor(s).

Siddharth Sonaria

How to Clone a Metric Plugin?

Overview

Suppose you want to create a Metric Plugin similar to an existing one but with minor changes, you can use the Clone option.

This will help create a new Plugin with similar parameters. You can then change the parameters as per your requirement and create a new Plugin.

Under the Actions Tab, Select to display permissible actions for each topology plugin. After that, Select Clone to start creating a duplicate of the metric plugin.

The screen to create a metric plugin appears with the script same as the plugin you selected to clone.

Enter all the details as per your requirement. Refer How to Create a Metric plugin to find more details about the fields present in the screen.

Siddharth Sonaria

Custom Metric Plugin

Overview

************************************

After selecting , a screen appears to create a metric plugin.

HTTP/HTTPS plugin is selected by default. Select Custom to start creating plugin for PowerShell protocol.

Parameters for the Custom Metric Plugin Creation

The following parameters appear on the Create Metric screen for Custom Protocol.

Metric Name Enter a unique name of the metric you wish to create. The name should be given logically based on how the metric is defined.
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor to which you wish to assign the plugin from the dropdown titled Monitors.
  • Select Group if you wish to assign the plugin to a group of monitors. Select the group to which you wish to assign the plugin from the dropdown titled Groups.
Type Select Type of the monitor from the dropdown.
Credential Profile Select the credential profile so that your plugin is able to access the monitor using the appropriate credentials and retrieve the metrics as required.
Create Credential Profile Select this option if you wish to create a new credential profile.
Port Kindly enter the port number of the database instance.
Timeout Enter the time (in Seconds) that AIOps will try to establish the database connection before it times out. If the connection cannot be established due to unforeseen reasons, the connection will timeout in the time mentioned here instead of running indefinitely.
Script Write down the script here to retrieve the required details from the monitor.
Script Language Select the language (GO or Python) in which you write your parsing script.
Parsing Script Enter the script to parse the output received after executing the Database script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Metric button to create the metric based on the parameters entered.

Select the Test button to validate the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Metric option is enabled only after the Test is successfully completed.
Siddharth Sonaria

Database Metric Plugin

Overview

************************************

After selecting , a screen appears to create a metric plugin.

HTTP/HTTPS plugin is selected by default. Select Database to start creating plugin for Database protocol.

Parameters for Custom Metric Plugin Creation

The following parameters appear on the Create Metric screen for Database protocol.

Metric Name Enter a unique name of the metric you wish to create. The name should be given logically based on how the metric is defined.
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor to which you wish to assign the plugin from the dropdown titled Monitors.
  • Select Group if you wish to assign the plugin to a group of monitors. Select the group to which you wish to assign the plugin from the dropdown titled Groups.
Type Select Type of the monitor from the dropdown.
Credential Profile Select the credential profile so that your plugin is able to access the monitor using the appropriate credentials and retrieve the metrics as required.
Create Credential Profile Select this option if you wish to create a new credential profile.
Port Kindly enter the port number of the database instance.
Timeout Enter the time (in Seconds) that AIOps will try to establish the database connection before it times out. If the connection cannot be established due to unforeseen reasons, the connection will timeout in the time mentioned here instead of running indefinitely.
SQL Script Write down the script here to retrieve the required details from the monitor.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the Database script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Metric button to create the metric based on the parameters entered.

Select the Test button to validate the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Metric option is enabled only after the Test is successfully completed.
Siddharth Sonaria

PowerShell Metric Plugin

Overview

************************************

After selecting , a screen appears to create a metric plugin.

HTTP/HTTPS plugin is selected by default. Select PowerShell to start creating plugin for PowerShell protocol.

Parameters for the PowerShell Metric Plugin Creation

The following parameters appear on the Create Metric screen for SSH protocol.

Metric Name Enter a unique name of the metric you wish to create. The name should be given logically based on how the metric is defined.
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor to which you wish to assign the plugin from the dropdown titled Monitors.
  • Select Group if you wish to assign the plugin to a group of monitors. Select the group to which you wish to assign the plugin from the dropdown titled Groups.
Type Select Type of the monitor from the dropdown.
Credential Profile Select the credential profile so that your plugin is able to access the monitor using the appropriate credentials and retrieve the metrics as required.
Create Credential Profile Select this option if you wish to create a new credential profile.
PowerShell Script Write down the script here to retrieve the required details from the monitor.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the PowerShell script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Metric button to create the metric based on the parameters entered.

Select the Test button to validate the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Metric option is enabled only after the Test is successfully completed.
Siddharth Sonaria

SSH Metric Plugin

Overview

************************************

After selecting , a screen appears to create a metric plugin.

HTTP/HTTPS plugin is selected by default. Select SSH to start creating plugin for SSH protocol.

Parameters for the SSH Metric Plugin Creation

The following parameters appear on the Create Metric screen for SSH protocol.

Metric Name Enter a unique name of the metric you wish to create. The name should be given logically based on how the metric is defined.
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor to which you wish to assign the plugin from the dropdown titled Monitors.
  • Select Group if you wish to assign the plugin to a group of monitors. Select the group to which you wish to assign the plugin from the dropdown titled Groups.
Type Select Type of the monitor from the dropdown.
Credential Profile Select the credential profile so that your plugin is able to access the monitor using the appropriate credentials and retrieve the metrics as required.
Create Credential Profile Select this option if you wish to create a new credential profile.
SSH Script Write down script here to retrieve the required details from the monitor.
Port Enter the Port number.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SSH script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Metric button to create the metric based on the parameters entered.

Select the Test button to validate the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Metric option is enabled only after the Test is successfully completed.