gNOI 操作系统 （OS） 服务
总结 使用 gNOI 操作系统 （OS） 服务升级目标网络设备上的软件。
您可以使用 gNOI OS 服务升级目标设备上的软件。原型定义文件位于 https://github.com/openconfig/gnoi/blob/master/os/os.proto。
软件安装有三个主要步骤，对应于 OS 服务 RPC。
- 安装
- 激活
- 验证
Install() RPC 将指定的映像传输到目标设备上的/var/tmp/目录中。目标文件名是在消息字段中version定义的TransferRequest值。Activate() RPC 安装映像并重新启动设备以激活新安装的映像。Verify() RPC 验证设备上的操作系统版本。
注意：
您还可以使用 gNOI system 服务 SetPackage() RPC 在设备上安装软件。有关详细信息，请参阅 gNOI 系统服务。
支持的 RPC
| 版本中引入的 | RPC | 说明 |
|---|---|---|
Activate() |
设置下次重新启动时使用的操作系统版本。
注意：
Junos 设备不支持 |
Junos OS 演化版 22.2R1 |
Install() |
将软件映像传输到目标上。
注意：
Junos 设备不支持 |
Junos OS 演化版 22.2R1 |
Verify() |
检查正在运行的操作系统版本。在目标启动时，可能会多次调用此 RPC，直到成功。
注意：
Junos 设备不支持 |
Junos OS 演化版 22.2R1 |
网络设备配置
示例：安装和激活
在此示例中，客户端执行 gnoi_os_install_activate.py Python 应用程序，该应用程序执行以下操作：
- 将软件包从本地网络管理系统复制到网络设备。
- 在网络设备上安装软件包。
- 重新启动网络设备，从而激活新的软件映像。
应用程序使用 Install() 消息调用 InstallRequest() RPC 以传输文件。应用程序通过在每个 10% 的传输完成间隔发出进度消息来跟踪文件传输的进度。如果文件传输成功，应用程序将调用 Activate() RPC 来安装映像并重新启动目标。
应用程序导入grpc_channel模块以建立通道。配置 gNOI 服务中介绍了该grpc_channel模块。应用程序的参数存储在args_os_install_activate.txt文件中。应用程序和参数文件如下所示：
gnoi_os_install_activate.py
"""gRPC gNOI OS Install, Activate utility."""
from __future__ import print_function
import argparse
import logging
import os
from functools import partial
from getpass import getpass
import os_pb2
import os_pb2_grpc
from grpc_channel import grpc_authenticate_channel_mutual
MAX_BYTES = 65536
def get_args(parser):
parser.add_argument('--server',
dest='server',
type=str,
default='localhost',
help='Server IP or name. Default is localhost')
parser.add_argument('--port',
dest='port',
nargs='?',
type=int,
default=50051,
help='The server port. Default is 50051')
parser.add_argument('--client_key',
dest='client_key',
type=str,
default='',
help='Full path of the client private key. Default ""')
parser.add_argument('--client_cert',
dest='client_cert',
type=str,
default='',
help='Full path of the client certificate. Default ""')
parser.add_argument('--root_ca_cert',
dest='root_ca_cert',
required=True,
type=str,
help='Full path of the Root CA certificate.')
parser.add_argument('--user_id',
dest='user_id',
required=True,
type=str,
help='User ID for RPC call credentials.')
parser.add_argument('--no_reboot',
dest='no_reboot',
type=int,
default=0,
help='Reboot immediately or not. Default 0 (Reboot immediately)')
parser.add_argument('--source_package',
dest='source_package',
type=str,
default='',
help='Full path of the source file. Default ""')
parser.add_argument('--timeout',
dest='timeout',
type=int,
default=600,
help='Timeout in seconds. Default 600')
parser.add_argument('--version',
dest='version',
type=str,
default='',
help='OS version to activate. Default is ""')
args = parser.parse_args()
return args
def send_rpc(channel, metadata, args):
print("Executing GNOI::OS::Install")
stub = os_pb2_grpc.OSStub(channel)
it = []
# Create file transfer request
req = os_pb2.InstallRequest()
req.transfer_request.version = args.version
it.append(req)
# Read source package and add to request
source_package_bytes = os.path.getsize(args.source_package)
with open(args.source_package, "rb") as file:
# Read data in 64 KB chunks and calculate checksum and data messages
for data in iter(partial(file.read, MAX_BYTES), b''):
req = os_pb2.InstallRequest()
req.transfer_content = data
it.append(req)
req = os_pb2.InstallRequest()
req.transfer_end.SetInParent()
it.append(req)
next_pct = 0
transfer_percent = 0
validated = False
activated = False
try:
responses = stub.Install(
iter(it), metadata=metadata, timeout=args.timeout)
print("OS Install start\n")
for response in responses:
rsp_type = response.WhichOneof('response')
if rsp_type == 'install_error':
print("%s: %s -- %s\n" % (rsp_type,
response.install_error.type, response.install_error.detail))
raise Exception("Install Error")
elif rsp_type == 'transfer_ready':
print("%s: %s\n" % (rsp_type, response.transfer_ready))
elif rsp_type == 'transfer_progress':
transfer_percent = int(float(
response.transfer_progress.bytes_received) / float(source_package_bytes) * 100)
if 0 == (transfer_percent % 10) and transfer_percent != next_pct:
next_pct = transfer_percent
print("Transfer percent complete: %s%%" % transfer_percent)
logging.info('Transferring file %s%%', transfer_percent)
elif rsp_type == 'validated':
print("%s: %s -- %s\n" % (rsp_type,
response.validated.version, response.validated.description))
logging.info('Validated: %s', response.validated.version)
validated = True
if transfer_percent > 0 and validated:
print("Executing GNOI::OS::Activate")
req = os_pb2.ActivateRequest()
req.version = args.version
req.no_reboot = args.no_reboot
activate_response = stub.Activate(
req, metadata=metadata, timeout=args.timeout)
rsp_type = activate_response.WhichOneof('response')
if rsp_type == 'activate_ok':
activated = True
except Exception as e:
logging.error('Error installing package: %s', e)
print(e)
else:
if activated:
logging.info('Installation complete: %s', args.version)
print('Installation complete for %s' % args.version)
def main():
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
args = get_args(parser)
grpc_server_password = getpass("gRPC server password for executing RPCs: ")
metadata = [('username', args.user_id),
('password', grpc_server_password)]
try:
# Establish grpc channel to network device
channel = grpc_authenticate_channel_mutual(
args.server, args.port, args.root_ca_cert, args.client_key, args.client_cert)
response = send_rpc(channel, metadata, args)
except Exception as e:
logging.error('Received error: %s', e)
print(e)
if __name__ == '__main__':
logging.basicConfig(filename='gnoi-install.log',
format='%(asctime)s %(levelname)-8s %(message)s',
level=logging.INFO,
datefmt='%Y-%m-%d %H:%M:%S')
main()
args_os_install_activate.txt
--root_ca_cert=/etc/pki/certs/serverRootCA.crt --client_key=/home/lab/certs/client.key --client_cert=/home/lab/certs/client.crt --server=10.53.52.169 --port=50051 --user_id=gnoi-user --source_package=/home/lab/images/junos-evo-install-ptx-x86-64-22.3R1.9-EVO.iso --timeout=1800 --version=22.3R1.9-EVO
注意：
从 Junos OS 演化版 23.4R1 开始，version、 Activate()Install()和 Verify() RPC 中的字段使用软件版本字符串（如 中/system/state/software-version所示），而不是软件包名称。
执行应用程序
当客户端执行应用程序时，应用程序将包从本地设备复制到网络设备上的 /var/tmp 目录，安装包，然后重新启动设备以完成安装。
lab@gnoi-client:~/src/gnoi/proto$ python3 gnoi_os_install_activate.py @args_os_install_activate.txt gRPC server password for executing RPCs: Creating channel Executing GNOI::OS::Install OS Install response transfer_ready: Transfer percent complete: 10% Transfer percent complete: 20% Transfer percent complete: 30% Transfer percent complete: 40% Transfer percent complete: 50% Transfer percent complete: 60% Transfer percent complete: 70% Transfer percent complete: 80% Transfer percent complete: 90% Transfer percent complete: 100% validated: 22.3R1.9-EVO -- Use Activate to Validate and Integrity Check the installed Image Executing GNOI::OS::Activate Installation complete for 22.3R1.9-EVO
更改历史记录表
功能支持由您使用的平台和版本决定。使用 功能资源管理器 确定您的平台是否支持某个功能。
释放
描述
23.4R1-EVO
从 Junos OS 演化版 23.4R1 开始，
version、
Activate()
Install()和
Verify() RPC 中的字段使用软件版本字符串（如 中
/system/state/software-version所示），而不是软件包名称。