Connections file

A NISH client operating in static mode uses a connections file. The connections file is a text file that contains the details of the SR OS nodes that are available within the NISH MD-CLI.

There are no requirements for the filename.

The following are required for the connection file:

• The NISH client must have access to the file location.

• The Linux user running the NISH client must have read permissions for the file.

The connections file defines a registration for each SR OS node. Each registration has the following fields:

id

The id field is the identifier string, which is usually the system name.

label

The label field may contain an optional device label, which can be used to add the node to a group; see Device labels for more information.

address

The address field consists of the IP address and port number to which the gRPC server on the SR OS node is bound. If a proxy server is used to facilitate IP address or port redirection, the IP address or port number of the proxy server can be entered.

The following example shows a connections file with one registration:

registration {
  id: "routername"
  label: "myLabel"
  address {
    address: "10.11.12.13"
    port: 57400
  }
}

Multiple devices are added in serial order within a connections file. The following example shows a connections file with two registrations:

registration {
  id: "test1"
  label: "UPF"
  address {
    address: "172.16.123.1"
    port: 57400
  }
}
registration {
  id: "test2"
  label: "CPF"
  address {
    address: "172.16.123.2"
    port: 57400
  }
}

After installation, there is an example connections file in /etc/nish/connections. The connections file can be edited at any time. The NISH client periodically reads the connections file and updates the list of nodes.