gNOI

The Install RPC transfers the OS package to the target node. The target node first attempts to copy the specified OS package between the CPMs before it accepts the transfer from the client.

To refer to the OS version, SR Linux uses the same string in gNOI as the one used with ZTP (version string-build number) , for example: v22.11.1-010. The download folder for the OS is located at: /var/run/srlinux/gnoi. To validate that the transferred OS package is valid and bootable before installation, the platform performs a hash check against the md5sum that is embedded in the .bin file.

One Install RPC is required for each CPM. Concurrent Install RPCs are not allowed on the same target node.

 rpc Install(stream InstallRequest) returns (stream InstallResponse);

The Activate RPC sets the requested OS version for the target node to use at the next reboot. It also reboots the target node if the no_reboot flag is not set.

rpc Activate(ActivateRequest) returns (ActivateResponse);

The Verify RPC checks the OS version running on the target node. The client can call this RPC multiple times while the target node boots until the activation is successful.

rpc Verify(VerifyRequest) returns (VerifyResponse);

The Get RPC reads and streams the contents of a file from a target node to the client using sequential messages, and sends a final message containing the hash of the streamed data before closing the stream.

The target node returns an error if:

• An error occurs while reading the file.
• The file does not exist.

rpc Get(GetRequest) returns (stream GetResponse) {}

The Put RPC streams data to the target node and writes the data to a file. The client streams the file using sequential messages. The initial message contains information about the filename and permissions. The final message includes the hash of the streamed data.

The target node returns an error if:

• An error occurs while writing the data.
• The location does not exist.

rpc Put(stream PutRequest) returns (PutResponse) {}

The Stat RPC returns metadata about files on the target node.

If the path specified in the StatRequest references a directory, the StatResponse returns the metadata for all files and folders, including the parent directory. If the path references a direct path to a file, the StatResponse returns metadata for the specified file only.

rpc Stat(StatRequest) returns (StatResponse) {}

The Remove RPC removes the specified file from the target node.

The target node returns an error if:

• An error occurs during the remove operation (for example, permission denied).
• The file does not exist.
• The path references a directory instead of a file.

rpc Remove(RemoveRequest) returns (RemoveResponse) {}

The Ping RPC allows the client to execute the ping command on the target node. The target node streams the results back to the client. Some targets do not stream any results until they receive all results. If the RPC does not specify a packet count, the ping operation uses a default of five packets.

rpc Ping(PingRequest) returns (stream PingResponse) {}

The Traceroute RPC allows the client to execute the traceroute command on the target node. The target node streams the results back to the client. Some targets do not stream any results until they receive all results. If the RPC does not specify a hop count, the traceroute operation uses a default of 30.

rpc Traceroute(TracerouteRequest) returns (stream TracerouteResponse) {}

The Time RPC returns the current time on the target node. It is typically used to test whether the target is currently responding.

rpc Time(TimeRequest) returns (TimeResponse) {}

The SwitchControlProcessor RPC switches the active control processing module (CPM) on the target node to the control slot (A or B) that is specified in the request message.

rpc SwitchControlProcessor(SwitchControlProcessorRequest)
    returns (SwitchControlProcessorResponse) {}

The Reboot RPC allows the client to reboot a target node, either immediately or at some time in the future. It triggers the reboot of the entire chassis. It also supports specification of a reboot method (for example, cold or warm reboot), however, if the target node does not support the specified reboot method, the Reboot RPC fails.

If a reboot is pending on the active control processor, the service rejects all other reboot requests.

rpc Reboot(RebootRequest) returns (RebootResponse) {}

The CancelReboot RPC allows the client to cancel any pending reboot requests on the target node.

message CancelRebootResponse { }

The RebootStatus RPC allows the client to query the status of a reboot on the target node.

rpc RebootStatus(RebootStatusRequest) returns (RebootStatusResponse) {}

The KillProcess RPC allows a client to kill an OS process and optionally restart it on the target node.

To specify the process to kill, the RPC must match the application name referenced in the tools system app-management application <name> command.

rpc KillProcess(KillProcessRequest) returns (KillProcessResponse)
                          {}