Manifest

The manifest introduces the script to the Python compiler. The manifest is required.

Example of a manifest: 

Manifest = {
    'Name': 'com.arubanetworks.cpu_monitor_threshold',
    'Description': 'System CPU Monitoring Policy on configured threshold values',
    'Version': '0.1',
    'Author': 'Aruba Networks'
    'APIVersion': '1.0.0',
    'TargetPlatform': '8400',
    'TargetSoftwareVersion': '10.03'
    'Tags': ['application']
}

Required items

Name

Specifies a unique name for the script. The name must be a text string that starts with a letter or number and can contain alphanumeric characters and the special characters . (dot), - (hyphen), and _ (underscore). The maximum length of the plus the version must not exceed 80 characters‍‍.

Hewlett Packard Enterprise recommends that the name be a canonical name (CNAME). The canonical name follows the reverse domain name notation. For example: com.myco.bgp_mon1.0

Description

Describes what the script monitors. Must be a text string.

Version

Specifies version information about the script. The version is appended to the script name. The version must be a text string that starts with a letter or number and can contain alphanumeric characters and the special characters . (dot), - (hyphen), and _ (underscore). The maximum length of the name plus the version must not exceed 80 characters. Version must not be empty.

Author

Specifies the author of the script. Must be a text string.

Optional items

APIVersion

Specifies which NAE script API version is required to run this script. This item is informational only. No validation or action is performed for this item.

Default: 1.0.0

TargetPlatform

Specifies the switch platform on which the script is designed to be executed. If this item is not specified, the script is considered to be platform independent. This item is informational only. No validation or action is performed for this item.

Example: 8325

TargetSoftwareVersion

Specifies the switch firmware version or versions on which the script is designed to be executed. If TargetPlatform is not specified, the script is expected to work with any software version. This item is informational only. No validation or action is performed for this item.

Example: 10.03

Tags

Specifies one or more tags to provide information about the script.

The following tags are used by NetEdit to categorize and group the script and related alerts, and to automatically incorporate new NAE scripts into the health ranking for each of the following categories:

  • application

  • segmentation

  • service (includes Client Services)

  • routing

  • bridging

  • device

  • other

Each tag must be a text string. This item is informational only. No validation or action by the NAE is performed for this item.

Examples:

  • 'Tags': ['application']

  • 'Tags': ['segmentation','vlan']

The manifest tags are not shown in the Web UI or the CLI, and they are not the same as the script tags in the ASE. To view the tags associated with a script installed on a switch, you can do one of the following:

  • Look at the Manifest in the script by viewing the script contents on the Script Details page of the Web UI.

  • Use the REST API to get information about the script.