NISH manager configuration files

The NISH manager provides the ability to place commonly used attributes into a configuration file that is provided when the NISH manager starts. The configuration file can be used when executing the NISH manager as an interactive process or as a Linux service.

Note: When a configuration file is provided, the user does not need to manually provide any variables on the command line. However, if variables are provided on the command line, they overwrite the variables provided in the configuration file.

After the NISH manager installation is completed, an example (and default) configuration file can be found in /etc/nish-manager/nish-manager.conf.

When executing the nish-manager command as a systemd service or as an interactive service, the configuration file must be placed in the /etc/nish-manager directory. This is the only location that the system checks for the file.

The following table describes the options that are supported in a NISH manager configuration file.

Table 1. Supported variables in NISH manager configuration file
Variable	Description	Multiple options per file
NISH_MANAGER_RETENTION	Time that an SR OS node or NISH client connection is retained as a valid node within the NISH manager without an update message, before it is expunged from the NISH manager	No
NISH_MANAGER_LISTEN_ ADDRESS	IPv4 or IPv6 address to which the NISH manager binds; if multiple addresses are required, multiple NISH_ MANAGER_LISTEN_ADDRESS lines must be provided, with one address per line Default is "::", which indicates to bind to all IPv4 and IPv6 addresses present on the system	Yes
NISH_MANAGER_LISTEN_ PORT	TCP port to which the NISH manager binds; if multiple ports are required, multiple NISH_MANAGER_ LISTEN_PORT lines must be provided with one port per line Default 57400 is used unless a NISH_ MANAGER_ LISTEN_PORT line is supplied	Yes
NISH_MANAGER_BACKUP_ FILE	Path to the filename that the NISH manager service reads from and writes to, for a persistent cache of connected SR OS nodes and NISH clients Default is /var/lib/nish-manager/connections.bkp	No
NISH_MANAGER_LOG_LEVEL	Logging verbosity level of the NISH manager process Default is "i" (informational)	No
NISH_MANAGER_CA_CERT	Path to the CA TLS certificate	No
NISH_MANAGER_SERVER_ CERT	Path to the server TLS certificate	No
NISH_MANAGER_SERVER_ KEY	Path to the service TLS key	No

It is permitted to provision multiple variables in the configuration file for the NISH manager listen address and listen port. The following table lists example address/port bindings when multiple variables are used in the configuration file.

Table 2. Example address to port bindings for configuration file variable
Example configuration file variables	Example address to port bindings
NISH_MANAGER_LISTEN_ADDRESS=1.1.1.1 NISH_MANAGER_LISTEN_PORT=57401 NISH_MANAGER_LISTEN_ADDRESS=2.2.2.2 NISH_MANAGER_LISTEN_PORT=57402	1.1.1.1:57401 1.1.1.1:57402 2.2.2.2:57402 2.2.2.2:57403