System management
This chapter contains procedures for setting up basic system management functions on SR Linux, including the hostname, domain name, DNS settings, and management network-instance. It contains examples of configuring an SSH server and FTP server, as well as NTP for the system clock, and enabling an SNMP server.
Configuring a hostname
The SR Linux device must have a hostname configured. The default hostname is
srlinux
. The hostname
typically
appears on all CLI prompts on the device, although you can override this with the
environment prompt CLI command.
The hostname
must
be a unique name on the network, and
it
can be a fully qualified domain name
(FQDN) or
an unqualified single-label name. If the hostname is a single-label name (for
example, srlinux
), the system may use its domain name, if
configured, to infer its own FQDN.
The following example shows the configuration for a hostname on the SR Linux device.
--{ candidate shared default }--[ ]--
# info system name
system {
name {
host-name 3-node_srlinux-A
}
}
Configuring a domain name
The SR Linux device uses its hostname, combined with a domain name, to form its FQDN. It is expected that the FQDN exists within the DNS servers used by SR Linux, though this is not a requirement.
Assuming the SR Linux FQDN is in the DNS server, you can use the FQDN to reach the SR Linux device without knowing its management address. A domain name is not mandatory, but if specified, it is added to the DNS search list by default.
The following shows the configuration for a domain name on the SR Linux device. In
this example, the device FQDN is set to
3-node_srlinux-A.mv.usa.nokia.com
.
--{ candidate shared default }--[ ]--
# info system name
system {
name {
host-name 3-node_srlinux-A
domain-name mv.usa.nokia.com
}
}
Configuring DNS settings
The SR Linux device uses DNS to resolve hostnames within the configuration, or for operational commands, such as ping. You can specify up to three DNS servers for the SR Linux device to use, with either IPv4 or IPv6 addressing.
You can also specify a search list of DNS suffixes that the device can use to resolve
single-label names; for example, for a search list of nokia1.com
and nokia2.com
, a ping for host srlinux
performs
a DNS lookup for srlinux.nokia1.com
, and if unsuccessful,
performs
a DNS lookup for srlinux.nokia2.com
.
The SR Linux device supports configuration of static DNS entries. Static DNS entries allow resolution of hostnames that may not be in the DNS servers used by the SR Linux device. Using a static DNS entry, you can map multiple addresses (both IPv4 and IPv6) to one hostname. The SR Linux linux_mgr application adds the static DNS entries to the /etc/hosts file in the underlying Linux OS.
In the following example, the SR Linux device is configured to use two DNS servers to resolve hostnames, a search list of DNS suffixes for resolving single-label names, and IPv4 and IPv6 static DNS entries for a host.
DNS requests are sourced from the mgmt network-instance (see Configuring the management network-instance).
--{ candidate shared default }--[ ]--
# info system dns
system {
dns {
network-instance mgmt
server-list [
192.0.2.1
192.0.2.2
]
search-list [
nokia1.com
nokia2.com
]
host-entry srlinux.nokia.com {
ipv4-address 192.0.2.3
ipv6-address 2001:db8:123:456::11:11
}
}
}
Configuring preferred source address for DNS requests
network-instance
with multiple
possible source addresses. The specified source IP address must belong to the network
instance where DNS is configured. You can configure the preferred
source-address
parameter as either an IPv4 or IPv6 address under
system.dns
.--{ candidate shared default }--[ ]--
#info system dns
system {
dns {
network-instance mgmt
source-address 192.168.12.1
server-list [
192.0.2.1
192.0.2.2
]
}
}
Configuring the management network-instance
The SR Linux device is primarily managed via a management network-instance. The management network-instance isolates management traffic from other network-instances configured on the device.
The out-of-band mgmt0
interface is automatically added to the
management network-instance, and management services run within the management
network-instance.
Although the management network-instance is primarily intended to handle management traffic, you can configure it in the same way as any other network-instance on the device, including protocols, policies, and filters. The management network-instance is part of the default configuration, but may be deleted if necessary.
Addressing within the management network-instance is available via DHCP and static IP addresses. Both IPv4 and IPv6 addresses are supported.
--{ candidate shared default }--[ ]--
# info network-instance mgmt
network-instance mgmt {
type ip-vrf
admin-state enable
description "Management network instance"
interface mgmt0.0 {
}
protocols {
linux {
export-routes true
export-neighbors true
}
}
}
Access types
Access to the SR Linux device is available via a number of APIs and protocols. The SR Linux supports the following ways to access the device:
-
Secure Shell (SSH)
SSH is a standard method for accessing network devices. See Enabling an SSH server.
-
File Transfer Protocol (FTP)
The FTP is a secure method for transferring files to and from network devices. See Configuring FTP.
-
console
The console provides access to the SR Linux CLI via direct connection to a serial port on the device.
-
gRPC Network Management Interface (gNMI)
gNMI is a gRPC-based protocol for the modification and retrieval of configuration from a target device, as well as the control and generation of telemetry streams from a target device to a data collection system. See gRPC server.
-
JSON-RPC
JSON-RPC is a protocol with the ability to retrieve and set configuration and state using a JSON-RPC API. See JSON-RPC server.
-
Simple Network Management Protocol (SNMP)
SNMP is a commonly used network management protocol. The SR Linux device supports SNMPv2 with a limited set of OIDs.
Regardless of the method of access, all sessions are authenticated (if authentication is enabled), whether the session is entered via the console, SSH, or an API. Access to the device is controlled via the aaa_mgr application. See Securing access.
Enabling an SSH server
You can enable an SSH server for one or more network instances on the SR Linux device so that users can log in to the CLI using an SSH client. The SR Linux device implements SSH via OpenSSH and configures /etc/ssh/sshd_config in the underlying Linux OS. Only SSHv2 is supported.
In the following example, an SSH server is enabled in the mgmt and default network-instances, specifying the IP addresses where the device listens for SSH connections:
--{ candidate shared default }--[ ]--
# info system ssh-server
system {
ssh-server {
network-instance mgmt {
admin-state enable
source-address [
192.0.2.1
192.0.2.2
]
}
network-instance default {
admin-state enable
source-address [
192.0.2.3
192.0.2.4
]
}
}
}
Configuring SSH key-based authentication
The SR Linux SSH server supports RSA public-private key and SSH certificate authentication, where an SSH client provides either a signed message that has been encrypted by a private key or a valid certificate that has been issued by a trusted authority. If the SSH client’s corresponding public key or certificate is configured on the SR Linux, the SSH server can authenticate the client using either RSA public key or SSH certificate method.
The SR Linux attempts to authenticate a user using public-key authentication first, then SSH certificates, and finally password authentication if the previous methods fail.
To configure SSH key-based authentication, you generate a public-private key pair, then add the public key to the SR Linux.
The following is an example of using the ssh-keygen utility in Linux to generate an RSA key pair with a length of 2048 bits:
# ssh-keygen -t rsa -b 2048
Generating public/private rsa key pair.
Enter file in which to save the key (/home/user/.ssh/id_rsa):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /home/user/.ssh/id_rsa.
Your public key has been saved in /home/user/.ssh/id_rsa.pub.
The key fingerprint is:
SHA256:RNVV8/XRVK7PhY2OJxa7rjkSUFqyVoj4pUXL2PDs7mI user@linux
The key's randomart image is:
+---[RSA 2048]----+
| .o+o. ...oo*|
| o.oB*.. +=|
| . .o@* +|
| Fo = |
| . .M . + o|
| .. = o.|
| .. = o o|
| E.. .o + |
| . ...o+o |
+----[SHA256]-----+
After generating the RSA key pair, you can add the public key to the SR Linux. The location for the public key depends on the type of user for which SSH key-based authentication is being configured:
-
For Linux users (see Linux users), you add the public key to the user’s $HOME/.ssh/authorized_keys file.
-
For users configured within the SR Linux CLI (see Local users), you add the public key to the SR Linux configuration file with a CLI command.
For example, the following CLI command configures a public key and password for the
SR Linux user srlinux
:
--{ candidate shared default }--[ ]--
# system aaa authentication user srlinux ssh-key
[ <public-key> ] password <password>
In the example, the <public-key>
has the format
ssh-rsa <key> <comment>
. If multiple public keys
are configured for a user, they are tried in the order they were configured.
SSH host keys
An SSH host key is generated when an SSH server is enabled for a network instance on an SR Linux device. This host key is the public key.
SSH clients store the public host keys of the servers to which they are connected.
A host key that is stored is referred to as a Known host key. The files /etc/ssh/known_hosts and .ssh/known_hosts present in the user's home directory, contain the host public keys for all the known hosts.
In SR Linux, the server-side keys are stored in /etc/ssh, and the filenames begin with ssh_host_[dsa/ecdsa/ed25519/rsa]_key. For information about host key authentication and preservation, see Host key authentication and preservation.
For information about SSH server host certificate configuration, see Configuring host certificate.
Host key authentication and preservation
When an SSH client connects to a server, the server offers its host key as identification. If this is the first time the user has connected to the server, the client prompts the user to accept the host key. After the user accepts the key, the host key and the host-name used to connect to the server gets appended to the list of known hosts. In subsequent connections to the same server, the SSH client expects the server to return the same host key.
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
Someone could be eavesdropping on you right now (man-in-the-middle attack)!
It is also possible that a host key has just been changed.
The fingerprint for the ED25519 key sent by the remote host is
SHA256:4xnagTqYdQyLGJl0XhvAvyBcrRL2nZ8vSRXTYfcIYe0.
Please contact your system administrator.
Add correct host key in /Users/test_user/.ssh/known_hosts to get rid of this message.
Offending ED25519 key in /Users/test_user/.ssh/known_hosts:74
Host key for 10.0.0.1 has changed and you have requested strict checking.
Host key verification failed.
The message suggests that the server may be pretending to be the intended server to intercept passwords or there could be a change in the host key.
Without correct verification techniques, a periodic change in an SSH host key is indistinguishable from a man-in-the-middle (MITM) attack. Users may be tempted to accept frequent warning messages without verifying them, which can increase the vulnerability to MITM attacks instead of reducing it.
To overcome this, you can enable the preserve
option for the SSH server
host key. This ensures the SSH server host keys in /etc/ssh are
preserved and restored after a system reboot or SSH server restart. When the
preserve
option is not enabled, the SSH server host key remains
valid only until the node is restarted or the SSH server is stopped and restarted.
This feature is non-backward compatible in releases before 23.7.
For information about enabling the preserve
option to prevent SSH host
key regeneration upon reboot, see Preserving SSH host key.
Preserving SSH host key
To prevent SSH server host key regeneration upon reboot, set the
preserve
option for SSH under system ssh-server
host-key.
The following example sets the preserve
option for SSH:
--{ * candidate shared default }--[ ]--
# info system ssh-server host-key
system {
ssh-server {
host-key {
preserve true
}
}
}
-
When
preserve
option is set to true, the SSH server host keys in /etc/ssh are saved and restored after a system reboot or SSH server restart. -
When
preserve
option is set to false, the SSH server host keys in /etc/ssh are removed and regenerated on each system reboot or SSH server restart .
SSH certificates
The SR Linux SSH server supports RSA public-private key and SSH certificate authentication.
When using public key cryptography for authentication, the public key from every client must be copied to every server that the client intends to log into. This type of authentication method does not scale well and requires significant administrative effort to maintain.
As an alternative, OpenSSH supports the creation of simple SSH certificates and associated CA infrastructure. Using a public key from a certificate authority (CA) to authenticate client certificates removes the need to copy keys between multiple systems.
The SSH certificates are signed with a standard SSH public key using the ssh-keygen utility. The utility supports two types of certificates: user and host certificates. User certificates authenticate users to servers, while the host certificates authenticate server hosts to users.
If a user has both an RSA public key and an SSH certificate set up for authentication, the SSH client tries the public key first, and then the certificate.
- Create a CA key pair and configure the CA public key (trust-anchors) on the SSH server. See Configuring CA public key (trust-anchors).
- Create a user SSH certificate, sign it with the CA private key and SSH principal, and configure an SSH principal for each user. See Configuring SSH principals.
- Create a host SSH certificate, sign it with the CA private key, and configure the SSH host certificate on the SSH server, see Configuring host certificate.
- Set up CA public key as the
cert-authority
for all client nodes. See Trusting CA public key. - Configure a revoked public user key list. See Configuring revoked key list.
Configuring CA public key (trust-anchors)
SR Linux allows the configuration of CA public keys, also known as trust-anchors, to
verify SSH certificates. The SSH certificates are used by the sshd
service to authenticate clients (users) connecting via SSH. The CA signing key pair
(CA public and private key) is generated by running the ssh-keygen
command on a server designated as the CA machine.
Generate CA
The following example generates CA signing key pair.ssh-keygen -f ca
Generating public/private rsa key pair.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in ca
Your public key has been saved in ca.pub
The key fingerprint is:
SHA256:GjGiO2dJV2tKBcuCjC5skMn8cfJ/iToZ/4oR/F0hhAE user@node
The key's randomart image is:
+---[RSA 3072]----+
| Eo.o. |
|o= . . +. |
|=oooo.= o. . |
|+ ..*o = .. . |
|.+...++ S . |
|o o =+=o o |
| o +.*+ + |
| + o+.. |
| o..o. |
+----[SHA256]-----+
Configure trust-anchors
The following example configures thetrust-anchors
that verifies the SSH
certificates. The trust-anchors
configuration is a global-setting and
is applicable to all SSH servers.--{ candidate shared default }--[ ]--
# info system ssh-server trust-anchors
system {
ssh-server {
trust-anchors [
"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCujqWgz360aQ6y+7pp3oKjofkbQFvbPjr9g0jV2xyOCBjidFH8Czr9QaasfFRIHDFxeydNu/Jt2HtQhLekrUQ8oKjArytR72pLreMzc7tITGDdQuGNZDVNwEefeCbjXrJ2LPi+fFwvZBoFM7BNYn/Hx4HEHeGyFKGZ5RStx/bMiMW2xVwyfhR/s5wKqXV/kUsxQlyWJEKdjLhRzBbDqDNr3alOJtgEhOQcD6kG7nCMKdXspjie2Tjha1khs7Ecg/ff8t/Qgf43H4E/imP0v1HJHsiqBgtZxK3wE7TiGDNY8d2LQJblNspzhLe4QOdqwficozk9QkIodQawWMgcf3UXiKz/akH0ZJVjIc7ETsbC9PgxM0JmXgHVkakq37ExPLkGXV2dEQ3lJhkcC8Kqa+guHqyxF7ETw4SOnDxKfdROfUnouYgVLDpwhIHXRDzvBOPtu5OH9iK0adf2ceQu7wcQAmGuBzWAWKqZlNKb9JfNCpAlvdTGpxGEGBmXEl46r3E= user@node"
]
}
}
Configuring SSH principals
SR Linux allows configuration of SSH principals for users.
A client machine generates a user certificate using the ssh-keygen
tool and signs it with the CA certificate and SSH principal value.
The following is an example of a signed user certificate (srl-user1-cert.pub) with SSH principals.
--{ candidate shared default }--[ ]--
# ssh-keygen -L -f srl-user1-cert.pub
srl-user1-cert.pub:
Type: ssh-rsa-cert-v01@openssh.com user certificate
Public key: RSA-CERT SHA256:LBPq+l+ksZi++61XoVFGch5Sf3xrksQ5mY70TR3iai4
Signing CA: RSA SHA256:GjGiO2dJV2tKBcuCjC5skMn8cfJ/iToZ/4oR/F0hhAE (using rsa-sha2-512)
Key ID: "srl-user1"
Serial: 0
Valid: forever
Principals:
admin
Critical Options: (none)
Extensions:
permit-X11-forwarding
permit-agent-forwarding
permit-port-forwarding
permit-pty
permit-user-rc
When a user logs into the server over SSH, the user certificate is checked against a list of configured principals. The server authenticates the client over SSH only if the following conditions are met: the client’s certificate is verified, the client’s username matches, and the client’s certificate has a principal that is configured on the server. A single user (client) certificate can match multiple principals, and multiple principals can match a single user.
You can configure SSH principals under
system.aaa.authentication.user{}
.
srl-user1
) with role
admin
, and ssh-principal allowing admin
.
--{ candidate shared default }--[ ]--
# info system aaa authentication user srl-user1
system {
aaa {
authentication {
user srl-user1 {
role [
admin
]
ssh-principals [
admin
]
}
}
}
}
Configuring host certificate
certificate
) under
system.ssh-server.host-key
. The host
certificate refers to the host key signed with a CA private key. For more information
about SSH host keys, see SSH host keys. In SR Linux, the
server-side keys are stored in /etc/ssh, and the filenames begin
with ssh_host_[dsa/ecdsa/ed25519/rsa]_key. The
certificate
configuration is a global setting and applicable to all
SSH servers. You must configure the host to present the certificate during user login. preserve
option set to true
. This ensures the SSH
server host keys in /etc/ssh are preserved and restored after a
system reboot or SSH server restart.
--{ candidate shared default }--[ ]--
# info system ssh-server host-key
system {
ssh-server {
host-key {
certificate ssh-rsa-cert-v01@openssh.com AAAAHHNzaC1yc2EtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgz2nzyiDaRws9fN3/p8iFd5iq40Twp4eVAQMAOSwkNAMAAAADAQABAAABgQC7UC4GHVIV/2CY9fgxUizgN+jaFUgkT2jtaE6f/B7s885JbOiQYp19ltGhbqlrZQDcK+gtYjAnJ9wOSJKDg5dyY9HgTPWiRbRzoy3oNp7QSVwEQds8HznOP8odIWWRrHzDl9GvbTTaH2Vy5qYkHubAmnW8XSkQS6jiP0nlcpfGVn/x04FkZZQG8eofQ5RNwvd570YpaxAlKgR4xrDVbi7r65GVm3PCdfRBry9D/L9jAmc1Svc6WcqQG17ZOxo87IXbBxLqEs3zcc44rN+UQ76Em0ictx1K0wgemDdJrevkNQ8YPTMuiPFYEfJWoE3DpSOdTfItgdafcJUfLtYrcWksZNuUFmlFhgqb1wRIABPNgrwU9YbtldENJnOPxURaPgYkt6dDebsAWuIlCREf6XSQzbqVpBAo3YmkRAIRW8Ds/8ZDd6TzmiEp8J00aD0/JlZJEZ53wxABO+rzZiLzO+BXOLJUblyW25Gi3G3AGEu+H8xLWu/MFXUAf+LgxTnjraMAAAAAAAAAAAAAAAIAAAARY2xhYi1zc2hfdGVzdC1zcmwAAAAVAAAAEWNsYWItc3NoX3Rlc3Qtc3JsAAAAAAAAAAD//////////wAAAAAAAAAAAAAAAAAAAZcAAAAHc3NoLXJzYQAAAAMBAAEAAAGBAK6OpaDPfrRpDrL7umnegqOh+RtAW9s+Ov2DSNXbHI4IGOJ0UfwLOv1Bpqx8VEgcMXF7J0278m3Ye1CEt6StRDygqMCvK1Hvakut4zNzu0hMYN1C4Y1kNU3AR594JuNesnYs+L58XC9kGgUzsE1if8fHgcQd4bIUoZnlFK3H9syIxbbFXDJ+FH+znAqpdX+RSzFCXJYkQp2MuFHMFsOoM2vdqU4m2ASE5BwPqQbucIwp1eymOJ7ZOOFrWSGzsRyD99/y39CB/jcfgT+KY/S/UckeyKoGC1nErfATtOIYM1jx3YtAluU2ynOEt7hA52rB+JyjOT1CQih1BrBYyBx/dReIrP9qQfRklWMhzsROxsL0+DEzQmZeAdWRqSrfsTE8uQZdXZ0RDeUmGRwLwqpr6C4erLEXsRPDhI6cPEp91E59Sei5iBUsOnCEgddEPO8E4+27k4f2IrRp1/Zx5C7vBxACYa4HNYBYqpmU0pv0l80KkCW91ManEYQYGZcSXjqvcQAAAZQAAAAMcnNhLXNoYTItNTEyAAABgFVR+2y3659XN7uTLL6i+LFkcU76u8OTwZl2pKPZRurBqfQC9bLuQSmawfxmGAzg5emMzqcafGelwZeIuQjmUCSlNDyH+Yhsw6MMkadl2YIfuFFu/zzIX3fF2reSfAPTPKkbZrijclYxo9H9gqWBGJF+A0f848gk3fCATwq6JM4F3q4J0lRibQBulOuvXVm3GZVWqHou9rpHOL0aGWhuDjTaq5/oZ+tv4X+hfrCKmkacesNeX4wNn6k3JBFVLnNxdPDwAlOcSmvPqmZHa8R6e+qvu5B44YSVmlAHsaUyYHDbVjH6HhzKoXGTlv3iMoNl/bWNkiCS+u4Licleh0pqhinsIi8FtdVpEXQW+unqd93XQ/hAuvxZ9ia0gugkGMQixGlbPfFTaQqkZBbv0r+S44NpsSVPOiYw6bJ/iHZM4zFHK6l2+eGgJ4p/kx/3TSO10fHK/NaoFiZLws4geYpl3YZfxmk/KKWBctv7tlv/ySzavQQJRg+SvbH9FibEFiRHqQ== user@node
preserve true
}
}
}
Trusting CA public key
echo "@cert-authority * $(cat ca.pub)" >> ~/.ssh/known_hosts
where,
- ca.pub: references the public key of the signing CA.
- *: specify the server being connected to or a glob value ("*.example.com","*.mydomain.com"
CA keys can be marked as trusted globally in the /etc/ssh/known_hosts file or per-user in the ~/.ssh/known_hosts file.
Configuring revoked key list
SR Linux provides an option to configure revoke key (revoked-keys
)
list under .system.ssh-server
. A list of user public keys that must
be invalidated is called a revoke list. Each line in the revoke list contains one
public key. If a user's public key is listed in the revoke list, the server rejects
the connection when the user tries to connect using SSH.
--{ candidate shared default }--[ ]--
# info system ssh-server revoked-keys
system {
ssh-server {
revoked-keys [
"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDPlZ4/NVdfAgaUcA2Mepy/tOYvWWhiYOmPscWzvG8+aj9Ssj88pmJGb0r/e3FBYxEK8Bj1Mjar7GNbUXOt3NvCLjcPo6i/xxdouA+N8RmxpbPFLsLC6JwZq5IkNoxdJ9PLUNz+cgLOY2XiLjgrUOsCT02SOn/mjcIAxzFkqmf9eLNW9CLqBW7hVCVwHpzj4Ep814MmJBXZX9llGVj1sule+ajfUxotlChyScF3Nbd+h+YMvfAgngFRuCebMG6n2vr+zRlB/TRQibAO5fKoi/GEuntnv4f/iaNLhlRQitIDzXFNW7xx5yIer30FnYf6u5y1ijA5XJwHb9EosRjoM7PBYhdC6XESuyS7gOji3/l/wQfLZ7twMLB5MxUL4aB5SnaRlkYX14GyIdpsvtoe8mfsy011PqMWmQjZ8lm2eUHN+68UNBodMmzGLS9I11a1YODydV9gLD3WwgHxGQ1vOrGvp401S4HF26gAXrAr2QblQ7tJtq+34Fvz8O0YnplvCoU= user@node"
]
}
}
Viewing an SSH certificate
# ssh-keygen -L -f
- L: lists the content of the certificate
- f: specifies the path to the signed certificate
The SSH certificate formats and semantics are as per the specification defined in PROTOCOL.certkeys.
Viewing an user SSH certificate
The following command displays the user SSH certificate. User SSH certificate is used to authenticate users to servers.
# ssh-keygen -L -f user1-cert.pub
user1-cert.pub:
Type: ssh-rsa-cert-v01@openssh.com user certificate
Public key: RSA-CERT SHA256:LBPq+l+ksZi++61XoVFGch5Sf3xrksQ5mY70TR3iai4
Signing CA: RSA SHA256:GjGiO2dJV2tKBcuCjC5skMn8cfJ/iToZ/4oR/F0hhAE (using rsa-sha2-512)
Key ID: "user1"
Serial: 0
Valid: forever
Principals:
admin
Critical Options: (none)
Extensions:
permit-X11-forwarding
permit-agent-forwarding
permit-port-forwarding
permit-pty
permit-user-rc
Viewing a host SSH certificate
The following command displays the host SSH certificate. Host SSH certificate is used to authenticate server hosts to users.
# ssh-keygen -L -f ssh_host_rsa_key-cert.pub
ssh_host_rsa_key-cert.pub:
Type: ssh-rsa-cert-v01@openssh.com host certificate
Public key: RSA-CERT SHA256:NgxyhWgpt4BX+eglv10JVZyweD7DAdjGs0ygBHzR7Ko
Signing CA: RSA SHA256:GjGiO2dJV2tKBcuCjC5skMn8cfJ/iToZ/4oR/F0hhAE (using rsa-sha2-512)
Key ID: "srl"
Serial: 0
Valid: forever
Principals:
srl
srl.local
Critical Options: (none)
Extensions: (none)
Configuring FTP
You can enable an FTP server for one or more network-instances on the SR Linux device so that users can transfer files to and from the device. The SR Linux uses the vsftpd (very secure FTP daemon) application within the underlying Linux OS. The authenticated user's home directory returned by the aaa_mgr application is set as the user's FTP root directory.
In the following example, the FTP server is enabled in the mgmt and default network-instance, specifying the IP addresses where the device listens for FTP connections:
--{ candidate shared default }--[ ]--
# info system ftp-server
system {
ftp-server {
network-instance mgmt {
admin-state enable
source-address [
192.0.2.1
]
}
network-instance default {
admin-state enable
source-address [
192.0.2.4
]
}
}
}
Configuring banners
You can specify banner text that appears when a user connects to the SR Linux device. The following banners can be configured:
-
login banner – displayed before a user has been authenticated by the system (for example, at the SSH login prompt)
-
message of the day (motd) banner – displayed after the user has been authenticated by the system
The banners appear regardless of the method used to connect to the SR Linux, so they are displayed to users connecting via SSH, console, and so on.
In the following example, login and motd banners are configured. The login banner text appears at the prompt when a user attempts to log into the system, and the motd banner text appears after the user has been authenticated.
--{ candidate shared default }--[ ]--
# info system banner
system {
banner {
login-banner "Enter your SR Linux login credentials."
motd-banner "Welcome to the SR Linux CLI. Your activity may be monitored."
}
}
Synchronizing the system clock
Network Time Protocol (NTP) is used to synchronize the system clock to a time reference. You can configure NTP settings on the SR Linux device using the CLl, and the SR Linux linux_mgr application provisions the settings in the underlying Linux OS.
NTP does not account for time zones, instead relying on the host to perform such computations. Time zones on the SR Linux device are based on the IANA tz database, which is implemented by the underlying Linux OS. You can specify the time zone of the SR Linux device using the CLI. The NTP server used in the system NTP client configuration can be IP address-based or hostname-based.
Enabling an NTP client with an IP address-based NTP server
The following example enables the NTP client on the SR Linux device and sets an IP address-based NTP server for clock synchronization. The NTP client runs in the mgmt network-instance. The system time zone is set to America/Los_Angeles.
The example uses an IP address for the NTP server.
--{ candidate shared default }--[ ]--
# info system ntp
system {
ntp {
admin-state enable
network-instance mgmt
server 4.53.160.75 {
}
}
}
Enabling an NTP client with a hostname-based NTP server
The following example enables the NTP client on the SR Linux device and sets a hostname-based NTP server for clock synchronization.--{ candidate shared default }--[ ]--
# info system ntp
system {
ntp {
admin-state enable
network-instance mgmt
server srlinux.nokia.com {
}
}
}
- DNS configuration is mandatory for this to function correctly. A missing configuration does not prevent configuration; however, the NTP session to that server can only become active when DNS is functioning correctly.
-
The network-instance of the NTP server and DNS must be the same.
Configuring preferred source address for NTP requests
SR Linux allows you to specify the preferred source address when acting as an NTP
client in
a network-instance
with
multiple possible source addresses. The specified source IP address must belong to
the network instance where NTP is configured. You can configure the preferred
source-address
parameter as either an IPv4 or IPv6 address
under system.ntp
.
In this example, NTP requests are sent to the configured NTP servers using the source address of 4.53.160.75.
--{ candidate shared default }--[ ]--
# info system ntp
system {
ntp {
network-instance mgmt
source-address 4.53.160.75
server 129.6.15.28 {
}
server 216.239.35.0 {
}
}
}
Configuring SNMP
To configure SNMP, enable an SNMP server on one or more network-instances. The SR Linux device supports SNMPv2. The MIB file that covers these OIDs is packaged with each release.
See the SR Linux System Management Guide for the procedure for configuring an SNMP server.
IP ECMP Load Balancing
Equal-Cost Multipath Protocol (ECMP) refers to the distribution of packets over two or more outgoing links that share the same routing cost. Static, IS-IS, OSPF, and BGP routes to IPv4 and IPv6 destinations can be programmed into the datapath by their respective applications, with multiple IP ECMP next hops.
The SR Linux load-balances traffic over multiple equal-cost links with a hashing algorithm that uses header fields from incoming packets to calculate which link to use. When an IPv4 or IPv6 packet is received on a subinterface, and it matches a route with a number of IP ECMP next hops, the next hop that forwards the packet is selected based on a computation using this hashing algorithm. The goal of the hash computation is to keep packets in the same flow on the same network path, while distributing traffic proportionally across the ECMP next hops, so that each of the N ECMP next hops carries approximately 1/Nth of the load.
The hash computation takes various key and packet header field values as inputs and returns a value that indicates the next hop. The key and field values that can be used by the hash computation depend on the platform, packet type, and configuration options, as follows:
On 7250 IXR systems, the following can be used in the hash computation:
- For IPv4 TCP/UDP non-fragmented packets: user-configured hash-seed (0 to 65535; default 0), source IPv4 address, destination IPv4 address, IP protocol, L4 source port, L4 destination port. The algorithm is asymmetric; that is, inverting source and destination pairs does not produce the same result.
- For IPv6 TCP/UDP non-fragmented packets: user-configured hash-seed (0 to 65535; default 0), source IPv6 address, destination IPv6 address, IPv6 flow label (even if it is 0), IP protocol (IPv6 next-header value in the last extension header), L4 source port, L4 destination port. The algorithm is symmetric; that is, inverting source and destination pairs produces the same result.
- For all other packets: user-configured hash-seed (0 to 65535; default 0), source IPv4 or IPv6 address, destination IPv4 or IPv6 address.
On 7220 IXR-D1, D2, D3 and 7220 IXR-H2 and H3 systems, the following can be used in the hash computation:
- For IPv4 TCP/UDP non-fragmented packets: VLAN ID, user-configured hash-seed (0 to 65535; default 0), source IPv4 address, destination IPv4 address, IP protocol, L4 source port, L4 destination port. The algorithm is asymmetric.
- For IPv6 TCP/UDP non-fragmented packets: VLAN ID, user-configured hash-seed (0 to 65535; default 0), source IPv6 address, destination IPv6 address, IPv6 flow label (even if it is 0), IP protocol (IPv6 next-header value in the last extension header), L4 source port, L4 destination port.
- For all other packets: user-configured hash-seed (0 to 65535; default 0), source IPv4 or IPv6 address, destination IPv4 or IPv6 address.
Configuring IP ECMP load balancing
To configure IP ECMP load balancing, you specify hash-options that are used as input fields for the hash calculation, which determines the next hop for packets matching routes with multiple ECMP hops.
The following example configures hash options for IP ECMP load balancing, including a hash seed and packet header field values to be used in the hash computation.
--{ * candidate shared default }--[ ]--
# info system load-balancing
system {
load-balancing {
hash-options {
hash-seed 128
ipv6-flow-label false
}
}
}
If no value is configured for the hash-seed, the default value is 0. If a hash-option is not specifically configured, the default is true.
On 7250 IXR systems, if source-address is configured as a hash option, the destination-address must also be configured as a hash option. Similarly, if source-port is configured as a hash option, the destination-port must also be configured as a hash option.
Powering down the system
The SR Linux device does not feature a power switch. If you need to power down the device, use the following procedure.
-
Enter the CLI command to reboot the system.
# tools platform chassis reboot
- When the GRUB menu appears, remove the power cables from the PSUs.
Configuring reboot options
You can perform a reboot using the command
.tools.platform.<component>{.slot}
in CLI. The reboot command is
supported for all platform components, namely chassis, control
(active/standby),
fabric, and linecard slots.
This command triggers an immediate reboot.
- chassis: tools platform chassis reboot
- control slot: tools platform control <slot> reboot
- fabric slot: tools platform fabric <slot> reboot
- linecard slot: tools platform linecard <slot> reboot
delay
- chassis:
tools platform chassis reboot delay <value>
# tools platform chassis reboot delay 2 /platform: chassis will reboot in 2 seconds
- control slot: tools platform control <slot> reboot delay <value>
- fabric slot: tools platform fabric <slot> reboot delay <value>
- linecard slot: tools platform linecard <slot> reboot delay <value>
When doing a warm redundancy CPM switchover, any pending delayed reboot of active or
standby control card is discarded. The command
.tools.platform.redundancy.switchover
is not impacted by any
pending delayed reboots.
cancel
- chassis: tools platform chassis reboot delay cancel
# tools platform chassis reboot cancel The chassis reboot has been canceled /platform: chassis reboot has been canceled
- control slot: tools platform control <slot> reboot cancel
- fabric slot: tools platform fabric <slot> reboot cancel
- linecard slot: tools platform linecard <slot> reboot cancel
force
You can use the force option to trigger a force reboot of a platform component. This option is supported only for the chassis and control slots. The force option overrides all synchronization activities, and any soft checks that prevent a reboot (for example, the unsaved configuration between running and startup) are ignored.
- chassis: tools platform chassis reboot force
- control slot: tools platform control <slot> reboot force
message
You can use the message option to broadcast a user-defined message to other users before the reboot occurs. The message option can be used with reboot types of immediate, cancel, or delay.
- chassis: tools platform chassis reboot message <value>
# tools platform chassis reboot message "This is a message" chassis is rebooting now: "This is a message"
- control slot: tools platform control <slot> reboot message <value>
- fabric slot: tools platform fabric <slot> reboot message <value>
- linecard slot: tools platform linecard <slot> reboot message <value>
-
Immediate reboot with the message option.
A message indicating the initiation of an immediate reboot is broadcast to all users only if the immediate reboot command is executed with the message option.# tools platform chassis reboot message "this is a message" chassis is rebooting now: "this is a message"
- Delayed reboot with the message
option.
A message indicating the reboot delay is broadcast to all users only if the reboot delay command is executed with the message option.# tools platform control A reboot delay 100 message "this is a message" control slot A is rebooting in 100 seconds (at 2023-01-24T01:45:20.556Z): "this is a message" /platform/control[slot=A]: control slot A will reboot in 100 seconds
- When a pending delayed reboot is executed for an active control card or the
chassis, the user-defined message is broadcast, and the prompt is also updated
accordingly.
# tools platform control A reboot delay 3600 message "control reboot message" /platform/control[slot=A]: control slot A will reboot in 3600 seconds --{ [ACTIVE CONTROL REBOOT IN 3599 SECONDS (control reboot message)] running }--[ ]--
# tools platform chassis reboot delay 3600 message "reboot message" /platform: chassis will reboot in 3600 seconds --{ [SYSTEM REBOOT IN 3599 SECONDS (reboot message)] running }--[ ]--
-
Canceling a delayed reboot with the message option.
#tools platform linecard 1 reboot cancel message "this is a cancel message" linecard slot 1 reboot has been canceled: "this is a cancel message" /platform/linecard[slot=1]: linecard slot 1 reboot has been canceled
The preceding command cancels all the pending delayed reboots and broadcasts the user-defined message. A message indicating the reboot cancel is broadcast to all users only if the reboot cancel command is executed with the message option.
- When a delayed reboot time expires and the reboot is about to happen, the
following message is broadcast:
chassis: chassis is rebooting now control: control slot <A or B> is rebooting now linecard: linecard slot <x> is rebooting now fabric: fabric slot <x> is rebooting now
Note: This message is broadcast irrespective of executing the reboot delay command with or without the message option. - When a delayed reboot fails, the following message is
broadcast:
chassis: chassis reboot failed: "<reason for failure>" control: control slot <A or B> reboot failed: "<reason for failure>" linecard: linecard slot <x> reboot failed: "<reason for failure>" fabric: fabric slot <x> reboot failed: "<reason for failure>"
Note: This message is broadcast irrespective of executing the reboot delay command with or without the message option. When a delayed reboot is pending for a component, and a reboot (delay or immediate) is attempted for a chassis or active control, the reboot gets rejected with the following message:
This example shows a reboot attempted on a linecard when control A is active.chassis: disallowed, delayed reboot is pending for linecard slot 1 active control slot A: disallowed, delayed reboot is pending for linecard slot 1
Note: The error message lists only the first found component with a delayed reboot pending. In this example, if all linecards <1 to 4> are pending delayed reboots, the error message highlights only the pending reboot for linecard1.-
When a delayed reboot is pending for a chassis or active control, and a reboot (delay or immediate) is attempted for any other platform component, the reboot gets rejected with the following error message.
This example shows a reboot attempted on a fabric slot when a reboot is pending for the active control module A.
This example shows a reboot attempted on a fabric slot when reboot is pending for chassis component.fabric slot <x>: disallowed, delayed reboot is pending for control slot A
fabric slot <x>: disallowed, delayed reboot is pending for chassis
- While a delayed reboot is pending for a component, and a reboot (delay or immediate) is attempted for the same platform component, the reboot gets rejected with a message indicating that the pending delayed reboot must first be cancelled.
- When the wait time specified for the reboot delay exceeds the maximum delay
limit, the delayed reboot command gets executed and the following message is
displayed:
# tools platform linecard 1 reboot delay 18446744073709551615 /platform/linecard[slot=1]: delay has been limited to 16772217903 seconds /platform/linecard[slot=1]: linecard slot 1 will reboot in 16772217903 seconds
warm
When you execute the reboot command with the warm option, it validates the current configuration and prompts reboot confirmation. On confirming, the system reboots without impacting the datapath. If a warm reboot is performed after a new image is configured, the system upgrades to the new image.
Before performing a warm reboot, you must confirm if the current SR Linux configuration and state supports warm reboot. Use the tools platform chassis reboot warm validate command.
--{ running }--[ ]--
A:# tools platform chassis reboot warm validate
/platform:
Warm reboot validate requested
/:
Success
If the validation is successful, proceed with the warm reboot.
--{ running }--[ ]--
A:# tools platform chassis reboot warm force
/platform:
Warm reboot force requested
/:
Success
See the
Configuration
state
support
section in the
SR Linux
Software Installation Guide for information about how to
use warm reboot during an ISSU.
Non-stop forwarding
Non-stop forwarding, or NSF, is the sequence of processes required to effectively switch control of a running system between two supervisors or CPMs (active/standby), without disrupting the data forwarding. It allows the router to continue forwarding data with previously known route/state information, while the control plane restarts and re-converges.
Similar to system warm reboot, NSF depends on graceful restart helpers, but it is primarily used for unplanned outage (for example, control plane failover) and cannot be used for upgrades.
During an NSF switchover, no control plane or management plane functions are available, including refreshing of neighbors, and slow path functions like DHCP relay and responding to ARP/ND.
In SR Linux, NSF leverages application warm restart, with the fundamental design to
synchronize the IDB server (idb_server
) with the standby CPM
(supervisor), and to allow applications to leave their state information in IDB during
the restart, then recover it after the restart. For more information, see Triggering redundancy switchover and Forcing redundancy synchronization.
Currently, the NSF feature is supported only for 7250 IXR-6/10/6e/10e platforms.
NSF features and limitations
- Supports ACL, IPv4, and IPv6
- Supports complete QoS feature set including queue configuration, classifiers, ECN with counters cleared.
- Supports IPv4/IPv6 routing.
- Supports BGP with IPv4/IPv6-unicast address families, where all neighboring
devices support graceful restart helper. Note: Peers who do not support graceful restart withdraw routes during outages, impacting the data path for traffic destined for the system undergoing NSF. However, NSF must be attempted for any peers that support graceful restart helper.
- Supports IS-IS with IPv4/IPv6-unicast address families, where all
neighboring devices support graceful restart helper. Note: Peers who do not support graceful restart withdraw routes during outages, impacting the data path for traffic destined for the system undergoing NSF. However, NSF must be attempted for any peers that support graceful restart helper.
- Supports LAG and LACP with both slow and fast timers.
- Supports P4RT
- Supports gRIBI. During NSF, though management plane functions are unavailable, gRIBI programmed routes are persisted.
- Supports sFlow on slow path.
- Supports LLDP. Note: In case of session time out, adjacency loss may occur.
Triggering redundancy switchover
Use the command tools platform redundancy switchover
to trigger a
redundancy switchover from active to the standby control module. The switchover
happens in conjunction with a cold restart.
To trigger redundancy switchover:
--{ running }--[ ]--
# tools platform redundancy switchover
tools platform redundancy
switchover
is not impacted by any pending delayed
reboots.Forcing redundancy synchronization
You can use the tools platform redundancy synchronize overlay system to synchronize the overlay file system or system-required data between the active and standby control modules. The NSF implementation extends this behavior by including the synchronization of file system and IDB server info between the modules.
--{ running }--[ ]--
# tools platform redundancy synchronize overlay system