Configuring Viptela Observer jobs

You use the Viptela Observer to load managed Viptela SD-WAN control plane, vEdge and their associated network resources, and then visualize this data as a topology view in the Agile Service Manager UI.

Before you begin

Important: The Viptela Observer supports Version 18.4.302 of Cisco SD-WAN.

Ensure you have the server details to hand, such as the username and password.

The Viptela Observer is installed as part of the core installation procedure.

About this task

The Viptela Observer targets the Cisco SD-WAN (or 'Cisco Viptela') system. A Viptela Observer job extracts server information and its associated network resources from Viptela via REST API. The observer loads and updates the resources and their relationships within the Agile Service Manager core topology service.

You define and start the following job.
Full Topology Upload job
By default, these jobs are one-off, transient jobs that carry out a full upload of all requested topology data when they are triggered.
You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when you configure them.

Procedure

To configure Viptela Observer jobs

  1. On the Observer jobs page, perform one of the following actions:
    To edit an existing job
    Open the List of options overflow menu next to the job and click View & edit.
    To create a new job
    Click Add a new job + and select the Viptela Observer tile.
  2. Configure the following parameters for the job, then click Save to save and run the job.
    Table 1. Viptela Load job parameters
    Parameter Action Details
    Unique ID Enter a unique name for the job. Required
    Data center name Specify the data center the vEdge runs in. Required. If you want to discover multiple vEdge locations or sets, then provide a different data center, for example EURDC01, USDC01.
    Cisco Viptela vManage host IP Enter the Cisco SD-Wan Viptela vManage host IP. Required
    Cisco Viptela API port. Specify the Cisco SD-Wan Viptela vManage API port. Required. The default value is 8443.
    Username to login to Cisco Viptela service Specify the Cisco SD-Wan Viptela vManage username. Required.
    Password for Cisco Viptela user Specify the Cisco SD-Wan Viptela vManage password. Required. Use plain text.
    Include the control plane data Select true to load the control plane data. Optional
    vEdge grouping preference for defined topology Specify the vEdge grouping preference for your topology. Optional.
    Supported grouping
    device-group (default)
    site-id
    Access scope

    Enter text to provide a scope for the resources.

    Access scope can help map alerts to resources when resources in different scopes share parameters, such as matchTokens.

    		 Optional.
    Tip: You can define access scope for locations, project names, namespaces, and so on.
    Generate debug support file
    Set the optional Generate debug support file parameter to True to capture the output of the next scheduled job run as a file. This file is stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated Support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to False after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. The file is saved to the following locations:
    On-premises
    $ASM_HOME/logs/<obs>-observer/
    On OpenShift Container Platform
    /var/log/itsm/<obs>-observer
    		 Optional
    Observer job description Enter additional information to describe the job. Optional
    Job schedule

    Specify when the job should run, and whether it should run at regular intervals.

    By default the job runs immediately, and only once.

    Optionally you can specify a future date and time for the job to run, and then set it to run at regular intervals after that.

    Optional. Transient (one-off) jobs only.

    If you set a job schedule, the run intervals must be at least 90 seconds apart. If you set them at less than 15 minutes, a warning is displayed, as the frequency can impact system performance.