https://github.com/napalm-automation-community/napalm-asa

napalm-asa
https://github.com/napalm-automation-community/napalm-asa

Last synced: about 2 months ago
JSON representation

napalm-asa

• Host: GitHub
• URL: https://github.com/napalm-automation-community/napalm-asa
• Owner: napalm-automation-community
• License: apache-2.0
• Created: 2016-12-12T06:01:56.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-03-20T15:50:41.000Z (10 months ago)
• Last Synced: 2024-09-18T09:28:39.436Z (4 months ago)
• Language: Python
• Size: 84 KB
• Stars: 17
• Watchers: 10
• Forks: 13
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/napalm-automation-community/napalm-asa.svg?branch=master)](https://travis-ci.org/napalm-automation-community/napalm-asa)

[![PyPI](https://img.shields.io/pypi/v/napalm-asa.svg)](https://pypi.python.org/pypi/napalm-asa)

# napalm-asa

This is a [NAPALM](https://github.com/napalm-automation/napalm) community driver for the Cisco ASA platform.

## Minimum Requirements

This driver makes use of the Cisco ASA REST API.  The REST API is only available from software version 9.3.2 and up, and on the 5500-X series, ASAv, ASA on Firepower and ISA 3000 platforms.

For latest information on the ASA REST API Compatibility check the [compatibility matrix(PDF)](http://www.cisco.com/c/en/us/td/docs/security/asa/compatibility/asamatrx.html#pgfId-131643)

## Quick start

```shell

pip install napalm-asa

```

```python

from napalm import get_network_driver

driver = get_network_driver("asa")

device = driver(hostname='192.168.1.1', username='cisco', password="cisco", optional_args = {'port': 8443})

device.open()

facts = device.get_facts()

device.close()

```

Check the full [NAPALM Docs](https://napalm.readthedocs.io/en/latest/index.html) for more detailed instructions.

## Supported Getters

| Getter                    | Support  |

|---------------------------|----------|

| get_arp_table             |  ✅      |

| get_bgp_config            |  ❌      |

| get_bgp_neighbors         |  ❌      |

| get_bgp_neighbors_detail  |  ❌      |

| get_config                |  ✅      |

| get_environment           |  ❌      |

| get_facts                 |  ✅      |

| get_firewall_policies     |  ❌      |

| get_interfaces            |  ✅      |

| get_interfaces_counters   |  ❌      |

| get_interfaces_ip         |  ✅      |

| get_ipv6_neighbors_table  |  ❌      |

| get_lldp_neighbors        |  ❌      |

| get_lldp_neighbors_detail |  ❌      |

| get_mac_address_table     |  ❌      |

| get_network_instances     |  ❌      |

| get_ntp_peers             |  ❌      |

| get_ntp_servers           |  ❌      |

| get_ntp_stats             |  ❌      |

| get_optics                |  ❌      |

| get_probes_config         |  ❌      |

| get_probes_results        |  ❌      |

| get_route_to              |  ❌      |

| get_snmp_information      |  ❌      |

| get_users                 |  ❌      |

| is_alive                  |  ✅      |

| ping                      |  ❌      |

| traceroute                |  ❌      |

## Setting up a Lab Environment

Mock tests are usefull for quickly iterating when writing a new getter of fixing a bug, but you do want to test on a 'real' device to make sure everything works as expected. One of the most convenient ways is to use an ASAv running on Virtualbox + Vagrant. @bobthebutcher has a nice write up on [how to setup an ASAv with Vagrant.](https://codingpackets.com/blog/cisco-asa-vagrant-box-install/)