Python网络自动化运维及相关模块（上）

Python telnetlib模块

基本原理

在介绍 telnetlib 中各个 read 函数的意义前，首先了解 telnetlib 的工作原理。

telnetlib 首先通过 socket 连接从网络接收数据，把数据存储到自己的 raw queue 中，然后对其进行（telnet 协议相关的）处理（cook）。处理结果存放在 cooked queue 中供应用程序取用。整个过程如下图所示：

read方法

与队列相关

• read_very_lazy
  只从 cookedq 读取已处理好的数据。
• read_lazy
  如果 rawq 有数据，对 rawq 里的数据进行处理，然后从cookedq 中读取处理好的数据。 -
• read_eager
  从系统的 socket buffer 接受数据（即非阻塞模式 1读取数据）并处理，然后从 cookedq 中读取数据。
• read_very_eager
  与 read_eager 类似。不同之处在于 read_eager 只要从cookedq 成功读取到数据就返回，而 read_very_eager 会试图读尽可能多的数据。

其他read方法

• read_until（expected, timeout=None）
  读取直到遇到给定的预期字节字符串，或者直到超时时间。

• read_all（ ）
  读取所有数据，直到EOF以字节为单位；阻塞直到连接关闭。

其他方法

• open（host, port=0[, timeout]）
  连接到主机。可选的第二个参数是端口号，默认为标准Telnet端口（23）。可选的timeout参数以秒为单位指定用于阻止连接尝试之类的操作的超时（如果未指定，将使用全局默认超时设置）。
• close（ ）
  关闭连接。
• write（buffer）
  将字节字符串写入套接字
• set_debuglevel( debuglevel )
• 这个函数默认的参数时0，以上代码使用的是1，就将交互过程的信息都打印出来了。可以看到来回交互的都是byte stream。

Python netmiko模块

netmiko针对不同网络设备做了优化，可以更有效地处理SSH连接，它还支持不同的设备厂商和平台。

使用方法

在使用netmiko模块时，不可避免地会使用到ConnectHandler函数，ConnectHandler函数提供定义的字典来开始创建连接。
以下是ConnectHandler函数的定义及示例
定义

def ConnectHandler(*args, **kwargs):
    """Factory function selects the proper class and creates object based on device_type."""
    device_type = kwargs["device_type"]
    if device_type not in platforms:
        if device_type is None:
            msg_str = platforms_str
        else:
            msg_str = telnet_platforms_str if "telnet" in device_type else platforms_str
        raise ValueError(
            "Unsupported 'device_type' "
            "currently supported platforms are: {}".format(msg_str)
        )
    ConnectionClass = ssh_dispatcher(device_type)
    return ConnectionClass(*args, **kwargs)

示例

def netmiko_connect(request):
    """Connect to arista1 and return connection object"""
    password = os.getenv("PYNET_PASSWORD") if os.getenv("PYNET_PASSWORD") else getpass()
    arista1 = {
   
        "device_type": "arista_eos",
        "host": "arista1.lasthop.io",
        "username": "pyclass",
        "password": password,
    }

    net_connect = ConnectHandler(**arista1)

    def fin():
        net_connect.disconnect()

    request.addfinalizer(fin)
    return net_connect 

常用方法

常用

• net_connect.enable() # 输入启用模式
• net_connect.send_command() # 向下发送命令，返回输出（基于模式）
• net_connect.send_config_set() # 将配置命令发送到远程设备
• net_connect.disconnect() # 关闭连接

了解

• net_connect.send_config_from_file() # 发送从文件加载的配置命令

• net_connect.save_config() # 将running#config保存到startup#config

• net_connect.send_command_timing() # 沿通道发送命令，返回输出（基于时序）

• net_connect.find_prompt() # 返回当前路由器提示符

• net_connect.commit() # 在Juniper和IOS#XR上执行提交操作

• net_connect.write_channel() # 通道的低级写入

• net_connect.read_channel() # 通道的低级写入

Python yaml模块

YAML是一种直观的能够被电脑识别的的数据序列化格式，是一个专门用来写配置文件的语言，容易被人类阅读，并且容易和脚本语言交互。

yaml文件规则

1. 区分大小写；
2. 使用缩进表示层级关系；
3. 使用空格键缩进或者Tab键缩进，二者不能混用
4. 缩进的空格数目不固定，只需要相同层级的元素左侧对齐
5. 文件中的字符串不需要使用引号标注，但若字符串包含有特殊字符则需用引号标注
6. 注释标识为#

yaml文件数据结构

• 字典：键值对的集合，键值对用冒号 : 结构表示，冒号与值之间需用空格分隔

# yaml键值对嵌套：即python中字典嵌套字典
usr1:
  name: a
  psw: 123
usr2:
  name: b
  psw: 456

python解析该yaml文件后为

{
   'usr1': {
   'name': 'a', 'psw': 123}, 'usr2': {
   'name': 'b', 'psw': 456}}

• 列表：一组按序排列的值，前加有 “-” 符号，符号与值之间需用空格分隔

# yaml键值对中嵌套数组
usr3:
  - a
  - b
  - c
usr4:
  - b

python解析该yaml文件后为

{
   'usr3': ['a', 'b', 'c'], 'usr4': ['b']}

• 纯量(scalars)：单个的、不可再分的值（如：字符串、bool值、整数、浮点数、时间、日期、null等），None值可用null可 ~ 表示
• 多个文档在一个yaml文件，使用 — 分隔方式来分段

# 分段yaml文件中多个文档
---
animal1: dog
age: 2
---
animal2: cat
age: 3

常用方法

• load() :读取yml文件，并返回一个对象

import yaml
f = open(r'E:\AutomaticTest\Test_Framework\config\config.yml')
y = yaml.load(f)
print (y)

• load_all()：生成一个迭代器
  如果string或文件包含几块yaml文档，你可以使用yaml.load_all来解析全部的文档。

import yaml
f = '''
---
name: James
age: 20
---
name: Lily
age: 19
'''
y = yaml.load_all(f)
for data in y:
    print(data)

输出结果为：

{
   'name': 'James', 'age': 20}
{
   'name': 'Lily', 'age': 19}

• yaml.dump()：将一个python对象生成为yaml文档

import yaml
aproject = {
   'name': 'Silenthand Olleander',
            'race': 'Human',
            'traits': ['ONE_HAND', 'ONE_EYE']
            }

print(yaml.dump(aproject，第二个为可选参数))

输出结果为：

name: Silenthand Olleander
race: Human
traits:
- ONE_HAND
- ONE_EYE

yaml.dump接收的第二个参数一定要是一个打开的文本文件或二进制文件，yaml.dump会把生成的yaml文档写到文件里。

• yaml.dump_all()：将多个段输出到一个文件中

import yaml

obj1 = {
   "name": "James", "age": 20}
obj2 = ["Lily", 19]

with open(r'E:\AutomaticTest\Test_Framework\config\config.yml', 'w') as f:
    yaml.dump_all([obj1, obj2], f)

两段数据参数用列表传入
输出结果为：

{
   age: 20, name: James}
--- [Lily, 19]

• & 锚点和 * 别名，可以用来引用

defaults: