Configuration

Download this manual as a PDF file

The following sections describe how to configure and discover Juniper: Mist devices for monitoring by SL1 using the Juniper: MistPowerPack:

This section covers the following topics:

Creating a SOAP/XML Credential for Juniper: Mist

To configure SL1 to monitor Juniper: Mist devices, you must first create a SOAP/XML credential. This credential allows the Dynamic Applications in the Juniper: Mist PowerPack to communicate with Juniper: Mist devices.

The PowerPack includes an example SOAP/XML credential that you can edit for your own use.

To configure a SOAP/XML credential to access Juniper: Mist devices:

  1. Go to the Credentials page (Manage > Credentials).
  2. Locate the Juniper Mist Example sample credential, click its Actions icon () and select Duplicate. A copy of the credential, called Juniper Mist Example copy appears.
  3. Click the Actions icon () for the Juniper Mist Example copy credential and select Edit. The Edit Credential modal page appears.

  1. Supply values in the following fields:
  • Name. Type a new name for the credential.
  • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about aligning credentials and organizations, see Aligning Organizations With a Credential.

  • URL. Type the URL of your Juniper: Mist API endpoint. The example URL uses "https://api.mist.com/api/v1/" as a default value , Please verify and modify the URL for your specific region.

The URL provided in the sample credential is the generic main Juniper: Mist URL. There are several others, the choice of which is determined by your global region. For example, the URL for the EU region could be https://api.eu.mist.com/ For more information, see the Juniper: Mist documentation at https://www.juniper.net/documentation/us/en/software/mist/automation-integration/topics/topic-map/api-endpoint-url-global-regions.html#reference_u5h_lrd_qjb .

  • Embed Value [%1]. Enter your Juniper: Mist Organization ID.
  • HTTP Auth Password. Type the Juniper: Mist API Key.
  • Embedded Password [%P]. Leave this field blank.

The PowerPack does not verify SSL certificates by default. You can enable SSL verification by selecting the SSLVERIFYPEER option from the CURL Options field and then selecting 1 from the drop-down field. Since the Mist API exists at a public URL with an authority-issued certificate, no further action is required.

Proxy Settings

You must complete the Proxy Settings fields only if you connect to Juniper: Mist through a third-party proxy server. If you do not use a proxy to connect to Juniper: Mist, then you can leave these fields blank.

  • Proxy Hostname/IP. Type the server's hostname or IP address.
  • Proxy Port.Type the port on the proxy server to which you will connect.
  • Proxy User. Type the username used to access the proxy server.
  • Proxy Password. Type the password used to access the proxy server.

HTTP Headers

  • Add a header. Click Add a header to connect a proxy server using http or https.

    • proxy_url_protocol:http.Enter this schema if the proxy server does not have https configured.
    • proxy_url_protocol:https. Enter this schema if the proxy server has https configured.
  1. Click Save & Close.

Creating a SOAP/XML Credential for Juniper: Mist in the SL1 Classic User Interface

To configure SL1 to monitor Juniper: Mist devices, you must first create a SOAP/XML credential. This credential allows the Dynamic Applications in the Juniper: Mist PowerPack to communicate with Juniper: Mist devices.

The PowerPack includes an example SOAP/XML credential that you can edit for your own use.

To configure a SOAP/XML credential to access Juniper: Mist devices:

  1. Go to the Credential Management page (System > Manage > Credentials).
  2. Locate the Juniper Mist Example credential, then click its wrench icon (). The Edit SSH/Key Credential modal page appears:

  1. Complete the following fields:
  • Profile Name. Type a new name for the credential.
  • URL. Type the URL of your Juniper: Mist API endpoint. The example URL uses "https://api.mist.com/api/v1/" as a default value , Please verify and modify the URL for your specific region.

The URL provided in the sample credential is the generic main Juniper: Mist URL. There are several others, the choice of which is determined by your global region. For example, the URL for the EU region could be https://api.eu.mist.com/ For more information, see the Juniper: Mist documentation at https://www.juniper.net/documentation/us/en/software/mist/automation-integration/topics/topic-map/api-endpoint-url-global-regions.html#reference_u5h_lrd_qjb .

  • Embed Value [%1]. Enter your Juniper: Mist Organization ID.
  • HTTP Auth Password. Type the Juniper: Mist API Key.
  • Embedded Password [%P]. Leave this field blank.

The PowerPack does not verify SSL certificates by default. You can enable SSL verification by selecting the SSLVERIFYPEER option from the CURL Options field and then selecting 1 from the drop-down field. Since the Mist API exists at a public URL with an authority-issued certificate, no further action is required.

Proxy Settings

You must complete the Proxy Settings fields only if you connect to Juniper: Mist through a third-party proxy server. If you do not use a proxy to connect to Juniper: Mist, then you can leave these fields blank.

  • Proxy Hostname/IP. Type the server's hostname or IP address.
  • Proxy Port.Type the port on the proxy server to which you will connect.
  • Proxy User. Type the username used to access the proxy server.
  • Proxy Password. Type the password used to access the proxy server.

HTTP Headers

  • Add a header. Click Add a header to connect a proxy server using http or https.

    • proxy_url_protocol:http.Enter this schema if the proxy server does not have https configured.
    • proxy_url_protocol:https. Enter this schema if the proxy server has https configured.
  1. Click the Save As button.

Discovering Juniper: Mist Devices

To discover Juniper: Mist devices, you must first create a virtual device, and then align Dynamic Applications to it.

Creating a Juniper: Mist Virtual Device

To monitor your Juniper: Mist devices, you must create a virtual device that represents the Juniper: Mist root device. A virtual device is a user-defined container that represents a device or service that cannot be discovered by SL1. You can use the virtual device to store information gathered by policies or Dynamic Applications.

If you want to discover more than one Juniper: Mist account, you must create a virtual device for each API key that you want to use.

To create a virtual device:

  1. Go to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).

  1. Click Actions and select Create Virtual Device from the menu. The Virtual Device modal page appears.
  1. Enter values in the following fields:
  • Device Name. Enter a name for the device.
  • Organization. Select the organization for this device. The organization you associate with the device limits the users that will be able to view and edit the device. Typically, only members of the organization will be able to view and edit the device.
  • Device Class. Select Mist | Mist Portal.
  • Collector. Select the collector group that will monitor the device.
  1. Click Add to create the virtual device.
  2. Repeat these steps for each Juniper: Mist API key that you want to use.

Manually Aligning Dynamic Applications to the Virtual Device

After creating the Juniper: Mist virtual device, you must manually align the "Mist: API Cache Producer" and "Mist: Site Discovery" Dynamic Applications to the Juniper: Mist virtual device.

To manually align the Juniper: Mist Dynamic Application:

  1. Go to the Devices page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).

  1. Locate your Juniper: Mist virtual device and click its name.
  2. In the Device Investigator, click the Collections tab. 
  3. Click the Edit button at the top of the page, then click the Align Dynamic App button.
  1. In the Align Dynamic Application modal, click Choose Dynamic Application.
  2. Locate "Mist: API Cache Producer" and click Select.
  1. In the Align Dynamic Application modal, de-select the Use Device SNMP Credential box. Click the Choose Credential option that appears.
  2. Select the Juniper: Mist SOAP/XML credential you created and click Select.
  1. Click Align Dynamic App to align the Dynamic Application with the Juniper: Mist virtual device.
  2. Repeat this process for the "Mist: Site Discovery" Dynamic Application.

After aligning the "Mist: API Cache Producer" and "Mist: Site Discovery" Dynamic Applications, your Juniper: Mist component devices will be discovered and classified.

Upon initial collection, you will see the "Cache empty or expired" event in SL1. This event is expected and will expire in 60 minutes, or it can be manually cleared. Once the cache producer finishes creating the cache, this event will no longer occur.

Manually Aligning Dynamic Applications to the Virtual Device in the SL1 Classic User Interface

After creating the Juniper: Mist virtual device, you must manually align the "Mist: API Cache Producer" and "Mist: Site Discovery"  Dynamic Applications to the Juniper: Mist virtual device.

To manually align the Juniper: Mist Dynamic Application:

  1. Go to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).
  1. Click the wrench icon () for your Juniper: Mist virtual device.
  2. In the Device Administration panel, click the Collections tab. The Dynamic Application Collections page appears.
  3. Click the Actions button and select Add Dynamic Application from the menu.
  1. In the Dynamic Application Alignment window, from the Dynamic Applications field, select the "Mist: API Cache Producer" Dynamic Application.
  2. In the Credentials field, select the Juniper: Mist credential you created.
  1. Click Save to align the Dynamic Application with the Juniper: Mist virtual device.
  2. Repeat this process for the "Mist: Site Discovery" Dynamic Application.

After aligning the "Mist: API Cache Producer" and "Mist: Site Discovery" Dynamic Applications, your Juniper: Mist component devices will be discovered and classified.

Upon initial collection, you will see the "Cache empty or expired" event in SL1. This event is expected and will expire in 60 minutes, or it can be manually cleared. Once the cache producer finishes creating the cache, this event will no longer occur.

Viewing Juniper: Mist Component Devices

In addition to the Devices page, you can view your Juniper: Mist devices in the following places in the user interface:

  • The Device Investigator Map page (click Map in the Device Investigator page) displays a map of a particular device and all of the devices with which it has parent-child relationships. Double-clicking any of the listed devices reloads the page to make the selected device the primary device.

  • The Device Components page (Devices > Device Components) displays a list of all root devices and component devices discovered by SL1. The Device Components page displays all root devices and component devices in an indented view, so you can easily view the hierarchy and relationships between child devices, parent devices, and root devices. To view the component devices associated with a Juniper: Mist device, find the device and click its plus icon (+).

  • The Component Map page (Classic Maps > Device Maps > Components) allows you to view devices by root node and view the relationships between root nodes, parent components, and child components in a map. This makes it easy to visualize and manage root nodes and their components. SL1 automatically updates the Component Map as new component devices are discovered. The platform also updates each map with the latest status and event information. To view the map for a Juniper: Mist device, go to the Component Map page and select the map from the list in the left NavBar. To learn more about the Component Map page, see the section on Maps.