NAPALM Documentation. Release 1. David Barroso

Transcription

1 NAPALM Documentation Release 1 David Barroso February 21, 2016

2

3 Contents 1 Supported Network Operating Systems 3 2 Documentation Tutorials Supported Devices Command Line Tool NetworkDriver i

4 ii

5 NAPALM (Network Automation and Programmability Abstraction Layer with Multivendor support) is a Python library that implements a set of functions to interact with different network device Operating Systems using a unified API. NAPALM supports several methods to connect to the devices, to manipulate configurations or to retrieve data. Contents 1

6 2 Contents

7 CHAPTER 1 Supported Network Operating Systems eos junos iosxr fortios ibm nxos ios You can select the driver you need by doing the following: >>> from napalm import get_network_driver >>> get_network_driver('eos') <class napalm.eos.eosdriver at 0x10ebad6d0> >>> get_network_driver('iosxr') <class napalm.iosxr.iosxrdriver at 0x10ec90050> >>> get_network_driver('junos') <class napalm.junos.junosdriver at 0x10f96f328> >>> get_network_driver('fortios') <class napalm.fortios.fortiosdriver at 0x10f96fc18> >>> get_network_driver('ibm') <class napalm.ibm.ibmdriver at 0x10f8f61f0> >>> get_network_driver('nxos') <class napalm.nxos.nxosdriver at 0x10f9304c8> >>> get_network_driver('ios') <class napalm.ios.iosdriver at 0x10f9b0738> Check the tutorials to see how to use the library in more detail, Suppoerted Devices will provide you with detailed support information and caveats and the NetworkDriver section explains which methods are available for you to use. 3

8 4 Chapter 1. Supported Network Operating Systems

9 CHAPTER 2 Documentation 2.1 Tutorials First Steps Manipulating Config NAPALM tries to provide a common interface and mechanisms to push configuration and retrieve state data from network devices. This method is very useful in combination with tools like Ansible, which in turn allows you to manage a set of devices independent of their network OS. Connecting to the Device Use the appropriate network driver to connect to the device: >>> from napalm import get_network_driver >>> driver = get_network_driver('eos') >>> device = driver(' ', 'dbarroso', 'this_is_not_a_secure_password') >>> device.open() Configurations can be replaced entirely or merged into the existing device config. You can load configuration either from a string or from a file. Replacing the Configuration To replace the configuration do the following: >>> device.load_replace_candidate(filename='test/unit/eos/new_good.conf') Note that the changes have not been applied yet. Before applying the configuration you can check the changes: >>> print device.compare_config() + hostname pyeos-unittest-changed - hostname pyeos-unittest router bgp vrf test + neighbor maximum-routes neighbor remote-as 1 - neighbor remote-as 1 - neighbor maximum-routes vrf test2 + neighbor remote-as 2 5

10 + neighbor maximum-routes neighbor remote-as 2 - neighbor maximum-routes interface Ethernet2 + description ble - description bla If you are happy with the changes you can commit them: >>> device.commit_config() On the contrary, if you don t want the changes you can discard them: >>> device.discard_config() Merging Configuration Merging configuration is similar, but you need to load the configuration with the merge method: >>> device.load_merge_candidate(config='hostname test\ninterface Ethernet2\ndescription bla') >>> print device.compare_config() configure hostname test interface Ethernet2 description bla end If you are happy with the changes you can commit them: >>> device.commit_config() On the contrary, if you don t want the changes you can discard them: >>> device.discard_config() Rollback Changes If for some reason you committed the changes and you want to rollback: >>> device.rollback() Disconnecting To close the session with the device just do: >>> device.close() Context Manager In the previous tutorial we used the methods open() to connect to the device and close() to disconnect. Using those methods are useful if you want to do complex or asynchronous code. However, for most situations you should try to stick with the context manager. It handles opening and closing the session automatically and it s the pythonic way: 6 Chapter 2. Documentation

11 >>> from napalm import get_network_driver >>> driver = get_network_driver('eos') >>> with driver('localhost', 'vagrant', 'vagrant', optional_args='port': 12443) as device:... print device.get_facts()... print device.get_interfaces_counters()... 'os_version': u' f f', 'uptime': 2010, 'interface_list': [u'ethernet1', u'ethern u'ethernet2': 'tx_multicast_packets': 1028, 'tx_discards': 0, 'tx_octets': , 'tx_errors': 0, 2.2 Supported Devices General support matrix _ EOS JunOS IOS- XR FortiOS IBM NXOS IOS Pluribus Driver Name eos junos iosxr fortios ibm nxos ios pluribus Structured data Yes Yes No No Yes Yes No No Minimum version F ??? 6.1??? N/A Backend library pyeapi junoseznc pyiosxr pyfg bnclient pycsco netmiko py- Pluribus Caveats EOS FortiOS IBM Networking Operating System NXOS IOS Warning: Please, make sure you understand the caveats for your particular platforms before using the library Configuration support matrix _ EOS JunOS IOS-XR FortiOS IBM NXOS IOS Pluribus Config. replace Yes Yes Yes Yes Yes 3 Yes Yes No Config. merge Yes Yes Yes Yes Yes Yes Yes No Compare config Yes Yes Yes 1 Yes 1 Yes 1 Yes 4 Yes No Atomic Changes Yes Yes Yes No 2 No 2 Yes/No 5 Yes Yes Rollback Yes 2 Yes Yes Yes Yes 2 Yes/No 5 Yes No Warning: Before building a workflow to deploy configuration it is important you understand what the table above means; what are atomic changes and which devices support it, what does replacing or merging configuration mean, etc. The key to success is to test your workflow and to try to break things on a lab first. 3 Check the caveats, this is a dangerous operation in this device. 1 Hand-crafted by the API as the device doesn t support the feature. 4 For merges, the diff is simply the merge config itself. See caveats. 2 Not supported but emulated. Check caveats. 5 No for merges. See caveats Supported Devices 7

12 2.2.3 Getters support matrix _ EOS JunOS IOS-XR FortiOS IBM NXOS IOS Pluribus cli get_facts get_interfaces get_lldp_neighbors get_lldp_neighbors_detail get_bgp_neighbors get_bgp_neighbors_detail get_bgp_config get_environment get_mac_address_table get_snmp_information get_ntp_peers Caveats EOS Minimum Version To be able to support the compare_config method you will require to run at least EOS version F. Rollback The rollback feature is supported only when committing from the API. In reality, what the API does during the commit operation is as follows: copy startup-config flash:rollback-0 And the rollback does: configure replace flash:rollback-0 This means that the rollback will be fine as long as you only use this library. If you are going to do changes outside this API don t forget to mark your last rollback point manually. FortiOS Rollback To make sure the rollback feature works either use only this API to do changes or remember to save your rollback points on the CLI with the command: execute backup config flash your_message Atomic Changes FortiOS plugin will use the batch feature. All commands will not go at the same time but all of them will be processed. The sad true is that FortiOS doesn t have any proper tool to apply large chunks of configuration. 8 Chapter 2. Documentation

13 IBM Networking Operating System Rollback Rollback is simply implemented by reading current running configuration before any load actions. Rollback function executes load replace and commit. Atomic Changes IBM plugin uses netconf to load configuration on to device. It seems that configuration is executed line by line but we can be sure that all lines will be executed. There are three options for error handling: stop-on-error, continue-on-error and rollback-on-error. Plugin uses rollback-on-error option in case of merge operation. However replace operation uses continue-on-error option. In case of typo in configuration, device will inform plugin about error but execute all the rest lines. Plugin will revert configuration using rollback function from the plugin. I do not use rollback-on-error for replace operation because in case of error device is left without any configuration. It seems like a bug. It will be investigated further. Moreover it seems that replace option wipe out whole configuration on device at the first step, so this option is good for provisioning of new device and it is not recomended for device in production. NXOS Notes on configuration replacement Config files aren t aren t normal config files but special checkpoint files. That s because on NXOS the only way to replace a config without reboot is to rollback to a checkpoint (which could be a file). These files explicitly list a lot of normally implicit config lines, some of them starting with #. The # part isn t necessary for the rollback to work, but leaving these lines out can cause erratic behavior. See the Known gotchas section below. Prerequisites Your device must be running NXOS 6.1. The features nxapi server scp-server must be enabled. On the device and any checkpoint file you push, you must have the lines: feature scp-server feature nxapi Getting a base checkpoint file An example of a checkpoint file can be seen in test/unit/nxos/new_good.conf. You can get a checkpoint file representing your device s current config by running the get_checkpoint_file() function in the napalm.nxos driver. Known gotchas Leaving out a shutdown or no shutdown line will cause the switch to toggle the up/down state of an interface, depending on it s current state. #switchport trunk allowed vlan is required even if the switchport is in switchport mode access. However if #switchport trunk allowed vlan is included with no switchport, the configuration replacement will fail. Vlans are listed vertically. For example vlan 1, 10, 20, 30 will fail. To succeed, you need: vlan 1 vlan 10 vlan 20 vlan Supported Devices 9

14 Diffs Diffs for config replacement are a list of commands that would be needed to take the device from it s current state to the desired config state. See test/unit/nxos/new_good.diff as an example. Notes on configuration merging Merges are currently implemented by simply applying the the merge config line by line. This doesn t use the checkpoint/rollback functionality. As a result, merges are not atomic. Diffs Diffs for merges are simply the lines in the merge candidate config. IOS Prerequisites IOS has no native API to play with, that s the reason why we used the Netmiko library to interact with it. Having Netmiko installed in your working box is a prerequisite. Archive IOSDriver relies on the archive functionality to be able to manipulate configuration, make sure it s enabled: archive path bootflash:archive write-memory Optional arguments NAPALM supports passing certain optional arguments to some drivers. To do that you have to pass a dictionary via the optional_args parameter when creating the object: >>> from napalm import get_network_driver >>> driver = get_network_driver('eos') >>> optional_args = 'my_optional_arg1': 'my_value1', 'my_optional_arg2': 'my_value2' >>> device = driver(' ', 'dbarroso', 'this_is_not_a_secure_password', optional_args=optio >>> device.open() List of supported optional arguments fortios_vdom (fortios) - VDOM to connect to. port (eos, iosxr, junos, ios) - Allows you to specify a port other than the default. config_lock (junos) - Lock the config during open() (default: True). Adding optional arguments to NAPALM drivers If you are a developer and want to add an optional argument to a driver, please, follow this pattern when naming the argument; $driver_name-$usage if the argument applies only to a particular driver. For example, the optional argument fortios_vdom is used only by the FortiOS driver to select a particular vdom. Otherwise, just name it $driver_name-$usage. For example the port optional argument. 10 Chapter 2. Documentation

15 2.3 Command Line Tool NAPALM ships with a simple CLI tool to help you deploying configuration to your devices directly from the shell. It might be convenient for simple bash scripts or provisioning tools that rely on a shell. The usage is very simple. For example, let s do a dry run (changes will not be applied) and check the changes between my current configuration and a new candidate configuration: # cl_napalm_configure --user vagrant --vendor eos --strategy replace --optional_args 'port=12443' --d Enter -2,30 boot system flash:/veos-lab.swi -event-handler dhclient - trigger on-boot - action bash sudo /mnt/flash/initialize_ma1.sh +transceiver qsfp default-mode 4x10G -transceiver qsfp default-mode 4x10G +hostname pyeos-unittest-changed spanning-tree mode mstp aaa authorization exec default local -aaa root secret 5 $1$b4KXboe4$yeTwqHOKscsF07WGoOnZ0. +no aaa root -username admin privilege 15 role network-admin secret 5 $1$nT3t1LkI$1f.SG5YaRo6h4LlhIKgTK. -username vagrant privilege 15 role network-admin secret 5 $1$589CDTZ0$9S4LGAiCpxHCOC17jECxt1 +username admin privilege 15 role network-admin secret 5 $1$RT/92Zg9$J8wD1qPAdQBcOhv4fefyt. +username vagrant privilege 15 role network-admin secret 5 $1$Lw2STh4k$bPEDVVTY2e7lf.vNlnNEO0 interface Ethernet1 interface Ethernet2 + description ble interface Management1 ip address /24 no ip routing +router bgp vrf test + neighbor remote-as 1 + neighbor maximum-routes vrf test2 + neighbor remote-as 2 + neighbor maximum-routes management api http-commands no shutdown # 2.3. Command Line Tool 11

16 We got the diff back. Now let s try a partial configuration instead. However, this time we will directly apply the configuration and we will also be passing the password directly as an argument: # cl_napalm_configure --user vagrant --password vagrant --vendor eos --strategy merge -7,6 action bash sudo /mnt/flash/initialize_ma1.sh transceiver qsfp default-mode 4x10G + +hostname NEWHOSTNAME spanning-tree mode -20,6 interface Ethernet1 interface Ethernet2 + description BLALALAL interface Management1 ip address /24 # We got the diff back in the stdout. If we try to run the command we should get an empty string: # cl_napalm_configure --user vagrant --password vagrant --vendor eos --strategy merge --optional_args # Errors are detected as well: # cl_napalm_configure --user vagrant --password vagrant --vendor eos --strategy merge --optional_args Traceback (most recent call last): File "/Users/dbarroso/.virtualenvs/test/bin/cl_napalm_configure", line 9, in <module> load_entry_point('napalm==0.50.3', 'console_scripts', 'cl_napalm_configure')() File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ args.optional_args, args.config_file, args.dry_run)) File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ return diff File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ self. raise_clean_exception(exc_type, exc_value, exc_traceback) File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ strategy_method(filename=config_file) File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ self._load_config(filename, config, False) File "/Users/dbarroso/.virtualenvs/test/lib/python2.7/site-packages/napalm py2.7.egg/napalm/ raise MergeConfigException(e.message) napalm.exceptions.mergeconfigexception: Error [1002]: CLI command 5 of 5 'descriptin BLALALAL' failed For more information, run cl_napalm_configure --help. 2.4 NetworkDriver class napalm.base.networkdriver(hostname, username, password, timeout, optional_args) This is the base class you have to inherit from when writing your own Network Driver to manage any device. You will, in addition, have to override all the methods specified on this class. Make sure you follow the guidelines for every method and that you return the correct data. Parameters 12 Chapter 2. Documentation

17 Returns hostname (str) IP or FQDN of the device you want to connect to. username (str) Username you want to use password (str) Password timeout (int) Time in seconds to wait for the device to respond. optional_args (dict) Pass additional arguments to underlying driver cli(*commands) Will execute a list of commands and return the output in a dictionary format. For example: u'show version and haiku': u'''hostname: re0.edge01.arn01 Model: mx480 Junos: 13.3R6.5 Help me, Obi-Wan I just saw Episode Two You're my only hope ''', u'show chassis fan' : u'''item Status RPM Measurement Top Rear Fan OK 3840 Spinning at i Bottom Rear Fan OK 3840 Spinning at i Top Middle Fan OK 3900 Spinning at i Bottom Middle Fan OK 3840 Spinning at i Top Front Fan OK 3810 Spinning at i Bottom Front Fan OK 3840 Spinning at i ''' close() Closes the connection to the device. commit_config() Commits the changes requested by the method load_replace_candidate or load_merge_candidate. compare_config() Returns A string showing the difference between the running configuration and the candidate configuration. The running_config is loaded automatically just before doing the comparison so there is no need for you to do it. discard_config() Discards the configuration loaded into the candidate. get_arp_table() Returns a list of dictionaries having the following set of keys: interface (string) mac (string) ip (string) age (float) For example: 2.4. NetworkDriver 13

18 [ ], 'interface' : 'MgmtEth0/RSP0/CPU0/0', 'mac' : '5c:5e:ab:da:3c:f0', 'ip' : ' ', 'age' : 'interface': 'MgmtEth0/RSP0/CPU0/0', 'mac' : '66:0e:94:96:e0:ff', 'ip' : ' ', 'age' : get_bgp_config(group=, neighbor= ) Returns a dictionary containing the BGP configuration. Can return either the whole config, either the config only for a group or neighbor. Main dictionary keys represent the group name and the values represent a dictionary having the following keys: type (str) description (str) apply_groups (str list) multihop_ttl (int) multipath (boolean) local_address (str) local_as (int) peer_as (int) import_policy (str) export_policy (str) remove_private (boolean) prefix_limit (dict) neighbors (dict) Neighbors is a dictionary of dictionaries with the following keys: description (str) import_policy (str) export_policy (str) local_address (str) local_as (int) peer_as (int) authentication_key (str) prefix_limit (dict) route_reflector (bool) 14 Chapter 2. Documentation

19 nhs (bool) The inner dictionary prefix_limit has the same structure for both layers: [FAMILY_NAME]: [FAMILY_TYPE]: limit : [LIMIT],... other options For example: 'PEERS-GROUP-NAME': 'type' : u'external', 'description' : u'here we should have a nice description', 'apply_groups' : [u'bgp-prefix-limit'], 'import_policy' : u'public-peer-in', 'export_policy' : u'public-peer-out', 'remove_private': True, 'multipath' : True, 'multihop_ttl' : 30, 'neighbors' : ' ': 'description' : 'Facebook [CDN]', 'prefix_limit' : 'inet': 'unicast': 'limit': 100, 'teardown': 'threshold' : 95, 'timeout' : 5 'peer-as' : 32934, 'route_reflector': False, 'nhs' : True, ' ': 'description' : 'Twitter [CDN]', 'prefix_limit' : 'inet': 'unicast': 'limit': 500, 'no-validate': 'IMPORT-FLOW-ROUTES' 'peer_as' : 'route_reflector': False, 'nhs' : False 2.4. NetworkDriver 15

20 get_bgp_neighbors() Returns a dictionary of dictionaries. The keys for the first dictionary will be the vrf (global if no vrf). The inner dictionary will contain the following data for each vrf: router_id peers - another dictionary of dictionaries. Outer keys are the IPs of the neighbors. The inner keys are: local_as (int) remote_as (int) remote_id - peer router id is_up (True/False) is_enabled (True/False) description (string) uptime (int in seconds) address_family (dictionary) - A dictionary of address families available for the neighbor. So far it can be i * received_prefixes (int) * accepted_prefixes (int) * sent_prefixes (int) get_bgp_neighbors_detail(neighbor_address= ) Returns a detailed view of the BGP neighbors as a dictionary of lists. The keys of the dictionary represent the AS number of the neighbors. Inner dictionaries contain the following fields: up (boolean) local_as (int) remote_as (int) local_address (unicode) local_address_configured (boolean) local_port (int) remote_address (unicode) remote_port (int) multihop (boolean) import_policy (unicode) export_policy (unicode) input_messages (int) output_messages (int) input_updates (int) output_updates (int) messages_queued_out (int) connection_state (unicode) 16 Chapter 2. Documentation

21 previous_connection_state (unicode) last_event (unicode) suppress_4byte_as (boolean) local_as_prepend (boolean) holdtime (int) configured_holdtime (int) keepalive (int) configured_keepalive (int) active_prefix_count (int) received-prefix-count (int) accepted-prefix-count (int) suppressed-prefix-count (int) advertised-prefix-count (int) flap_count (int) For example: 8121: [ 'up' : True, 'local_as' : 13335, 'remote_as' : 8121, 'local_address' : u' ', 'local_address_configured' : True, 'local_port' : 179, 'remote_address' : u' ', 'remote_port' : 58380, 'multihop' : False, 'import_policy' : u'4-ntt-transit-in', 'export_policy' : u'4-ntt-transit-out', 'input_messages' : 123, 'output_messages' : 13, 'input_updates' : 123, 'output_updates' : 5, 'messages_queued_out' : 23, 'connection_state' : u'established', 'previous_connection_state' : u'estabsync', 'last_event' : u'recvkeepalive', 'suppress_4byte_as' : False, 'local_as_prepend' : False, 'holdtime' : 90, 'configured_holdtime' : 90, 'keepalive' : 30, 'configured_keepalive' : 30, 'active_prefix_count' : , 'received_prefix_count' : , 'accepted_prefix_count' : , 'suppressed_prefix_count' : 0, 'advertise_prefix_count' : 0, 'flap_count' : NetworkDriver 17

22 ] get_environment() Returns a dictionary where: get_facts() fans is a dictionary of dictionaries where the key is the location and the values: status (boolean) - True if it s ok, false if it s broken temperature is a dictionary of dictionaries where the key is the location and the values: temperature (float) - Temperature in celsius the sensor is reporting. is_alert (boolean) - True if the temperature is above the alert threshold is_critical (boolean) - True if the temperature is above the critical threshold power is a dictionary of dictionaries where the key is the PSU id and the values: status (boolean) - True if it s ok, false if it s broken capacity (float) - Capacity in W that the power supply can support output (float) - Watts drawn by the system cpu is a dictionary of dictionaries where the key is the ID and the values %usage memory is a dictionary with: available_ram (int) - Total amount of RAM installed in the device used_ram (int) - RAM in use in the device Returns a dictionary containing the following information: For example: uptime - Uptime of the device in seconds. vendor - Manufacturer of the device. model - Device model. hostname - Hostname of the device fqdn - Fqdn of the device os_version - String with the OS version running on the device. serial_number - Serial number of the device interface_list - List of the interfaces of the device 'uptime': , 'vendor': u'arista', 'os_version': u' gaatlantarel', 'serial_number': u'sn0123a34as', 'model': u'veos', 'hostname': u'eos-router', 'fqdn': u'eos-router', 18 Chapter 2. Documentation

23 'interface_list': [u'ethernet2', u'management1', u'ethernet1', u'ethernet3'] get_interfaces() Returns a dictionary of dictionaries. The keys for the first dictionary will be the interfaces in the devices. The inner For example: is_up (True/False) is_enabled (True/False) description (string) last_flapped (int in seconds) speed (int in Mbit) mac_address (string) u'management1': 'is_up': False, 'is_enabled': False, 'description': u'', 'last_flapped': -1, 'speed': 1000, 'mac_address': u'dead:beef:dead',, u'ethernet1': 'is_up': True, 'is_enabled': True, 'description': u'foo', 'last_flapped': , 'speed': 1000, 'mac_address': u'beef:dead:beef',, u'ethernet2': 'is_up': True, 'is_enabled': True, 'description': u'bla', 'last_flapped': , 'speed': 1000, 'mac_address': u'beef:beef:beef',, u'ethernet3': 'is_up': False, 'is_enabled': True, 'description': u'bar', 'last_flapped': -1, 'speed': 1000, 'mac_address': u'dead:dead:dead', 2.4. NetworkDriver 19

24 get_interfaces_counters() Returns a dictionary of dictionaries where the first key is an interface name and the inner dictionary contains the following keys: tx_errors (int) rx_errors (int) tx_discards (int) rx_discards (int) tx_octets (int) rx_octets (int) tx_unicast_packets (int) rx_unicast_packets (int) tx_multicast_packets (int) rx_multicast_packets (int) tx_broadcast_packets (int) rx_broadcast_packets (int) Example: u'ethernet2': 'tx_multicast_packets': 699, 'tx_discards': 0, 'tx_octets': 88577, 'tx_errors': 0, 'rx_octets': 0, 'tx_unicast_packets': 0, 'rx_errors': 0, 'tx_broadcast_packets': 0, 'rx_multicast_packets': 0, 'rx_broadcast_packets': 0, 'rx_discards': 0, 'rx_unicast_packets': 0, u'management1': 'tx_multicast_packets': 0, 'tx_discards': 0, 'tx_octets': , 'tx_errors': 0, 'rx_octets': , 'tx_unicast_packets': 1241, 'rx_errors': 0, 'tx_broadcast_packets': 0, 'rx_multicast_packets': 0, 'rx_broadcast_packets': 80, 'rx_discards': 0, 'rx_unicast_packets': 0, u'ethernet1': 'tx_multicast_packets': 293, 'tx_discards': 0, 'tx_octets': 38639, 20 Chapter 2. Documentation

25 'tx_errors': 0, 'rx_octets': 0, 'tx_unicast_packets': 0, 'rx_errors': 0, 'tx_broadcast_packets': 0, 'rx_multicast_packets': 0, 'rx_broadcast_packets': 0, 'rx_discards': 0, 'rx_unicast_packets': 0 get_lldp_neighbors() Returns a dictionary where the keys are local ports and the value is a list of dictionaries with the following informati hostname port For example: u'ethernet2': [ 'hostname': u'junos-unittest', 'port': u'520', ], u'ethernet3': [ 'hostname': u'junos-unittest', 'port': u'522', ], u'ethernet1': [ 'hostname': u'junos-unittest', 'port': u'519',, 'hostname': u'ios-xrv-unittest', 'port': u'gi0/0/0/0', ], u'management1': [ 'hostname': u'junos-unittest', 'port': u'508', ] get_lldp_neighbors_detail(interface= ) Returns a detailed view of the LLDP neighbors as a dictionary containing lists of dictionaries for each 2.4. NetworkDriver 21

26 interface. Inner dictionaries contain fields: parent_interface (string) interface_description (string) remote_port (string) remote_port_description (string) remote_chassis_id (string) remote_system_name (string) remote_system_description (string) remote_system_capab (string) remote_system_enabled_capab (string) For example: 'TenGigE0/0/0/8': [ 'parent_interface': u'bundle-ether8', 'interface_description': u'tengige0/0/0/8', 'remote_chassis_id': u'8c60.4f69.e96c', 'remote_system_name': u'switch', 'remote_port': u'eth2/2/1', 'remote_port_description': u'ethernet2/2/1', 'remote_system_description': u'''cisco Nexus Operating System (NX-OS) Software 7 TAC support: Copyright (c) , Cisco Systems, Inc. All rights reserved.''', 'remote_system_capab': u'b, R', 'remote_system_enable_capab': u'b' ] load_merge_candidate(filename=none, config=none) Populates the candidate configuration. You can populate it from a file or from a string. If you send both a filename and a string containing the configuration, the file takes precedence. If you use this method the existing configuration will be merged with the candidate configuration once you commit the changes. This method will not change the configuration by itself. Parameters filename Path to the file containing the desired configuration. By default is None. config String containing the desired configuration. Raises MergeConfigException If there is an error on the configuration sent. load_replace_candidate(filename=none, config=none) Populates the candidate configuration. You can populate it from a file or from a string. If you send both a filename and a string containing the configuration, the file takes precedence. If you use this method the existing configuration will be replaced entirely by the candidate configuration once you commit the changes. This method will not change the configuration by itself. Parameters 22 Chapter 2. Documentation

27 filename Path to the file containing the desired configuration. By default is None. config String containing the desired configuration. Raises ReplaceConfigException If there is an error on the configuration sent. open() Opens a connection to the device. rollback() If changes were made, revert changes to the original state NetworkDriver 23

28 24 Chapter 2. Documentation

29 Index C cli() (napalm.base.networkdriver method), 13 close() (napalm.base.networkdriver method), 13 commit_config() (napalm.base.networkdriver method), 13 compare_config() (napalm.base.networkdriver method), 13 D discard_config() (napalm.base.networkdriver method), 13 G get_arp_table() (napalm.base.networkdriver method), 13 get_bgp_config() (napalm.base.networkdriver method), 14 get_bgp_neighbors() (napalm.base.networkdriver method), 15 get_bgp_neighbors_detail() (napalm.base.networkdriver method), 16 get_environment() (napalm.base.networkdriver method), 18 get_facts() (napalm.base.networkdriver method), 18 get_interfaces() (napalm.base.networkdriver method), 19 get_interfaces_counters() (napalm.base.networkdriver method), 19 get_lldp_neighbors() (napalm.base.networkdriver method), 21 get_lldp_neighbors_detail() (napalm.base.networkdriver method), 21 L load_merge_candidate() method), 22 load_replace_candidate() method), 22 N NetworkDriver (class in napalm.base), 12 (napalm.base.networkdriver (napalm.base.networkdriver O open() (napalm.base.networkdriver method), 23 R rollback() (napalm.base.networkdriver method), 23 25