Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Modify Pathfinder Settings From the Pathfinder CLI

The component-specific Pathfinder settings previously maintained in the northstar.cfg file are maintained in an internal cache and can be modified by using the Pathfinder CLI. The Pathfinder CLI is very similar to the Junos OS CLI.

Note:

Certain bootstrap and infrastructure configuration settings continue to be maintained in the northstar.cfg file.

If you are not already familiar with the Junos OS CLI, see Junos OS CLI User Guide which covers:

  • Accessing operational and configuration command modes, and switching between modes.

  • The concept of command hierarchies.

  • Navigation among hierarchy levels.

  • Getting help on command syntax including how to display all possible completions for a partial command.

  • Helpful keyboard sequences including command completion shortcuts.

  • Committing or backing out of configuration changes.

You can also modify the Pathfinder settings from the GUI. See Modify Pathfinder Settings From the GUI.

Access the Pathfinder CLI

To access the Pathfinder CLI:

  1. After you successfully install Paragon Pathfinder, log in to the Pathfinder primary server.
  2. Launch the Pathfinder CLI:

    <pod-name> is the name of the pod where the Containerized Management Daemon (cMGD) is installed.

    To get the cMGD pod name in the cluster, run the following command:

  3. The > prompt indicates you are in operational mode. In this mode, you can display the Pathfinder configuration, but you cannot change it. For example:
  4. Use the edit (or configure) command to enter configuration mode (prompt changes to #):

    [edit] indicates the top of the command hierarchy.

  5. All Pathfinder configuration commands begin with set northstar. Enter set northstar with a question mark to display the Pathfinder configuration command top level categories:
  6. Continue with any category and a question mark to see the next level breakdown. For example:
  7. Continue in this fashion to reach a configuration setting and, if the command requires it, specify the value you wish to change. For example:
  8. Once you are familiar with the command hierarchy, you can navigate directly to a different level once you are in configuration mode. For example:

Modify Pathfinder Configuration Settings

Table 1 lists the Pathfinder configuration settings most likely to require modification. It is not a complete listing of all the available settings.

Note:

The following configuration settings are not supported currently. We strongly recommend that you do not modify these settings:

  • Analytics

  • Health Monitor

  • Peer Engineering

  • Some Topology Server settings: element-state-mask, element-type-mask, use-safe-mode, do-not-use-davinci-device-model
Table 1: Frequently-used Pathfinder Configuration Settings

Setting

Command

Description

port

(NETCONF)

set northstar netconf-connection-controller device-connection-pool netconf port

Change the default port for NETCONF from 830. In some installations, port 22 is preferred.

exec-pace-rate

(EPE)

set northstar peer-engineering egress application exec-pace-rate

Set the maximum rate (in calls per second) at which the egress peer engineering (EPE) Planner executes Pathfinder REST API calls that change the network.

Note:

Currently, this setting is not supported.

target-tag-cookie-range-start

(EPE)

set northstar path-computation-server bgp-steering target-tag-cookie-range-start

Set the starting number for path cookie allocation. EPE static routes added by Pathfinder are allocated an unused path cookie starting from the value specified here.

target-tag

(EPE)

set northstar path-computation-server bgp-steering target-tag

Set the target prefix for the PRPD filtering community.

polling-interval

(Multilayer)

set northstar mladapter polling-interval

Set the polling interval (in seconds) for interfaces without notification support.

lsp-latency-interval

(Analytics)

set northstar path-computation-server lsp-latency-interval

Set the interval (in seconds) for which the PCViewer calculates LSP delay and display the data in the Tunnels tab of the GUI (Network > Topology > Tunnels tab > View > Delay).

include-interface-type

(all tasks related to interfaces)

set northstar config-server include-interface-type

Set interface types that can be discovered on devices and that are to be used for traffic collection.

The supported interface types are:

  • physical: Physical interfaces, expressed as the interface name without a dot (.) in it.

  • loopback-mgmt: Loopback and management interfaces expressed as the interface name starting with lo, fxp, me, or em.

  • vrf-if: Interfaces associated with a VRF.

  • links-if: Interfaces on links.

  • all: All interfaces.

Note:

configServer publishes to all components only the interface types that you specify. The GUI and data collection only receive information about interfaces representing those interface types.

If you modify this setting by clearing interface types that are already represented by interfaces in the Pathfinder model, those existing interfaces remain in the model.

Related Documentation