Configuring NorthStar Settings Using the NorthStar CLI
Beginning with NorthStar Release 6.1.0, component-specific and service-specific NorthStar settings previously maintained in the northstar.cfg file are maintained in an internal cache and are configurable using the NorthStar CLI. The NorthStar CLI is very similar to the Junos OS CLI.
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
Accessing the NorthStar CLI
To access the NorthStar CLI:
After you successfully install NorthStar, log in to the NorthStar application server.
Launch the NorthStar CLI:
[root@ns]# /opt/northstar/utils/cmgd_cli root@ns>
The > prompt indicates you are in operational mode. In this mode, you can display the NorthStar configuration, but you cannot change it. For example:
root@ns> show configuration northstar config-server { health-monitor { heartbeat-interval 5s; poll-interval 10m; history-ttl 2d; heartbeat-holdown-timer 15s; } } path-computation-server { health-monitor { heartbeat-interval 5s; poll-interval 10m; history-ttl 2d; heartbeat-holdown-timer 15s; } } netconfd { in-memory-datastore { reconnect-delay 1000; reconnect-retries 10000; } } programmable-rpd-client { health-monitor { heartbeat-interval 5s; poll-interval 10m; history-ttl 2d; heartbeat-holdown-timer 15s; } enable-top-prefix-filter; publish-top-prefix-only; } root@ns1>Use the edit command to enter configuration mode (prompt changes to #):
root@ns> edit Entering configuration mode Users currently editing the configuration: root terminal pts/1 (pid 246) on since 2020-08-25 17:26:47 UTC, idle 1d 23:54 [edit] root terminal pts/2 (pid 262) on since 2020-08-26 23:05:31 UTC, idle 17:13:12 [edit] [edit] root@ns1#[edit] indicates the top of the command hierarchy.
All NorthStar configuration commands begin with set northstar. Enter set northstar with a question mark to display the NorthStar configuration command top level categories:
root@ns1# set northstar ? Possible completions: > analytics General configuration parameters related to analytics > config-server Config Server run time parameters > mladapter General configuration parameters related to ML Adapter. Common configuration parameters like amqp or database are taken from amqpSettings, but can be overridden for MLAdapter. > netconfd General configuration parameters related to netconfd > path-computation-server Path computation server run time parameters > peer-engineering General configuration parameters for IPE > programmable-rpd-client General configuration parameters related to the PRPD client > system > topology-server General configuration parameters related to the Topology Server. Common configuration parameters like amqp or database are taken from amqpSettings, but can be overridden for the Topology Server. [edit] root@ns1# set northstarContinue with any category and a question mark to see the next level breakdown. For example:
root@ns1# set northstar config-server ? Possible completions: > health-monitor Configuration parameters related to Health Monitor + include-interface-type The interfaces to be published by Config Server Space-separated list enclosed in [ ] or single interface type with no brackets. Indicates discovered interface types to be added to NorthStar. The following interface types are supported: - physical Physical interfaces : interface name without dot (.) in it - loopback-mgmt Loopback and management interfaces : interface name starting with lo, fxp, me and em - vrf-if Interfaces associated with VRF - links-if Interfaces on links - all all interfaces > log-destination List of logging configuration publish-aslink Enable ConfigServer to publish aslink created by getipconf to the Northstar model [edit] root@ns1# set northstar config-serverContinue in this fashion to reach a configuration setting and, if the command requires it, specify the value you wish to change. For example:
root@ns1# set northstar config-server include-interface-type ? Possible completions: [ Open a set of values all links-if loopback-mgmt physical vrf-if [edit] root@ns1# set northstar config-server include-interface-type [links-if physical] [edit] root@ns1#
Once you are familiar with the command hierarchy, you can navigate directly to a different level once you are in configuration mode. For example:
root@ns> edit Entering configuration mode Users currently editing the configuration: root terminal pts/0 (pid 162) on since 2020-09-05 17:08:10 UTC, idle 1d 07:59 [edit] [edit] root@ns# edit northstar system health-monitor [edit northstar system health-monitor] root@ns# set ? Possible completions: heartbeat-holdown-timer Health monitor holdown timer. Can be expressed as seconds ('s' or 'seconds'). Examples: 30s, 30seconds. (default=15s) heartbeat-interval Health monitoring heartbeat interval. Can be expressed as seconds ('s' or 'seconds'). Examples: 10s, 10seconds. (0 or -ve value = disabled, default=5s) history-ttl Health monitor history retention. Can be expressed as days ('d' or 'days'). Examples: 7d, 7days. (default=2d) poll-interval Health monitor poll interval. Can be expressed as minutes ('m' or 'minutes'). Examples: 4m, 4minutes. (default=10m) [edit northstar system health-monitor]
NorthStar Configuration Settings
Table 1 lists the NorthStar configuration settings most likely to require modification. It is not a complete listing of all available settings.
Setting |
Command |
Description |
|---|---|---|
port (NETCONF) |
set northstar netconfd device-connection-pool netconf port |
Use this command to change the default port for NETCONFD from 830. In some installations, port 22 is preferred. |
aggregate-by-prefix (Netflow collector) |
set northstar analytics netflowd aggregate-by-prefix |
By default, Netflow aggregates traffic by PE, but for some applications (such as IPE), you would want the traffic aggregated by prefix. If the parameter is enabled, Netflow aggregates all traffic from a specific ingress PE router to a specific destination (prefix) within the defined period of time. |
enable-ssl (Netflow collector) |
set northstar analytics netflowd enable-ssl |
Enables Secure Socket Layer (SSL). See Netflow Collector in the NorthStar Controller User Guide for more information. |
level (Netflow collector) |
set northstar analytics netflowd log-destination destination-name level |
Level of information that is captured in the log file. See Netflow Collector in the NorthStar Controller User Guide for more information. |
default-sampling-interval (Netflow collector) |
set northstar analytics netflowd default-sampling-interval |
The default sampling interval, if the router does not provide the interval in the Template FlowSet. See Netflow Collector in the NorthStar Controller User Guide for more information. |
publish-interval (Netflow collector) |
set northstar analytics netflowd publish-interval |
Publishing interval to both Elasticsearch and the PCS. Traffic is aggregated per publishing interval. See Netflow Collector in the NorthStar Controller User Guide for more information. |
workers (Netflow collector) |
set northstar analytics netflowd workers |
Number of worker processes to start. See Netflow Collector in the NorthStar Controller User Guide for more information. See Secondary Collector Installation for Distributed Data Collection for more information about distributed data collection. |
notify-final-bandwidth- on-inactive-flow (Netflow collector) |
set northstar analytics netflowd notify-final-bandwidth-on-inactive-flow |
If enabled, netflowd sends one final update after a flow is no longer active, reporting the bandwidth as 0. See Netflow Collector in the NorthStar Controller User Guide for more information. |
stats-interval (Netflow collector) |
set northstar analytics netflowd stats-interval |
Interval at which statistics are printed to the log file. See Netflow Collector in the NorthStar Controller User Guide for more information. |
generate-as-demands (Netflow collector) |
set northstar analytics netflowd generate-as-demands |
Enable the generation of AS demands by netflowd. See Netflow Collector in the NorthStar Controller User Guide for more information. |
polling-interval (Multilayer) |
set northstar mladapter polling-interval |
Controls the polling interval for interfaces without notification support. See Configuring the Multilayer Feature in the NorthStar Controller User Guide for more information. |
interval (Collection-cleanup) |
set northstar system scheduler tasks collection-cleanup interval |
Controls how often the collection-cleanup system task is run, in number of days. See NorthStar Analytics Raw and Aggregated Data Retention in the NorthStar Controller User Guide for more information. |
raw-data-retention- duration (Collection-cleanup) |
set northstar system scheduler tasks collection-cleanup raw-data-retention-duration |
Defines what is considered an “old” log of raw data in number of days. See NorthStar Analytics Raw and Aggregated Data Retention in the NorthStar Controller User Guide for more information. |
rollup-data-retention- duration (Collection-cleanup) |
set northstar system scheduler tasks collection-cleanup rollup-data-retention-duration |
Defines what is considered “old” aggregated data in number of days. See NorthStar Analytics Raw and Aggregated Data Retention in the NorthStar Controller User Guide for more information. |
interval (Rollup) |
set northstar system scheduler tasks rollup interval |
Sets how often the ESRollup system task is run in number of hours. See NorthStar Analytics Raw and Aggregated Data Retention in the NorthStar Controller User Guide for more information. |
lsp-latency-interval (Analytics) |
set northstar path-computation-server lsp-latency-interval |
Enables PCViewer to calculate LSP delay and display the data in the web UI. See Viewing Analytics Data in the Web UI in the NorthStar Controller User Guide for more information. |
include-interface-type (all tasks related to interfaces) |
set northstar config-server include-interface-type |
Interface types that can be discovered on devices and that are to be used by traffic collection. The supported interface types are:
Note:
configServer publishes to all components only the interface types that you specify. The web UI and data collection only receive information about interfaces representing those interface types. If you modify this setting, deselecting interface types that are already represented by interfaces in the NorthStar model, those existing interfaces remain in the model. |