Defining Juniper CSO Observer jobs

Using the Juniper CSO Observer, you can define a full load job that will gather topology data from Juniper CSO. It is installed as part of the core installation procedure.

Before you begin

Important: The Juniper CSO observer supports the on-premise Juniper CSO version 4.1.0.

Ensure you have the Juniper CSO details to hand, such as details of the Juniper CSO API server and its credentials.

Remember: Swagger documentation for the observer is available at the following default location: https://<your host>/1.0/junipercso-observer/swagger

About this task

The Juniper CSO Observer retrieves topology data from Juniper CSO Release 4.1 via REST APIs exposed by CSO API server.

junipercso_observer_common.sh
The configuration file you use to customize Juniper CSO Observer settings.
The parameters defined here are then used by the junipercso_observer_load_start.sh script to trigger the Juniper CSO Observer jobs.
Tip: Alternatively, you can set the appropriate environment variables. If an environment variable is set, it takes precedence over the configuration file settings.
You define and start the following job. You must edit the parameters in the configuration file before running this job.
Load job
A transient (one-off) job that loads all requested topology data.
This job is started by the junipercso_observer_load_start.sh script and loads all supported resources.

Procedure

To edit the parameters in the configuration file

  1. Open the junipercso_observer_common.sh configuration file and edit (at least) the following parameters:
    cso_central_ms_url
    CSO host
    auth_url
    CSO authentication URL
    username
    CSO username
    password
    CSO password
    user_domain_name
    CSO’s domain name
    domain_project_tenant_name
    CSO domain or project or tenant to discover
    enable_secure_host_connection
    Enable secure CSO host connection.
    The default value is False.
    ssl_truststore_file
    SSL TrustStore file if you enable secure host connection
    password_ssl_truststore
    The SSL TrustStore password if you enable secure host connection
    For encryption: Run the encrypt_password.sh script in the ASM_HOME/bin directory:
    ./bin/encrypt_password.sh
    Enter and then confirm the password. The encryption utility returns an encrypted version.
    SSL requirements: To acquire SSL certificates and build SSL truststores, use the relevant instructions in the following section: Configuring observer job security

To start the Load job

  1. To start the Juniper CSO Observer Full Topology Upload job, use the following command:
    $ASM_HOME/bin/junipercso_observer_load_start.sh
    This job loads all requested topology data, and runs only once. Run this job whenever you need the Juniper CSO topology data refreshed.

What to do next

You can also use the following scripts:
junipercso_observer_load_stop.sh
Stops the Load job
junipercso_observer_job_list.sh
Lists the status of current jobs
junipercso_observer_log_level.sh
Sets the log level
Remember: As an alternative to being configured using the Observer Configuration UI, observer jobs have scripts to start and stop all available jobs, to list the status of a current job, and to set its logging levels. These scripts can be run with -h or --help to display help information, and with -v or --verbose to print out the details of the actions performed by the script, including the full cURL command. For the on-prem version of Agile Service Manager, observer scripts are configured for specific jobs by editing the script configuration files.