网络设备配置从手工逐台敲命令转为脚本执行,核心价值不只是省时间,而是把配置过程变成可重复、可审计、可回滚的流程。手工配置到一半断线时,设备处于什么状态往往说不清;脚本执行则可以留下日志、退出码和备份文件,出问题能回溯到具体命令和参数。下面围绕Python的netmiko方案,拆解设备连接、模板参数化、交互处理、备份恢复、批量并发、重试回滚、超时异常与配置验证等落地细节。
一、选型与依赖:paramiko、netmiko、scrapli怎么取舍
paramiko是Python下较底层的SSH实现库,封装连接、执行命令和传输文件,不掺入网络设备逻辑,适合定制开发或学习SSH原理,但登录后的交互、回显读取和超时判断要自己处理。netmiko在paramiko之上做了多厂商适配,支持思科、华为、华三、瞻博、Arista等主流设备,能处理不同登录提示符、命令分页导致的回显截断以及退出确认等共性细节,多厂商混合环境优先考虑。scrapli性能更好、异步支持更完善,底层可走paramiko或ssh2-python,但社区生态和文档成熟度目前略逊netmiko。
项目对硬件要求不高,普通电脑甚至树莓派即可,Python建议3.9及以上。依赖安装主要是:该命令会自动安装paramiko。批量并发使用标准库concurrent.futures即可,不需要额外安装。后续若增加配置备份、审计报表,可再引入openpyxl、schedule、Flask等,但应先跑通自动配置主链路。
二、最小可用连接脚本与device_type排错
先搭最小骨架:SSH登录一台设备、执行一条命令、打印回显、断开连接。- from netmiko import ConnectHandler
- device = {
- 'device_type': 'huawei',
- 'ip': '192.168.10.1',
- 'username': 'admin',
- 'password': 'Admin@123',
- 'port': 22,
- }
- try:
- connection = ConnectHandler(**device)
- print('设备连接成功')
- output = connection.send_command('display version')
- print(output)
- connection.disconnect()
- print('已断开连接')
- except Exception as e:
- print(f'连接或执行失败:{e}')
复制代码 device_type非常关键,netmiko靠它决定登录shell类型、提示符和退出方式。huawei、cisco_ios、hp_comware都是内置关键字。若device_type匹配错误,常见表现是认证失败或登录后提示符识别不对,此时不要先怀疑密码,应先核对设备平台类型。send_command执行的是非交互命令;若命令会进入交互对话,需要改用send_command_timing或配合expect_string匹配提示符。设备密码不能硬编码在脚本里,上面的写法只用于演示,实际应放入配置文件、环境变量或密钥管理系统。
三、配置模板参数化:一份模板批量套用
批量配置不要为每台设备写死命令。更合适的结构是“固定命令框架+设备差异参数”。例如为交换机配置管理地址、VLAN和默认路由:- def generate_config(hostname, vlan_id, vlan_name, mgmt_ip, gateway_ip):
- config_lines = [
- 'system-view',
- f'sysname {hostname}',
- f'vlan {vlan_id}',
- f'name {vlan_name}',
- f'interface Vlanif {vlan_id}',
- f'ip address {mgmt_ip} 255.255.255.0',
- 'quit',
- f'ip route-static 0.0.0.0 0.0.0.0 {gateway_ip}',
- 'return',
- ]
- return config_lines
复制代码 调用时用设备信息表循环,表中可包含hostname、ip、vlan_id、mgmt_ip、gateway_ip等字段。新加设备只增加一行记录,不改代码。模板设计阶段要严格区分配置模式和用户视图模式:华为设备先system-view进入系统视图,最后return回用户视图;思科设备对应configure terminal和end。命令语法在不同视图下可能不同,这类差异不能等到下发时才发现。
四、交互确认与分页处理
实际配置常遇到设备反问“Are you sure?”或出现--More--分页符,这是自动化容易卡住的地方。netmiko可用send_command_timing按时间间隔发送并等待,适合输出不固定但提示符会回来的场景;send_command可指定expect_string,持续读取回显直到匹配指定字符串。若某条命令会询问是否继续,可在配置清单中预设回答:- config_lines = [
- 'system-view',
- 'undo startup saved-configuration',
- 'y',
- 'return',
- ]
复制代码 不加这个y,脚本会停在等待输入直到超时报错。交互处理的优先原则是能避则避:若设备支持force、noword之类参数跳过确认,应优先用非交互替代命令,少一个交互就少一个排错点。
五、配置前备份与恢复:给变更上保险
自动配置最怕配置推到一半发现命令有误,设备处于半新半旧状态,甚至配置被冲掉后没有基线可回滚。因此任何变更前都要先备份当前配置。- from datetime import datetime
- from netmiko import ConnectHandler
- def backup_config(device, backup_dir='backup/'):
- timestamp = datetime.now().strftime('%Y%m%d_%H%M%S')
- device_ip = device['ip']
- connection = ConnectHandler(**device)
- if device['device_type'].startswith('huawei'):
- config = connection.send_command('display current-configuration')
- elif device['device_type'].startswith('cisco'):
- config = connection.send_command('show running-config')
- else:
- config = connection.send_command('display current-configuration')
- filename = f'{backup_dir}/{device_ip}_{timestamp}.cfg'
- with open(filename, 'w') as f:
- f.write(config)
- connection.disconnect()
- return filename
复制代码 备份文件建议用“设备IP_时间戳.cfg”命名,便于按时间线对比配置差异。恢复时可用send_config_set下发备份文件内容,它会自动处理进入配置模式、逐条下发和退出,并在命令间等待设备回显,降低命令粘连风险。- def restore_config(device, backup_file):
- connection = ConnectHandler(**device)
- with open(backup_file, 'r') as f:
- config_lines = f.readlines()
- output = connection.send_config_set(config_lines)
- print(output)
- connection.disconnect()
复制代码
六、串行批量与并发控制
单台设备的备份、配置写好后,批量配置自然是在外层套循环。串行版本逻辑简单,设备处理能力弱或带宽有限时更稳,但速度慢:假设一台设备连配置带备份需要40秒,50台就是2000秒,半小时以上。并发能提速,但网络设备管理接口的SSH会话数往往有上限,并发太高会导致登录失败或设备响应异常慢。
推荐用concurrent.futures.ThreadPoolExecutor控制最大并发数:- from concurrent.futures import ThreadPoolExecutor, as_completed
- def process_device(device):
- device_ip = device['ip']
- print(f'[{device_ip}] 开始处理')
- try:
- config_lines = generate_config(...)
- backup_path = backup_config(device)
- output = deploy_configuration(device, config_lines)
- return device_ip, 'success', output
- except Exception as e:
- return device_ip, 'failed', str(e)
- def batch_run(devices_list, max_workers=5):
- results = {}
- with ThreadPoolExecutor(max_workers=max_workers) as executor:
- future_map = {executor.submit(process_device, device): device['ip'] for device in devices_list}
- for future in as_completed(future_map):
- device_ip = future_map[future]
- try:
- ip, status, detail = future.result()
- results[ip] = {'status': status, 'detail': detail}
- except Exception as e:
- results[device_ip] = {'status': 'exception', 'detail': str(e)}
- return results
复制代码 max_workers建议先从3或5开始,观察设备侧和网络侧负荷再逐步调大,不同设备型号和管理口性能不同,不要照搬参数。共享变量要谨慎:让每个线程通过返回值带回结果,再由主线程统一汇总,可避免多线程同时写全局变量导致数据错乱。日志建议加设备IP前缀并使用logging模块,线程安全且便于落文件。若并发时单台设备连接时间明显长于串行甚至频繁超时,说明并发太激进,应调小。
七、重试机制与失败回滚决策
批量执行总会有设备意外失败,可能是设备重启、网络闪断或AAA认证策略限制并发连接。重试要有策略,不能无脑重复。可设置retry_times=2、delay=5这类参数,但重试只应限定在连接设备和执行无副作用命令(查询、备份)场景。危险配置命令失败后应终止该流程并人工确认,因为第一次可能并非完全没成功,无脑重试可能造成重复配置。失败设备要记录原因并汇总报告,至少包含成功列表、失败列表、失败原因和备份文件路径,便于排查和交接。
八、安全、超时与异常分支
明文密码写在脚本里风险极高,脚本泄露等于设备管理权限泄露。可把认证信息放入权限设为600的独立配置文件,用yaml.safe_load读取;手动执行场景也可用getpass在终端提示输入,不落盘。定时任务则更适合配置文件或专门密钥管理服务。
超时机制必须设置。netmiko连接可通过timeout控制连接阶段超时,send_command可通过read_timeout控制命令响应超时,例如连接timeout=20、普通命令read_timeout=30。连接阶段建议15到30秒,普通命令10秒左右,耗时的备份命令可放到30秒以上。异常捕获不要只写笼统except Exception,应区分连接超时、认证失败和命令执行错误:认证失败通常说明账号密码配置有问题,命令执行错误通常说明模板语法有问题,这两类重试都没有意义。
九、配置后验证与常见故障
配置下发完成不等于任务完成。验证要确认配置是否生效,而不只是命令是否执行。可执行display current-configuration | include sysname检查主机名,执行display vlan {vlan_id}检查VLAN,再用hostname in version_output、'success' in vlan_output.lower()这类断言判断结果,具体匹配内容需按设备返回定制。
常见故障方面:连接超时先查网络、端口和超时参数;提示符识别错误优先检查device_type是否匹配真实平台;命令回显中的分页符会截断输出,需要依赖netmiko的分页处理或关闭分页;对可能触发设备重启的配置命令要提前评估,避免自动重试扩大影响。原文还提到台账更新与日志收集,核心可推导要求是每批次保留时间戳、备份路径、操作人、成功失败列表和失败原因,保证后续可审计、可回溯。
十、扩展方向
主链路跑通后,可把脚本扩展为配置合规检查工具,对回显做规则断言;也可配合配置管理平台做自助化,把设备清单、模板和审批流程串起来。整体思路仍是先明确设备环境,再选择适配方案,避免代码写完才发现设备不在支持列表里造成返工。 |