Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Installing AI-Scripts

 

AI-Scripts can be installed on a device running Junos OS in the following two ways:

AI-Scripts System Requirements

AI-Scripts can be installed and run on devices running Junos OS Release 11.4 or later. For the latest AI-Scripts information, see the AI-Scripts Release Notes at AI-Scripts Release Notes.

Note

The nocopy, un-link option is not valid when installing AI-Scripts on EX Series devices because the package is automatically deleted from the copied location of the device.

Downloading AI-Scripts Install Packages and Release Notes

AI-Scripts are released in AI-Scripts install packages. AI-Scripts install packages are available for download at the AI-Scripts download site. Also, download the Advanced Insight Scripts (AI-Scripts) Release Notes.

Before you begin, ensure that you have an account and a valid service contract with Juniper Networks. If you do not have an account, complete the registration form at https://www.juniper.net/registration/Register.jsp to open an account.

To download an AI-Scripts install package:

  1. Open a Web browser and go to the following location:

    https://www.juniper.net/support/downloads/?p=serviceautomation.

  2. Log in to the Juniper Networks authentication system using the username and password provided by Juniper Networks.

  3. Download the AI-Scripts install package.

    If you want to install AI-Scripts manually, move AI-Scripts Install Package to the /var/sw/pkg directory on the device. If you do not move the AI-Scripts install package to the device, you have to use FTP or Secure Copy Protocol (SCP) in conjunction with the request system scripts add command to copy the file to the device while installing AI-Scripts on the device..

    To install AI-Scripts automatically on a group of devices, download the AI-Scripts install Package to the same server as the Junos Space Network Management Platform software.

AI-Scripts Install Package Versioning

AI-Scripts install packages are versioned as follows:

For example:

where,

  • m.n are two integers that represent the software release number; m denotes the major release number and n the minor release number.

  • Z is a capital letter that indicates the type of software release. In most cases, it is R, to indicate that this is a released software. If you are involved in testing prereleased software, this letter might be B for beta-level software.

  • x.x is the software build number and spin number.

The AI-Scripts files in the install package are compressed into a tgz tarball file.

Each AI-Scripts install package supports up to 3 previous years of Junos OS software releases.

The show version CLI operational command displays the version of the AI-Scripts install package that is installed on a device.

The JMB contains the output of the show version CLI command to indicate the version of the AI-Scripts install package installed on a device.

Refer to the latest AI-Scripts Release Notes for the current release information.

AI-Scripts Install Locations on Devices

AI-Scripts are installed on a device hard disk at the following location:

AI-Scripts are installed on a device flash drive at the following location:

Note

If you configure the load-scripts-from-flash option, the system reads event-scripts from /config/scripts/ directory. Otherwise, the system reads AI-Scripts from the /var/db/scripts/ directory. The /var/run/scripts directory always points to the correct scripts directory.

Automatically Installing AI-Scripts Bundles

You can use Junos Space Service Now to install an AI-Scripts bundle on devices. For information about using Service Now to install AI-Scripts bundles, see Adding a Script Bundle to Junos Space Service Now.

If you do not want to use Service Now to install AI-Scripts bundles, you can manually configure and install the AI-Scripts install package on each device separately.

Note

We recommend that you always use Service Now for installing AI-Scripts Release 5.0 and later on devices running Junos OS.

Manually Installing AI-Scripts on Devices

AI-Scripts Releases prior to 5.0R2.0 can be installed on Junos OS devices manually by using CLI mode. For manual installation of AI-Scripts on devices, you require the same login credentials that you use to discover devices in Junos Space Network Management Platform.

Note

We recommend that you install AI-Scripts on devices during a maintenance window.

To install AI-Scripts Release 4.XRX or earlier manually on a device:

  1. Copy the AI-Scripts install package (example: jais-4.0R1.0-signed.tgz) to the Junos OS device using SCP or FTP.
  2. Install the AI-Scripts bundle install package in CLI mode by using one of the following commands:

    • request system scripts add <pathname>, where <pathname> is the path to the AI-Scripts bundle copied on the device.

    • request system software add <package-name> <node>, where <node> is the Routing Engine—re0 or re1 and <package-name> is the name of the AI-Scripts bundle copied on the device.

    Note
    • The request system software add <pathname> <node> command when executed on a master Routing Engine installs AI-Scripts on all backup Routing Engines of a device.

    • We recommend that the AI-Scripts installation package be placed in the /var/tmp/ directory as some platforms require the package to be stored in the /var/tmp/ directory.

    • When you install AI-Scripts in the Juniper Networks QFX3000 device, ensure that you install the events scripts only on the controller. The controller installs AI-Scripts on the node devices and enables all the events.

    The AI-Scripts install package is installed on the device.

  3. Verify that AI-Scripts is installed on all Routing Engines of the device by using the show version command.

    AI-Scripts is installed on the device if AI-Scripts [version} is displayed in the output of the show version command.

  4. From configuration mode, execute the following commands:

    set groups juniper-ais system scripts commit allow-transients

    set groups juniper-ais system scripts commit file jais-activate-scripts.slax optional

    set groups juniper-ais event-options destinations juniper-aim archive-sites /var/tmp/
    Note

    For QFabric devices, use the following command:

    set fabric administration ais enable

  5. Commit the static AI-Scripts configuration.

To install AI-Scripts 5.0 (5.0R2, 5.0R3, and 5.0R4) and later releases manually on a device:

Best Practice

We recommend you to use Service Now to install AI-Scripts Release 5.0R2.0 and later. For information about installing AI-Scripts Release 5.0R2.0 and later on a device by using Service Now, see Installing an Event Profile on a Device by Using Service Now.

Note
  • AI-Scripts Release 5.0R2.0 or later cannot be installed on QFabric devices.

  • You cannot install AI-Scripts Release 6.0R1 and later on a device manually. Service Now displays a warning message on the Service Now GUI when AI-Scripts Release 6.0R1 and later is manually installed on a device.

  1. Copy the AI-Scripts install package (example: jais-5.0R2.0-signed.tgz) to the Junos OS device using SCP or FTP.
  2. Install the AI-Scripts bundle install package in CLI mode by using one of the following commands:

    • request system scripts add <pathname>, where <pathname> is the path to the AI-Scripts bundle copied on the device.

    • request system software add <pathname> <node>, where<node> is the Routing Engine—re0 or re1 and <package-name> is the name of the AI-Scripts bundle copied on the device.

    Note
    • The request system software add <pathname> <node> command when executed on a master Routing Engine installs AI-Scripts on all backup Routing Engines of a device.

    • We recommend that the AI-Scripts installation package be placed in the /var/tmp/ directory as some platforms require the package to be stored in the /var/tmp/ directory.

    • When you install AI-Scripts in the Juniper Networks QFX3000 device, ensure that you install the events scripts only on the controller. The controller installs AI-Scripts on the node devices and enables all the events.

    The AI-Scripts install package is installed on the device.

  3. Verify that AI-Scripts is installed on all Routing Engines of the device by using the show version command.
  4. For AI-Scripts Release 5.0R1 and later, enter the configuration mode on the device and add the static AI-Scripts configuration as follows:
  5. Commit the static AI-Scripts configuration.Best Practice

    We recommend that you commit the AI-Scripts configuration during a maintenance window.

    On a multichassis system, use the commit synchronize command so that the AI-Scripts configuration is committed on all Routing Engines.

  6. Do one of the following to activate the event profile
    • If using the AISevent_info_default.xml file to define the event profile, edit the AISevent_info_default.xml file to include the events that you want to monitor on the device.

      The AISevent_info_default.xml file is present at the /var/db/scripts/commit location and includes all the event definitions that are available for a release. The default event profile automatically excludes events that are not valid for a device.

      Use the op ais-param-set event-file default command to activate the event profile.

      Best Practice

      On a multichassis system, execute the command on the master Routing Engine.

    • If using the AISBundle_info.xml file to define event profile, verify that the AISBundle_info.xml file is present in the /var/db/scripts/commit/ location.

      The file contains the definitions for the events to be monitored on the device and is stored on the device by Service Now while installing AI-Scripts.

      Use the op ais-param-set event-file /var/db/scripts/commit/AISBundle_info.xml command to activate the event profile.

The event profile is installed and configured on the device.