napalm-huawei-vrp


Namenapalm-huawei-vrp JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/napalm-automation-community/napalm-huawei-vrp
SummaryNetwork Automation and Programmability Abstraction Layer with Multi-vendor support,Driver for Huawei Campus Network Switch,VRP OS
upload_time2023-03-18 21:38:54
maintainer
docs_urlNone
authorLocus Li
requires_python
license
keywords
VCS
bugtrack_url
requirements napalm
Travis-CI
coveralls test coverage No coveralls.
            [![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

It's a NAPALM Community Driver for Huawei VRP5/VRP8 Enterprise/Service Provider Routers and Switches.

This repository is reference [NAPALM-CE](https://github.com/napalm-automation-community/napalm-ce) and Cisco IOS code, thanks for thdDaniel's contribution
[中文版](README-ZH.md)

## Supported Huawei Network Devices

* NE Series: 
    * 40E, 8000
* AR Series:
    * 2200
* ATN 900 Series:
    * 910B, 910C and 910D
* S Switch Series:
    * S5700, S6700

This driver is not limited to these models and series, these are just devices where the driver have been tested.

## Instructions

The driver is under development and iteration.

### Get info
| API   | Description  |
|--------|-----|
|  get_facts()                |  Return general device information |
|  get_config()               |  Read config |
|  get_arp_table()            |  Get device ARP table |
|  get_mac_address_table()    |  Get mac table of connected devices |
|  get_interfaces()           |  Get interface information |
|  get_interfaces_ip()        |  Get interface IP information  |
|  get_interfaces_counters()  |  Get interface counters  |
|  get_lldp_neighbors()       |  Fetch LLDP neighbor information |


### Config

| API   | Description  |
|--------|-----|
|  cli()                      |  Send any cli commands  |
|  load_merge_candidate()     |  Load config |
|  compare_config()           |  A string showing the difference between the running configuration and the candidate configuration |
|  discard_config()           |  Discards the configuration loaded into the candidate |
|  commit_config()            |  Commits the changes requested by the method load_replace_candidate or load_merge_candidate |


### Other tools
| API   | Description  |
|--------|-----|
|  is_active()                |  get devices active status  |
|  ping()                     |  Ping remote ip  |


### Plans to develop

* get_bgp_config
* get_bgp_neighbors
* get_bgp_neighbors_detail
* get_environment
* get_ipv6_neighbors_table
* get_lldp_neighbors_detail
* get_network_instances
* get_ntp_peers
* get_ntp_servers
* get_ntp_stats
* get_optics
* get_route_to
* get_snmp_information
* get_users
* get_vlans


## How to Install

You can install napalm-huawei-vrp with pip:

`pip install napalm-huawei-vrp`

That will install napalm and huawei_vrp driver currently available.

## How to upgrade

You can upgrade napalm-huawei-vrp with pip once the new version released:

`pip install --upgrade napalm-huawei-vrp`

check the package version.

`pip list | grep napalm-huawei-vrp`


## Quick start

```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()

# Send Any CLI command
send_command = device.cli(['dis version'])

#  Return general device information
get_facts = device.get_facts()
print(get_facts)

# other API
device.get_config()
device.get_arp_table()
device.get_mac_address_table()
device.get_interfaces()
device.get_interfaces_ip()
device.get_interfaces_counters()
device.get_lldp_neighbors()

```
## Contact
### Slack

Slack is probably the easiest way to get help with NAPALM. You can find us in the channel napalm on the [network.toCode()](https://networktocode.herokuapp.com/) team.

## News
### YouTube Videos
* [NAPALM Network Automation Python: Working with Huawei VRP](https://youtu.be/40Z-hcPHY_M) by Michael Alvarez
* [NAPALM Network Automation Python: Collect Data from Multiple Vendors. Cisco and Huawei](https://youtu.be/wBuKua1QsUE) by Michael Alvarez
* [NAPALM Network Automation Python: Making Configurations in a Multivendor Network. Cisco and Huawei](https://youtu.be/QnXhCzaSvBw) by Michael Alvarez



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/napalm-automation-community/napalm-huawei-vrp",
    "name": "napalm-huawei-vrp",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Locus Li",
    "author_email": "locus@byto.top",
    "download_url": "https://files.pythonhosted.org/packages/c4/f8/add74986039c34210b06aadec746370ebf9f8fd370284cc7d76405bb4f6e/napalm-huawei-vrp-1.1.0.tar.gz",
    "platform": null,
    "description": "[![PyPI](https://img.shields.io/pypi/v/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp)\n[![PyPI](https://img.shields.io/pypi/dm/napalm-huawei-vrp.svg)](https://pypi.python.org/pypi/napalm-huawei-vrp)\n\n# NAPALM Huawei VRP\n\nIt's a NAPALM Community Driver for Huawei VRP5/VRP8 Enterprise/Service Provider Routers and Switches.\n\nThis repository is reference [NAPALM-CE](https://github.com/napalm-automation-community/napalm-ce) and Cisco IOS code, thanks for thdDaniel's contribution\n[\u4e2d\u6587\u7248](README-ZH.md)\n\n## Supported Huawei Network Devices\n\n* NE Series: \n    * 40E, 8000\n* AR Series:\n    * 2200\n* ATN 900 Series:\n    * 910B, 910C and 910D\n* S Switch Series:\n    * S5700, S6700\n\nThis driver is not limited to these models and series, these are just devices where the driver have been tested.\n\n## Instructions\n\nThe driver is under development and iteration.\n\n### Get info\n| API   | Description  |\n|--------|-----|\n|  get_facts()                |  Return general device information |\n|  get_config()               |  Read config |\n|  get_arp_table()            |  Get device ARP table |\n|  get_mac_address_table()    |  Get mac table of connected devices |\n|  get_interfaces()           |  Get interface information |\n|  get_interfaces_ip()        |  Get interface IP information  |\n|  get_interfaces_counters()  |  Get interface counters  |\n|  get_lldp_neighbors()       |  Fetch LLDP neighbor information |\n\n\n### Config\n\n| API   | Description  |\n|--------|-----|\n|  cli()                      |  Send any cli commands  |\n|  load_merge_candidate()     |  Load config |\n|  compare_config()           |  A string showing the difference between the running configuration and the candidate configuration |\n|  discard_config()           |  Discards the configuration loaded into the candidate |\n|  commit_config()            |  Commits the changes requested by the method load_replace_candidate or load_merge_candidate |\n\n\n### Other tools\n| API   | Description  |\n|--------|-----|\n|  is_active()                |  get devices active status  |\n|  ping()                     |  Ping remote ip  |\n\n\n### Plans to develop\n\n* get_bgp_config\n* get_bgp_neighbors\n* get_bgp_neighbors_detail\n* get_environment\n* get_ipv6_neighbors_table\n* get_lldp_neighbors_detail\n* get_network_instances\n* get_ntp_peers\n* get_ntp_servers\n* get_ntp_stats\n* get_optics\n* get_route_to\n* get_snmp_information\n* get_users\n* get_vlans\n\n\n## How to Install\n\nYou can install napalm-huawei-vrp with pip:\n\n`pip install napalm-huawei-vrp`\n\nThat will install napalm and huawei_vrp driver currently available.\n\n## How to upgrade\n\nYou can upgrade napalm-huawei-vrp with pip once the new version released:\n\n`pip install --upgrade napalm-huawei-vrp`\n\ncheck the package version.\n\n`pip list | grep napalm-huawei-vrp`\n\n\n## Quick start\n\n```python\nfrom napalm import get_network_driver\ndriver = get_network_driver('huawei_vrp')\ndevice = driver(hostname='192.168.76.10', username='admin', password='this_is_not_a_secure_password')\ndevice.open()\n\n# Send Any CLI command\nsend_command = device.cli(['dis version'])\n\n#  Return general device information\nget_facts = device.get_facts()\nprint(get_facts)\n\n# other API\ndevice.get_config()\ndevice.get_arp_table()\ndevice.get_mac_address_table()\ndevice.get_interfaces()\ndevice.get_interfaces_ip()\ndevice.get_interfaces_counters()\ndevice.get_lldp_neighbors()\n\n```\n## Contact\n### Slack\n\nSlack is probably the easiest way to get help with NAPALM. You can find us in the channel napalm on the [network.toCode()](https://networktocode.herokuapp.com/) team.\n\n## News\n### YouTube Videos\n* [NAPALM Network Automation Python: Working with Huawei VRP](https://youtu.be/40Z-hcPHY_M) by Michael Alvarez\n* [NAPALM Network Automation Python: Collect Data from Multiple Vendors. Cisco and Huawei](https://youtu.be/wBuKua1QsUE) by Michael Alvarez\n* [NAPALM Network Automation Python: Making Configurations in a Multivendor Network. Cisco and Huawei](https://youtu.be/QnXhCzaSvBw) by Michael Alvarez\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Network Automation and Programmability Abstraction Layer with Multi-vendor support,Driver for Huawei Campus Network Switch,VRP OS",
    "version": "1.1.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dc6555802e461f52c19683dcb4ff07b4c70be6d067023cf08dd026d9beea24a0",
                "md5": "0f64cef287d3cbba968d262f703c48f6",
                "sha256": "7adc06e6abb3f61e20620cc3cac8d9195b4acff15aaec3c2ea4bed37b291c7c5"
            },
            "downloads": -1,
            "filename": "napalm_huawei_vrp-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0f64cef287d3cbba968d262f703c48f6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 25221,
            "upload_time": "2023-03-18T21:38:52",
            "upload_time_iso_8601": "2023-03-18T21:38:52.911050Z",
            "url": "https://files.pythonhosted.org/packages/dc/65/55802e461f52c19683dcb4ff07b4c70be6d067023cf08dd026d9beea24a0/napalm_huawei_vrp-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c4f8add74986039c34210b06aadec746370ebf9f8fd370284cc7d76405bb4f6e",
                "md5": "884f1a7902cd9cce0cd68857c9cadd46",
                "sha256": "a4988248d2d9dc4698b527328f84d5eb753c2f0186ef1304adb89e65f10a5cb1"
            },
            "downloads": -1,
            "filename": "napalm-huawei-vrp-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "884f1a7902cd9cce0cd68857c9cadd46",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22471,
            "upload_time": "2023-03-18T21:38:54",
            "upload_time_iso_8601": "2023-03-18T21:38:54.455245Z",
            "url": "https://files.pythonhosted.org/packages/c4/f8/add74986039c34210b06aadec746370ebf9f8fd370284cc7d76405bb4f6e/napalm-huawei-vrp-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-18 21:38:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "napalm-automation-community",
    "github_project": "napalm-huawei-vrp",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "napalm",
            "specs": [
                [
                    ">=",
                    "3.0.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "napalm-huawei-vrp"
}
        
Elapsed time: 0.12643s