Nornir 项目技术文档

Nornir 项目技术文档

nornir Pluggable multi-threaded framework with inventory management to help operate collections of devices 项目地址: https://gitcode.com/gh_mirrors/no/nornir

1. 安装指南

1.1 系统要求

Nornir 需要 Python 3.8 或更高版本。请确保您的系统上已安装符合要求的 Python 版本。

1.2 使用 pip 安装

您可以使用 pip 来安装 Nornir：

pip install nornir

1.3 从源码安装

如果您希望从源码安装 Nornir，可以使用 poetry 工具：

1. 克隆 Nornir 仓库：

   git clone https://github.com/nornir-automation/nornir.git
   cd nornir
   

2. 使用 poetry 安装：

   poetry install
   

2. 项目使用说明

2.1 概述

Nornir 是一个纯 Python 自动化框架，旨在直接从 Python 代码中使用。与其他自动化框架不同，Nornir 不使用自己的领域特定语言（DSL），而是允许您完全通过 Python 控制一切。

2.2 主要优势

• 易于调试：如果出现问题，您可以直接使用 Python 的调试工具（如 pdb）进行调试。
• 灵活性：Nornir 负责处理您的库存管理，并管理将任务分派到您的节点和设备的工作。
• 插件支持：Nornir 支持自定义插件，您可以根据需要编写和使用插件。

2.3 基本使用流程

1. 初始化 Nornir：创建一个 Nornir 实例并加载您的库存。
2. 定义任务：编写 Python 函数来定义您希望执行的任务。
3. 运行任务：使用 Nornir 实例运行您定义的任务。

3. 项目 API 使用文档

3.1 核心 API

Nornir 的核心 API 主要包括以下几个部分：

• Nornir 实例：用于管理库存和任务分派。
• 任务定义：使用 Python 函数定义任务。
• 插件系统：支持自定义插件的加载和使用。

3.2 常用 API 示例

以下是一些常用的 API 示例：

from nornir import InitNornir
from nornir.plugins.tasks import networking

# 初始化 Nornir 实例
nr = InitNornir(config_file="config.yaml")

# 定义一个任务
def my_task(task):
    task.run(task=networking.napalm_get, getters=["facts"])

# 运行任务
result = nr.run(task=my_task)
print(result)

4. 项目安装方式

4.1 使用 pip 安装

最简单的安装方式是使用 pip：

pip install nornir

4.2 从源码安装

如果您需要最新的开发版本，可以从源码安装：

1. 克隆仓库：

   git clone https://github.com/nornir-automation/nornir.git
   cd nornir
   

2. 使用 poetry 安装：

   poetry install
   

4.3 插件安装

Nornir 3.0.0 及更高版本不再自带插件，您可以使用 pip 安装所需的插件。插件列表可以在 Nornir 插件页面 找到。

pip install nornir-napalm

通过以上步骤，您可以顺利安装并开始使用 Nornir 进行网络自动化任务。

nornir Pluggable multi-threaded framework with inventory management to help operate collections of devices 项目地址: https://gitcode.com/gh_mirrors/no/nornir