Adding Missing DMI Schemas or Updating Outdated DMI Schemas in Junos Space Network Management Platform

Adding Missing DMI Schemas by Using the View/Install Missing Schema Action

Junos Space Platform provides the View/install Missing Schema action to view and install DMI schemas that are missing from Junos Space Platform.

1. On the Junos Space Platform interface, select Administration > DMI Schemas.

   The DMI Schemas page appears.

2. Select Actions > View/Install Missing Schemas.

   The View/Install Missing Schemas page lists the device family and the OS versions for which schemas are not present in Junos Space Platform.

3. Select the device family and OS versions for which you want to download schemas, and click Install.

   A job to download the selected schemas is initiated and the Job ID is displayed.

4. (Optional) Click the Job ID link to view the job details.

   If the job is successful, the job details displays the number of schemas successfully installed and the number of schemas that could not be installed.

   The job may fail if connection to the DMI schema repository is broken or if the required schema is not present in the repository.

Adding Missing DMI Schemas or Updating Outdated DMI Schemas by Using the Get Latest Action

The Get Latest action downloads missing schemas and updates outdated schemas in Junos Space Platform. The Get Latest action is enabled only after the DMI schema repository is configured.

1. On the Junos Space Platform interface, select Administration > DMI Schemas.

   The DMI Schemas page appears displaying the existing DMI schemas.

2. Select one or more DMI schemas
3. Select Actions > Get Latest.

   A job is created to download the schemas from the DMI schema repository and the job ID is displayed. If a DMI schema is already present in Junos Space Platform and outdated, the schema is overwritten by the latest schema downloaded from the DMI schema repository. If the DMI schema is not present in Junos Space Platform,, the schema is downloaded from the repository and installed in Junos Space Platform.

4. (Optional) Click the job ID to view the job details.

   The Job Details page displays if the Get Latest action was successful or not.

Adding Missing DMI Schemas or Updating Outdated DMI Schemas by Using REST APIs

Junos Space Platform provides an option to download missing schemas or update outdated schemas by using REST APIs for situations where the Junos Space Platform is not connected to the Web.

To generate the APIs, Junos Space Platform has the schemaInstall.py script stored in the /var/log/space-debug/debug-utilities/schemaManagement location. When Junos Space Platform is not connected to the Web, download the script to a local system from which you can connect to the Web. The information for using the schemaInstall.py script to manage DMI schemas is documented in this section and is also present in the ReadMe.txt file located at /var/log/space-debug/debug-utilities/schemaManagement.

To run the schemaInstall.py script on a local system, the local system should meet the following requirements:

• Python 3.6 (https://www.python.org/ftp/python/3.6.1/python-3.6.1.exe)
• SVN client such as Tortoise SVN (https://tortoisesvn.net/downloads.html )
• Python Installation Package (PIP) Version 3.6 installed on the local system

Note: You can obtain help for the schemaInstall.py script by using the python schemaInstall.py --help command.

You can run the schemaInstall.py script as follows to add missing schemas or update outdated schemas in Junos Space Platform depending on connectivity of the local system to Junos Space Platform and the DMI schema repository:

Note: Before you run the script, copy the script to a local system that is connected to the Web.

The following variables are used by the schemaInstall.py script:

• svnurl is the link to DMI Schema repository (https://xml.juniper.net/dmi/repository/trunk/).
• spaceuser is the username for logging in to Junos Space Platform.
• svnuser is the username for logging in to the DMI Schema repository.
• spaceurl is the link to Junos Space Platform.

• Situation 1: When your local system is connected to both Junos Space Platform and the DMI schema repository, you can execute the script to perform the following tasks:
  • Add missing DMI schemas in Junos Space Platform by executing the following command on the local system:

    python schemaInstall.py -o install-missing-schemas --svnurl="<svnurl>" 
    --spaceuser="<spaceuser>" --svnuser="<svnuser>" --spaceurl="<spaceurl>"

  • Add specific schemas on Junos Space platform by executing the following command on the local system:

    python schemaInstall.py -o install-schemas --svnurl="<svnurl>" 
    --spaceuser="<spaceuser>" --svnuser="<svnuser>" --spaceurl="<spaceurl>" 
    --file="schema.xml"

    Where, schema.xml is the file containing specific schemas that you want to install.

    ~~ Structure of sample schema.xml file ~~
     
    <dmi-schema-infos
    uri="/api/space/schema-service/dmi-schemas-with-missing-schemas">
         <dmi-schema-info>
             <os-version>3.0R1</os-version>
             <dev-family>ive-ic</dev-family>
         </dmi-schema-info>
         <dmi-schema-info>
             <os-version>11.3X30.10</os-version>
             <dev-family>junos-qf</dev-family>
         </dmi-schema-info>
    </dmi-schema-infos>
    

    You can obtain the schema.xml file by one of the following means:

    • Create the schema file manually.
    • Obtain the list of all schemas present in Junos Space Platform by executing the following command:

       python schemaInstall.py -o get-schemas --spaceurl="<spaceurl>"  --spaceuser="<spaceuser>" --file="schema.xml"  

    • Obtain the list of schemas missing in Junos Space Platform by executing the following commands:

      python schemaInstall.py -o checkout-missing-schemas --svnurl="<svnurl>"  --spaceuser="<spaceuser>" --svnuser="<svnuser>" --spaceurl="<spaceurl>"

    The schema.xml file obtained by using the get-schemas and the checkout-missing-schemas methods can be used for installing schemas on Junos Space Platform and checking out schemas on the DMI Schema repository.

  • Find the schemas missing in Junos Space Platform and obtain those schemas from the DMI schema repository in a *.tgz file by executing the following command:

    python schemaInstall.py -o checkout-missing-schemas --svnurl="<svnurl>" 
    --spaceuser="<spaceuser>" --svnuser="<svnuser>" --spaceurl="<spaceurl>"
    

    This command outputs the upload-tgz-schema-file.tgz archive file. You can upload the archive file later by using the Update Schema menu; see Adding Missing DMI Schemas or Updating Outdated DMI Schemas by Using the Update Schema Menu for details.

• Situation 2: When the local system has connectivity to the DMI schema repository but not to the Junos Space platform, you can execute the script to download specific schemas in archived format (*.tgz) from the repository. You can later add the schemas to Junos Space Platform by using the Update Schema menu; see Adding Missing DMI Schemas or Updating Outdated DMI Schemas by Using the Update Schema Menu for details.

  python schemaInstall.py -o checkout-schemas --svnurl="<svnurl>" 
  --svnuser="<svnuser>" --file="schema.xml"
  

• Situation 3: When the local system is connected to Junos Space Platform, but not to the DMI Schema repository, you can do the following:
  • Upload archived schema to Junos Space Platform by executing the following command:

    script python schemaInstall.py -o install-schemas --spaceuser="<spaceuser>"  --spaceurl="<spaceurl>" --archivefile="upload-tgz-schema-file.tgz" 

    where, upload-tgz-schema-file.tgz is the name of the archived schema file uploaded to Junos Space Platform.

    Note: You can obtain the upload-tgz-schema-file.tgz file by downloading it from the DMI repository and copying it to the local system.

Adding Missing DMI Schemas or Updating Outdated DMI Schemas by Using the Update Schema Menu

1. On the Junos Space Network Management Platform user interface, select Administration > DMI Schemas

   The DMI Schemas page appears.

2. Click the Update Schema icon on the toolbar.

   The Update Schema page appears.

   Note: On the Update Schema page, Junos Space Platform displays the schemas that you already have installed and, based on the discovered devices, suggests new schemas. However, you can pick other available schemas and download them.

3. Perform one of the following actions:
   • To update the DMI schema from an existing compressed TAR file:
     1. Select the Archive (tgz) option button.
     2. Click Browse.

        The File Upload dialog box appears.

     3. Select the compressed TAR file and click Open.

        The Update Schema page reappears, displaying the compressed TAR file in the Archived Schemas File field.

     4. Click Upload.

        Note: Do not navigate away from the Update Schema page while the compressed TAR file is being uploaded to Junos Space Platform. The time taken for the upload process depends on the number of schemas in the file. A progress bar indicates the percentage of the upload that has completed.

   • To update the DMI schema directly from the Juniper Networks DMI schema repository:
     1. Select the SVN Repository option button.

        If the access to the Juniper Networks DMI schema repository is already configured, the URL of the repository is displayed in the URL field. If the access is not configured, a note indicating that the access must be configured is displayed.

        To configure access to the Juniper Networks DMI schema repository:

        1. Click Configure.

           The SVN Access Configuration dialog box appears.

        2. In the SVN URL field, enter the URL of the Juniper Networks DMI schema repository (https://xml.juniper.net/dmi/repository/trunk/).
        3. In the User Name field, enter the user name to access the Juniper Networks DMI schema repository.
        4. In the Password field, enter the password to access the Juniper Networks DMI schema repository.
        5. In the Confirm field, reenter the password to access the Juniper Networks DMI schema repository.
        6. (Optional) The Proxy Server field displays whether a proxy server is configured or not. If your organization requires that you use a proxy server to connect to the Internet, you must configure and enable the proxy server (under Administration > Proxy Server) before connecting to the Juniper Networks DMI schema repository. For more information, see Configuring Proxy Server Settings.
        7. (Optional) Select the Auto Install Schema check box to automatically download any missing device schema or the latest version of any outdated schema from the DMI schema repository during device synchronization.

           Note: When the Auto Install Schema text box is selected, Junos Space Platform identifies the DMI schemas that are missing or that need update during device synchronization. The missing schemas are installed and outdated schemas in Junos Space Platform are updated when the job, scheduled to run every one hour, fetches the schemas from the DMI repository. If a schema is missing and auto-installation of the schema fails, no attempt to install the schema is made when the job runs the next time.

        8. (Optional) Click Test Connection.

           A message dialog box appears (after a few seconds or a few minutes depending on the connection) to indicate whether the connection is established successfully or not. Click OK to close the dialog box and return to the Svn Access Configuration dialog box.

        9. Click Save to save the settings that you configured.

           You are taken to the Update Schema page and the URL that you configured is displayed in the URL field.

     2. (Optional) From the Device Family drop-down list, select the device families that you want to download from the repository.

        Note: If you do not specify a device family, then available schemas from all families are listed.

     3. Click Connect.

        Junos Space Platform displays a message asking you to wait while the list of schemas is retrieved. (This process might take anywhere from a few seconds to a few minutes depending on the connection.)

   The available DMI schemas are displayed in a table under the Schema Availability label, as shown in Table 1.

   You can sort the schemas based on a specific column, choose which fields are displayed, or filter the list of schemas displayed.

   Table 1: Information Displayed About Available Schemas

   Column	Description
   Device Family	Name of the device family to which the DMI schema belongs; for example, junos-ex
   Release	Junos OS release version to which the DMI schema corresponds
   Date	Date on which the DMI schema was published If you uploaded a compressed TAR file, this field displays Unknown.
   Available	Indicates whether the schema is available (in the compressed TAR file or the Juniper Networks DMI schema repository) or not
   Installed	Indicates whether the schema is already installed on Junos Space or not
   Missing	Indicates whether the schema is a missing schema or not Missing schema versions are the OS versions on devices that Junos Space Platform discovers in your network, but have not been installed on Junos Space Platform.

4. (Optional) To overwrite a previously existing schema, select the Enable Schema Overwrite check box.

   By default, the DMI schemas that are previously installed are listed and are disabled. However, when you select this check box, you can select these schemas to be overwritten by the schemas from the repository or from your local system.

5. (Optional) To display only recommended schemas, select the Show recommended schemas only check box.
6. (Optional) To schedule a time for installing the DMI schema, select the Schedule at a later time check box and specify the date and time in the Date and time field.
7. Select the schemas from the list of schemas displayed in the table by clicking the check box corresponding to a schema.

   Note: If you have chosen to update only schemas for specific device families, then only those schemas belonging to the specific device families are listed.

8. Click Install.

   The Install DMI Schema Information dialog box appears displaying the job ID.

   Note: You can verify the status of the job by clicking the hyperlinked job ID in the Install DMI Schema Information dialog box. You are taken to the Job Management page.

9. Click OK.

   You are taken to the DMI Schemas page. After the DMI schema is installed, this page displays the newly installed schemas.

Note: Updating a schema automatically generates an audit log entry. You must set at least one schema as the default schema for each device family in your network. This is done automatically by Junos Space Platform as long as there is at least one schema for the device family. For more information, see Setting a Default DMI Schema .