From 804c6b655d777a9302b96ecd584d725ffa472ad6 Mon Sep 17 00:00:00 2001 From: tkspuk Date: Sat, 25 Apr 2020 17:28:00 +0800 Subject: [PATCH] Modify the README and add README-ZH --- README-ZH.md | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 8 ++++++-- 2 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 README-ZH.md diff --git a/README-ZH.md b/README-ZH.md new file mode 100644 index 0000000..d9fb75b --- /dev/null +++ b/README-ZH.md @@ -0,0 +1,43 @@ +[![PyPI](https://img.shields.io/pypi/v/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp) +[![PyPI](https://img.shields.io/pypi/dm/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp) + +# napalm-huawei-vrp [English](README.md) + +NAPALM华为S系列园区网交换机驱动,支持S5700,S6700等. + + +## 介绍 + +这个驱动目前支持以下功能 + +* get_facts(): 获取设备基础信息 +* cli(): 发送任何命令到设备中 +* get_lldp_neighbors(): 获取LLDP邻居信息 +* get_config(): 获取配置信息 +* is_active(): 设备是否可用 +* ping(): 从设备中ping远端设备 +* get_arp_table(): 获取设备APR表 +* get_mac_address_table(): 获取设备MAC地址表 +* get_interfaces(): 获取接口信息 +* get_interfaces_ip(): 获取接口IP信息 +* get_interfaces_counters(): 获取接口统计信息 + +## 如何安装 + +使用PIP来安装napalm-huawei-vrp + +`pip install napalm napalm-huawei-vrp` + +## 快速开始 + +```python +from napalm import get_network_driver +driver = get_network_driver('huawei-vrp') +device = driver(hostname='192.168.76.10', username='admin', password='this_is_not_a_secure_password') +device.open() + +get_facts = device.get_facts() +print(get_facts) + +send_command = device.cli(['dis ver', 'dis cu']) +``` \ No newline at end of file diff --git a/README.md b/README.md index e5a3c53..1aef8fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# napalm-huawei-vrp +[![PyPI](https://img.shields.io/pypi/v/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp) +[![PyPI](https://img.shields.io/pypi/dm/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp) + +# napalm-huawei-vrp [中文版](README-ZH.md) NAPALM driver for HUAWEI Campus Network Switch, support the S5700,S6700 etc. @@ -15,7 +18,8 @@ The driver is functional and can be used to poll status information: * ping(): Ping remote ip * get_arp_table(): Get device ARP table * get_mac_address_table(): Get mac table of connected devices -* get_interfaces_ip(): Get interface IP +* get_interfaces(): Get interface information +* get_interfaces_ip(): Get interface IP information * get_interfaces_counters(): Get interface counters ## How to Install