Files
napalm-s350/README.md
4d86beea46 Update interface_counters from develop (#96)
* adding read_timeout_override netmiko option

* adding netmiko option session_log

* Bump black from 20.8b1 to 24.3.0

Bumps [black](https://github.com/psf/black) from 20.8b1 to 24.3.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](https://github.com/psf/black/commits/24.3.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

* remove demjson - blocking tests

* FIX minor formating fixes raised by pylama

* FIX limit napalm and netmiko o version 3.*, soften version requirements

* FIX minor formating fixes raised by pylama

* Allow testing on all supported Py versions

* FIX add platform name to driver s350

* FIX force interface speed as a float

* Update information about required versions to Py3.8+ and napalm 3

* Add scheduled check on develop branch

* Update pkg version in setup.py

* Update PublishToPIP.yml for manual run

* Napalm 4 compatibility, newer dependencies

* Full tox testing on "develop" and "master" branch.

* Remove Py13 - too early

* Do not test on PyPy, local test with local Py version only

* CI ThoroughTest for branches develop and master

* CI FastTest for all other branches.

* CI rename legacy jobs

* CI renaname job

* Updata docs

* Shorten name of publish workflow

* Check syntax for Py3.12

* use netmiko_args

* Add changes for 4.1.0 (#89)

* Update requirements.txt

* Typpo in requirements

* _send_command has only two parameters

* Adapt to stricter Unit tests

---------

Co-authored-by: Anton Gridnev <anton@gridnev.pro>

* Remove s350_base_interfaces custom map - it is allready in napalm base

* Adapt Unit tests to canonical_interface_name()

* Add format parameter to get_config()

* Add badges

* Tests for push are enought

* update CD actions

* add tests for device SG500-52

* Merge CI to develop (#95)

* Simplify CI

* CI update

* CI update

* Update CI from develop (#94)

* Add format parameter to get_config()

* Add badges

* Tests for push are enought

* update CD actions

* add tests for device SG500-52

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Dave <davama@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Anton Gridnev <anton@gridnev.pro>
2024-04-23 12:45:29 +02:00

138 lines
7.2 KiB
Markdown

# Napalm-s350
NAPALM driver for Cisco SMB switches (SF3xx, SF5xx, SG3xx, SG5xx, CBS35x).
## Status
Master: [![Thorough Test](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/ThoroughTest.yml/badge.svg?branch=master)](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/ThoroughTest.yml)
Develop: [![Thorough Test](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/ThoroughTest.yml/badge.svg?branch=develop)](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/ThoroughTest.yml)
PyPi.org: [![Publish To PyPi.org](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/PublishToPIP.yml/badge.svg?branch=master)](https://github.com/napalm-automation-community/napalm-s350/actions/workflows/PublishToPIP.yml)
## Requirements
Python 3.8+, napalm 4
## Installation
```bash
pip3 install napalm_s350
```
## CLI test
Default information (the same as `call get_facts`)
```bash
napalm --user USER --password PASSWORD --vendor s350 HOSTNAME
napalm --user USER --password PASSWORD --vendor s350 HOSTNAME --optional_args "force_no_enable=True"
```
Get interfaces
```bash
napalm --user USER --password PASSWORD --vendor s350 HOSTNAME call get_interfaces
```
Get configuration file
```bash
napalm --user USER --password PASSWORD --vendor s350 HOSTNAME call get_config
```
Debug
```bash
napalm --user USER --password PASSWORD --vendor s350 --debug HOSTNAME
```
## Supported devices
This driver initially targets the Cisco SG350 device though other, similar, devices may
be supported.
| function | SG300 | SG500 | SG350 | SG550 | stack SG500 | stack SG550 | CBS350 |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| **Send commands** |
| cli | x | x | x | x | x | x | x |
| **Config manipulation** |
|get_config | x | x | x | x | | | x |
|get_config (filtered) | x | x | x | x | | | x |
|get_config (sanitized) | x | x | x | x | | | x |
|load_merge_candidate | | | | | | | |
|load_replace_candidate | | | | | | | |
|compare_config | | | | | | | |
|commit_config | | | | | | | |
|confirm_commit | | | | | | | |
|has_pending_commit | | | | | | | |
|rollback | | | | | | | |
|discard_config | | | | | | | |
|compliance_report | | | | | | | |
|load_template | | | | | | | |
| **Get information** |
|get_arp_table | x | x | x | x | | | x |
|get_arp_table (with vrf) | NS | NS | NS | NS | | | NS |
|get_bgp_config | | | | | | | |
|get_bgp_neighbors | | | | | | | |
|get_bgp_neighbors_detail | | | | | | | |
|get_environment | | | | | | | |
|get_facts | x | x | x | x | | | x |
|get_firewall_policies | | | | | | | |
|get_interfaces | x | x | x | x | | | x |
|get_interfaces_counters | | | | | | | |
|get_interfaces_ip | x 4 | x 4 | x 4 | x 4 | | | x 4 |
|get_ipv6_neighbors_table | | | | | | | |
|get_lldp_neighbors | x | x | x | x | | | x |
|get_lldp_neighbors_detail | x | x | x | x | | | x |
|get_mac_address_table | | | | | | | |
|get_network_instances | | | | | | | |
|get_ntp_peers | | | | | | | |
|get_ntp_servers | x | x | x | x | | | x |
|get_ntp_stats | | | | | | | |
|get_optics | | | | | | | |
|get_probes_config | | | | | | | |
|get_probes_results | | | | | | | |
|get_route_to | | | | | | | |
|get_snmp_information | | | | | | | |
|get_users | | | | | | | |
|get_vlans | x | x | x | x | | | x |
| **Other actions** |
|is_alive | | | | | | | |
|ping | | | | | | | |
|traceroute | | | | | | | |
NS - not supported - devices do not have support for that feature
4 - IPv4 only ...
## Want to add new device support?
To be sure we can support new device we use test files.
We need text output of those commands, to add new device:
```
show arp
show startup-config
show version
show system
show inventory
show hosts
show interface status
show running-config
show interfaces status
show interfaces description
show ports jumbo-frame
show ip int
show lldp neighbors
show sntp status
```
Those commands may need parameter change to suit your configuration:
```
show running-config full
show lldp local FastEthernet1
show lldp neighbors FastEthernet0/1
```
Please add each command to separate file - command `show arp` to file named `show_arp.txt`
Make pull request to /napalm-s350/tree/develop/test/unit/mocked_data/`your device type`/
or if you prefer make a Issue and add files as an atachement.