Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

About the Plugin Inventory Page

To access this page, click Inventory > Active Assurance > Plugin Inventory.

A Plug-in is a software extension that enables Test Agents to run Measurements. Plug-ins are packaged as .nap files, which contain necessary Plug-in executables and dependencies. Each Plug-in supports a specific type of measurement such as DNS, HTTP, TWAMP, IPTV, RPM, and so on. For more information on Plug-ins, see Supported Plug-ins.

When a Test or a Monitor is started, Routing Director creates the appropriate Measurements to run on the Test Agents specified in the Test or Monitor configuration. Test Agents download the Plug-in packages and use them to run Measurements. The Measurements then report metrics in the form of streams, which you can view in the Routing Director GUI. For more information, see Tests and Monitors Overview.

The Plugin Inventory page provides a centralized view of all the Plug-ins and their versions. By default, the Plug-in inventory includes the released versions of Plug-ins. You can upload the patch versions by downloading the required .nap files by clicking Download Plugin Patch Release link from the Plugin Inventory (Inventory > Active Assurance > Plugin Inventory) page to your local system.

Tasks You Can Perform

You can perform the following tasks from this page:

  • View details of a Plug-in—You can view the list of all the Plug-ins and its versions, and you can also view details of a Plug-in you have selected.

    To view the details of a Plug-in, select a Plug-in Display Name. The Plugin Details page appears displaying the Plug-in details.

    On the Plugin Details page, you can:

    • View upgrade status—You can view the general information about the selected Plug-in Upgrade tab as listed in Table 1.

    • View Measurements—You can view the list of Measurements associated with the selected Plug-in and its details in Measurements tab as described in Table 2.

  • Set a Plug-in version as active—You can select a Plug-in version and set the version as the active one by clicking the Set Active button. However, at any point in time, a Plug-in can have only one version set as Active (enabled). This is because Test Agents cannot run multiple versions of the same Plug-in simultaneously.  When you set a version for a Plug-in, Routing Director performs a rolling update to gradually migrate all Measurements to the new version. A rolling update is done to avoid multiple Test Agents downloading the new Plug-in version simultaneously, thereby causing system overload.

    To set a Plug-in version as active:

    1. Select the Plug-in-Name that you want to set active.

    2. Click the Set Active button.

      The Confirm Plugin Version Activation page is displayed asking you to confirm the activation. On this page, you can also view the list of measurements associated with the selected plug-in that are impacted by its activation. You can view measurement details such as its name, associated plug-in and parent name, and so on.

    3. Click OK.

      A message is displayed confirming that you have successfully activated the selected Plug-in version.

      Once a Plug-in version is set as active, an Active tag is displayed next to the name to indicate that it is currently in use.

    When you enable an active version for a Plug-in, all the Tests, Monitors, and Measurements use the active (enabled) version. Routing Director performs a rolling update to gradually migrate all Measurements to the new version. A rolling update is done to avoid multiple Test Agents downloading the new Plug-in version simultaneously, thereby causing system overload.

  • Upload a Plug-in file—You can upload one or more Plug-in files in the .nap format. To upload a Plug-in file:

    1. Click Inventory > Active Assurance > Plugin Inventory in the left-nav bar.

      The Plugin Inventory page is displayed.

    2. Click the Upload button.

      The Upload Plugin page is displayed.

    3. Upload the Plug-in .nap file in two ways:

      • Click Browse for files and select one or more Plug-in .nap files that are saved on your computer.

      • Drag and drop one or more Plug-in .nap files on the upload area of Upload Plugin page.

        Note:

        You can upload one or more versions of the same Plug-in or upload one or more different plug-ins, but only the active (enabled) version is used for running Measurements on Test Agents.

      A progress bar displays the progress of the upload operation.

    4. Click OK.

      A message is displayed confirming that you have successfully uploaded the Plug-in .nap files.

      The plug-ins are uploaded to the Routing Director database and listed on the Plugin Inventory page.

      Note:

      Each Plug-in can have one or more versions, but only one version can be active at a point of time. By default, after uploading a Plug-in, it is enabled based on the following scenarios:

      • If the Plug-in is new to Routing Director, it will be enabled for all organizations.

      • If the Plug-in already exists and you are uploading a new version, the new version will be enabled only for the organization used to upload it.

      To prevent the Plug-in from being activated immediately after uploading, clear the checkbox Activate Plug-in Versions automatically after upload is successful.

  • You can also perform the following tasks on this page:

    • Sort, resize, or re-arrange columns in a table (grid).

    • Show or hide columns in the table or reset page preferences, using the vertical ellipsis menu.

    • Filter the data displayed in the table—Click the filter icon (funnel) and select whether you want to show or hide advanced filters. You can then add or remove filter criteria, save criteria as a filter, apply or clear filters, and so on. The filtered results are displayed on the same page.

  • Table 1: Fields on the Plugin Inventory Page
    Field Description

    ID

    The unique ID of the Plug-in.

    Name

    The internal name of the Plug-in.

    Display Name

    The human-readable name of the Plug-in.

    Click and expand a display-name to view all the available versions for the selected Plug-in.

    Description

    The description of the Plug-in.

    Active

    The current active status of the Plug-in version. Each Plug-in can only have one active version at a time.

    • Green tick mark—Indicates that the Plug-in version is active.

    • Grey null mark—Indicates that the Plug-in version is inactive.

    Versions

    The version numbers of the available plug-ins.

    Platforms

    The platforms that are supported by a Plug-in version.

    Each Plug-in .nap file is packaged for a particular platform. The platforms include specific CPU architectures (x86_64, aarch64, arm64) or native routers execution (juniper-rpm).

    Uploaded Time

    The date and time when the Plug-in was uploaded.

    Uploaded By ID

    The ID of the user who uploaded the Plug-in.

    Uploaded By Email

    The email address of the user who uploaded the Plug-in.

    Upgrade Status

    The current upgrade status of the Plug-in version. The status indicates whether the Plug-in has ever been upgraded and whether the upgrade process was completed successfully.

    Errored Installs

    The number of Plug-in installations that failed.

    Ongoing Installs

    The number of Test Agents currently installing the new Plug-in versions. Plug-in upgrade follows a rolling process, and the maximum number of parallel installations is defined by configuration.

    Pending Installs

    The number of Plug-in installations that are pending.

    Pending Installs (Offline Agents)

    The number of installations that cannot be started because the Test Agent is offline. These pending installations will be started when Test Agents are back online.

    Pending Reconfigure Agents

    The number of Test Agents that have successfully installed the new Plug-in version but need to reconfigure their Measurements to use the new Plug-in version.

    Successful Installs

    The number of Plug-in installations that are successful.

    Total Installs

    The total number of Test Agents that have an older version of the Plug-in installed and need to upgrade to the specified Plug-in version for the upgrade to complete.

    Start Time

    The time when the Plug-in upgrade process was started.

    Table 2: Fields on the Measurements Tab
    Field Description

    Name

    The unique identifier of the Measurement.

    Plugin Name

    The Plug-in used for the Measurement.

    Parent

    The parent of the selected Measurement.

    Indicates whether the selected Measurement was created by a Monitor, a Test, or as a standalone measurement created through an API instance.

    Status

    The current status of the Measurement.

    The available statuses are:

    • Configuring

    • Deconfigured

    • Deconfiguring

    • Error

    • Running