Python 网络自动化脚本示例

爱被打了一巴掌 2023-10-03 08:07 33阅读 0赞

在这篇文章中，我将详细介绍一些我几乎每天都在使用的 Cisco 网络工程师的 Python 脚本。

对于每个需要连接的示例，我将使用 20 个 CSR 路由器的基本拓扑。

我还将使用 Netmiko 连接到网络设备。如果您之前没有使用过 Netmiko，那么您可以查看使用 Netmiko 创建到 Cisco 路由器的连接的快速运行。

如果您被告知需要学习或实施[网络自动化，][Link 1]这些脚本应该可以帮助您入门。

[Python 网络自动化][Python]正在成为 2021 年的必备技能。因此，您需要确保了解您的对象、变量、方法、函数、字典和列表。作为当今最流行的编程语言之一，可用的信息非常多，下面的脚本应该可以帮助您入门。

如果您是 Python 新手，您可以查看我的[Python 初学者教程][Python 1]

**如果要下载下面使用的所有脚本，可以使用以下命令  
git clone存储库：git clone https://github.com/rogerperkin/python-scripts-for-network-engineers.git**

**页面内容\[[显示][Link 2]\]**

### 1. Cisco Python 脚本通过 SSH 连接到路由器 ###

我将向您展示的第一个脚本是如何通过 SSH 连接到路由器。

该脚本使用 Netmiko 建立连接，然后我将运行“show ip interface brief”命令来验证路由器上的 ip 接口。

Github 上的脚本：[ssh-to-router.py][]

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>from</code> <code>netmiko </code><code>import</code> <code>ConnectHandler</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>#First create the device object using a dictionary</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>CSR </code><code>=</code> <code>{ </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'device_type'</code><code>: </code><code>'cisco_ios'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'ip'</code><code>: </code><code>'192.168.1.220'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'username'</code><code>: </code><code>'roger'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'password'</code><code>: </code><code>'cisco'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>}</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Next establish the SSH connection</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>net_connect </code><code>=</code> <code>ConnectHandler(</code><code>*</code><code>*</code><code>CSR)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Then send the command and print the output</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>output </code><code>=</code> <code>net_connect.send_command(</code><code>'show ip int brief'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>print</code> <code>(output)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Finally close the connection</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>net_connect.disconnect()</code></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这是一个非常基本的脚本，它首先从 Netmiko 导入 ConnectHandler。

**注意：要运行它，您必须先安装 Netmiko——**如果还没有**安装，**请观看本文顶部的视频。

然后我们定义一个名为 CSR 的设备并提供 Netmiko 所需的信息，即**device\_type**、**IP 地址**以及**用户名**和**密码**。

然后使用 net\_connect 模块连接到设备 CSR

连接后，我们将命令“sh ip int brief”发送到路由器并将值保存为输出

最后，我们打印输出并断开与设备的连接。

### 2. SSH 到多个路由器 ###

现在我们有一个到单个路由器的基本连接，是时候扩展它了，我们现在要连接到 5 个路由器。但它很容易是 100 或 1000！

[ssh-to-multiple-routers.py][]

为此，我创建了一个名为 devices.txt 的新文件，其中包含我们 5 个 CSR 路由器的所有 IP 地址。然后我们使用相同的脚本，但循环连接并传入每个路由器的 IP，这样我们就可以获得所有路由器的“sh ip int brief”输出。

**注意：不要在最后一行的末尾按回车键。否则你的脚本最后会出现问题。**

如果您正在大规模执行此操作，您将使用 Python 自动化框架，如[Nornir][]。这为您提供了库存的好处，就像 Ansible 一样。

但是，在跳转到其他主题之前了解如何手动执行此任务仍然很好。

### 3. 用于备份 Cisco 配置的 Python 脚本 ###

现在我们已经确定了如何连接到多个设备并可以运行基本命令，下一步是能够保存该输出。

人们在开始使用[网络自动化][Link 1]时通常会执行的首要任务之一是备份配置文件。这个 Python 脚本就是这样做的。

[备份路由器.py][.py]

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>from</code> <code>netmiko </code><code>import</code> <code>ConnectHandler</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>#First create the device object using a dictionary</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>CSR </code><code>=</code> <code>{ </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'device_type'</code><code>: </code><code>'cisco_ios'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'ip'</code><code>: </code><code>'192.168.1.220'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'username'</code><code>: </code><code>'roger'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'password'</code><code>: </code><code>'cisco'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>}</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Next establish the SSH connection</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>net_connect </code><code>=</code> <code>ConnectHandler(</code><code>*</code><code>*</code><code>CSR)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>#Discover the hostname from the prompt </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>hostname </code><code>=</code> <code>net_connect.send_command(</code><code>'show run | i host'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>hostname.split(</code><code>" "</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>hostname,device </code><code>=</code> <code>hostname.split(</code><code>" "</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>print</code> <code>(</code><code>"Backing up "</code> <code>+</code> <code>device)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>filename </code><code>=</code> <code>'/home/roger/python-scripts-for-network-engineers/backups/'</code> <code>+</code> <code>device </code><code>+</code> <code>'.txt'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># to save backup to same folder as script use below line and comment out above line </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># filename = device + '.txt'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>showrun </code><code>=</code> <code>net_connect.send_command(</code><code>'show run'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>showvlan </code><code>=</code> <code>net_connect.send_command(</code><code>'show vlan'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>showver </code><code>=</code> <code>net_connect.send_command(</code><code>'show ver'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file </code><code>=</code> <code>open</code><code>(filename, </code><code>"a"</code><code>)&nbsp;&nbsp; </code><code># in append mode</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(showrun)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(showvlan)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(showver)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Finally close the connection</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>net_connect.disconnect()</code></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

**注意：您需要更改 filename = 以匹配您的环境**

继续阅读以获取更多 Cisco Python 脚本示例。

### 4. 备份多个路由器的Python脚本 ###

现在我们有了一个可以备份单个 Cisco 路由器的脚本，很容易使用我们用来连接多个路由器的脚本并将备份任务添加到 for 循环中。

该脚本再次使用 devices.txt 文件来遍历 IP 列表并备份每个路由器。

所有备份都放在 /backups 中，但您可以通过更改文件名后的路径来更改备份的位置。

[备份多路由器.py][.py 1]

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># SSH to Multiple Devices from devices file</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>from</code> <code>netmiko </code><code>import</code> <code>ConnectHandler</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>with </code><code>open</code><code>(</code><code>'devices.txt'</code><code>) as routers:</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code> <code>IP </code><code>in</code> <code>routers:</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Router </code><code>=</code> <code>{ </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'device_type'</code><code>: </code><code>'cisco_ios'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'ip'</code><code>: IP,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'username'</code><code>: </code><code>'roger'</code><code>,</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'password'</code><code>: </code><code>'cisco'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>net_connect </code><code>=</code> <code>ConnectHandler(</code><code>*</code><code>*</code><code>Router)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>hostname </code><code>=</code> <code>net_connect.send_command(</code><code>'show run | i host'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>hostname.split(</code><code>" "</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>hostname,device </code><code>=</code> <code>hostname.split(</code><code>" "</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>(</code><code>"Backing up "</code> <code>+</code> <code>device)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filename </code><code>=</code> <code>'/home/roger/python-scripts-for-network-engineers/backups/'</code> <code>+</code> <code>device </code><code>+</code> <code>'.txt'</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code># to save backup to same folder as script use below line and comment out above line </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code># filename = device + '.txt' </code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>showrun </code><code>=</code> <code>net_connect.send_command(</code><code>'show run'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>showvlan </code><code>=</code> <code>net_connect.send_command(</code><code>'show vlan'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>showver </code><code>=</code> <code>net_connect.send_command(</code><code>'show ver'</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file </code><code>=</code> <code>open</code><code>(filename, </code><code>"a"</code><code>)&nbsp;&nbsp; </code><code># in append mode</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(showrun)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(showvlan)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(showver)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log_file.write(</code><code>"\n"</code><code>)</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;">&nbsp;</span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code># Finally close the connection</code></span> 
     </div> 
     <div style="margin-left:0px;"> 
      <span style="color:#6c747d;"><code>net_connect.disconnect()</code></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

### 5. 使用 Jinja2 的配置生成器。 ###

待定

### 6. IP 有效检查器 ###

这个简单的 Python 脚本使用 ipaddress 模块，并将验证输入的 IPv4 或 IPv6 地址是否有效。

此页面正在不断开发中，当我使用新脚本时，我将在此处添加它。

[Link 1]: https://www.rogerperkin.co.uk/network-automation/
[Python]: https://www.rogerperkin.co.uk/network-automation/python/
[Python 1]: https://www.rogerperkin.co.uk/python-tutorial/
[Link 2]: https://www.rogerperkin.co.uk/network-automation/python/scripts-for-network-engineers/#
[ssh-to-router.py]: https://github.com/rogerperkin/python-scripts-for-network-engineers/blob/master/connect.py
[ssh-to-multiple-routers.py]: https://github.com/rogerperkin/python-scripts-for-network-engineers/blob/master/ssh-to-multiple-routers.py
[Nornir]: https://www.rogerperkin.co.uk/network-automation/python/nornir/
[.py]: https://github.com/rogerperkin/python-scripts-for-network-engineers/blob/master/backup-router.py
[.py 1]: https://github.com/rogerperkin/python-scripts-for-network-engineers/blob/master/backup-multiple-routers.py