Network Analytics Engine (NAE)

The Network Analytics Engine (NAE) is a troubleshooting solution that monitors switch data and executes actions when defined conditions are met. It uses a Python framework to create scripts that define what data should be monitored, set monitoring conditions, and associate predefined actions such as Syslog messages and CLI commands. Once a script is uploaded and validated, a corresponding agent can be created with customizable parameters.

NAE Script

An NAE Script is a Python file that:

  • Defines resources to be monitored (Monitors) using the REST API

  • Specifies Conditions on these resources

  • Triggers predefined or callback actions such as Syslog messages and CLI commands when conditions are met.

  • Serves as the template for agent creation once uploaded and validated

NAE Agent

An NAE Agent is a running instance of a validated script that:

  • Can be created multiple times from the same script

  • Activates all monitors defined in the script

  • Collects and evaluates data every 5 seconds

  • Generates alerts when conditions are met, repeating every 5 seconds while conditions remain true

  • Can be disabled to stop monitoring, and re-enabled to reactivate monitors

  • Allows parameter values to be customized per agent, overriding script defaults

Creating an NAE Script Profile

To create an NAE Script profile, complete the following steps:

  1. In the HPE Aruba Networking Central landing page, click the configurationicon.

    The Profiles tab is displayed.

  2. In the left navigation menu, select one of the following options:

    • Library—This is the default selection. If you create profiles in the Library, then you must assign scope and device functions to the profiles.

    • Global—If you create profiles at the Global level, then the profiles have Global scope assigned by default.

    • Site Collections—If you create profiles at the Site Collections level, then the profiles have site collection scope assigned by default.

    • Sites—If you create profiles at the Site level, then the profiles have site scope assigned by default.

    • Devices—If you create profiles at the Device level, then the profiles have device scope assigned by default.

    • Device Groups—If you create profiles at the Device Group level, then the profiles have device group scope assigned by default.

      Note:

      • To create profiles at the Global level, select the device type from the Device Function drop-down list before step 4.
      • To create profiles at the Site Collections, Sites, Devices, and Device Groups level, complete the following steps before step 4:
        1. Select Site Collections, Sites, Devices, or Device Groups in the left navigation menu.
        2. Select a Site Collection, Site, Device, or Device Group from the list view depending on the level where you are creating the profile.
        3. Select the device type from the Device Function drop-down list, if you are creating the profile at the Site Collection, Sites, or Device Groups level.

  3. On the System card, click the second radio button, and then click NAE Script.

    If you create the profile at the Library level, then click the third radio button on the System card, and then click NAE Script.

    Alternatively, you can complete the following steps:

    1. On the System card, click Manage.

    2. On the NAE Script card, click Manage.

    The NAE Script list view is displayed.

  4. Click Create Profile.

    The Create Profile side panel is displayed.

  5. Configure the following NAE Script profile parameters:

    • Create as a local profile—Select this option if you want to configure this profile as local.

      • Note:

      • The Create as a local profile option is available at the Global, Site Collections, Sites, Devices, and Device Groups levels; it is not available at the Library level.

      • At the Device level, the Create as a local profile check box is selected by default. This option cannot be disabled.

    • Name—Enter the name of the NAE Script profile.

    • Description—Enter the description for the NAE Script profile.

    • Script Options—Select one of the following options to add or manage an NAE Script:

      • Select File—If this option is selected, the Upload NAE Script field is displayed, allowing you to browse and select a script file from your local system.

      • Use Editor—If this option is selected, the Script field is displayed, allowing you to paste the script directly in the UI.

  6. Click Create.

    The newly created NAE Script profile is displayed in the NAE Script list.

  7. To delete an NAE Script profile, hover on the profile name, and click the delete icon.

  8. To search for a profile, type the profile name in the search bar.
    The search bar displays dynamic results as soon as you start typing.

Creating an NAE Agent Profile

To create an NAE Agent profile, complete the following steps:

  1. In the HPE Aruba Networking Central landing page, click the configurationicon.

    The Profiles tab is displayed.

  2. In the left navigation menu, select one of the following options:

    • Library—This is the default selection. If you create profiles in the Library, then you must assign scope and device functions to the profiles.

    • Global—If you create profiles at the Global level, then the profiles have Global scope assigned by default.

    • Site Collections—If you create profiles at the Site Collections level, then the profiles have site collection scope assigned by default.

    • Sites—If you create profiles at the Site level, then the profiles have site scope assigned by default.

    • Devices—If you create profiles at the Device level, then the profiles have device scope assigned by default.

    • Device Groups—If you create profiles at the Device Group level, then the profiles have device group scope assigned by default.

      Note:

      • To create profiles at the Global level, select the device type from the Device Function drop-down list before step 4.
      • To create profiles at the Site Collections, Sites, Devices, and Device Groups level, complete the following steps before step 4:
        1. Select Site Collections, Sites, Devices, or Device Groups in the left navigation menu.
        2. Select a Site Collection, Site, Device, or Device Group from the list view depending on the level where you are creating the profile.
        3. Select the device type from the Device Function drop-down list, if you are creating the profile at the Site Collection, Sites, or Device Groups level.

  3. On the System card, click the second radio button, and then click NAE Script.

    If you create the profile at the Library level, then click the third radio button on the System card, and then click NAE Agent.

    Alternatively, you can complete the following steps:

    1. On the System card, click Manage.

    2. On the NAE Agent card, click Manage.

    The NAE Agent list view is displayed.

  4. Click Create Profile.

    The Create Profile side panel is displayed.

  5. Configure the following NAE Agent profile parameters:

    • Create as a local profile—Select this option if you want to configure this profile as local.

      • Note:

      • The Create as a local profile option is available at the Global, Site Collections, Sites, Devices, and Device Groups levels; it is not available at the Library level.

      • At the Device level, the Create as a local profile check box is selected by default. This option cannot be disabled.

    • Name—Enter the name of the NAE Agent profile.

    • Description—Enter the description for the NAE Agent profile.

    • Enable—Select the checkbox to enable the NAE Agent.

    • Script Name—Select the script from the drop-down for which you want to create an agent.

    • Parameters— Modify the parameters listed in the script. The available columns are Name, Default, and Value. The Value column is customizable per agent, overriding the script defaults.

  6. Click Create.

    The newly created NAE Agent profile is displayed in the NAE Agent list.

  7. To delete an NAE Agent profile, hover on the profile name, and click the delete icon.

  8. To search for a profile, type the profile name in the search bar.
    The search bar displays dynamic results as soon as you start typing.