Py-Networking. Release unknown. Reference Manual

Transcription

1 Py-Networking Release unknown Reference Manual May 26, 2014

2

3 Contents 1 Getting Started What is Py-Networking? Notice Install License Device Class Constructor Methods Properties Facts 7 4 Interface Feature Interface Naming Convention Operations Methods Parameters Vlan Feature Operations Methods Parameters Cookbook 17 7 Developing Py-Networking 19 i

4 ii

5 CHAPTER 1 Getting Started 1.1 What is Py-Networking? Py-Networking (PN) is a python library that provides a new way to interact and configure your networking devices. PN abstract the physical device and provides to the user an uniform API that does not depends from the specific device configuration or configuration syntax. PN does not emulate features that device maybe missing but if two different devices implement a specific feature, this is exposed to the user in the same way. 1.2 Notice Py-Networking is at early stages of development. You are free to look around but we do not provide support at the moment and the library can go throughout a significant changes and backward compatibility cannot be guaranteed. 1.3 Install Installation of Py-Networking can be done from pypi repository (recommended method) or from source code. Assuming that your system has python and pip command installed: pip install py-networking Pypi repository contains the latest stable version so if you want to work with a newer version and or want to do development on the library you need to install from source. Assuming you have python and git command installed: git clone cd py-networking python setup.py install For further information on how to develop and contribute to py-networking refer to Developing Py-Networking chapter. Note: On Mac OS X follow the following steps before invoking pip Check if gcc is already installed. If trying to run gcc on the terminal you get the following output: $ gcc clang: error: no input files 1

6 gcc is already installed. Otherwise you will a dialog box asking you if you want to Get Xcode or Install. PRESS INSTALL and not Get Xcode unless you want to install the full development environment Install Homebrew: ruby -e "$(curl -fssl and then: brew install python brew install zmq 1.4 License Apache Chapter 1. Getting Started

7 CHAPTER 2 Device Class 2.1 Constructor Device(host, username= manager, password= friend, protocol= ssh, port= auto, os= auto, log_level= NOTSET, log_output= console:, connection_timeout=20) Description Create a device object that represent the physical networking device. Parameters: host: string The host or ip address of the device. username: string The username of the device user with enough privilages to interact with the device. Usually is the superuser. protocol: string The protocol used to interact with the device. Currently only ssh is supported. port: string The tcp or udp port where the device object will connect to with the protocol of choice. Setting auto will select the default port of the protocol so for ssh will be 22. os: string The operating system used by the device. Setting auto will leave to the Device to detect the os. The currently supported os are: awp: Allied Telesis switches with AlliedWare Plus ats: Allied Telesis AT-8000S/xx switches log_level: string The level of logging generated by the Device object. By default no logging is generated. The supported log levels with increasing verbosity are: NOTSET (disable logging and default), CRITICAL, WARN, INFO, DEBUG. log_output: string Where logging is sent. By default the logging is sent to the standard output of the process but it can be saved on a file. In this case the prefix the relative path and the file name with the prefix file://. connection_timeout: int In case of connection oriented protocols, like telnet or ssh, the Device will connect to the physical device when commands need to be issued and will tear it down after a number of seconds expressed by this parameters are passed. Return a device object if creator succeed Example This example instantiate a device object with ssh service enabled at address The os is auto detected and username/password are the default manager/friend. The log level verbosity is increased to INFO 3

8 and log is shown on the standard output. The object does not connect to the physical device until open method is executed.: form pynetworking import Device dev = Device( , log_level= INFO ) 2.2 Methods close close() Description: Tear down the connection with the physical device and free up all the associated resources Parameters: None Return None cmd cmd(cmds) Description: Issue native commands to the device Parameters: cmds: string or dictionary Return The output of the command(s) open open() Description: Open the connection with the physical device and loads the facts and features applicable to it. Parameters: None Return None Example This example open a connection with the device and prints its facts: form pynetworking import Device from pprint import pprint dev = Device( , log_level= INFO, log_output= file://192_168_1_10.log ) dev.open() pprint(dev.facts) dev.close() an example output is: { boot version : u , hardware_rev : u , model : u AT-8000S/24, os : ats, serial_number : not found, 4 Chapter 2. Device Class

9 unit_number : u 1, version : u } ping ping() Description: Verify that the device is alive and is able to respond to command. Parameters: None Return boolean True means that the device is alive and False otherwise. Example This example open a connection with the device and prints its facts: form pynetworking import Device dev = Device( ) dev.open() if dev.ping(): print "Device is alive" dev.close() an example output is: Device is alive 2.3 Properties config Description: Return the configuration of the Device in native cli syntax. Type: Readonly Return string facts Description: Return a dictionary with Device facts. Type: Readonly Return dictionary host Description: The hostname of ip address as previously set creating the object. Type: Readonly Return string 2.3. Properties 5

10 2.3.4 log_level Description: The supported log levels with increasing verbosity are: NOTSET (disable logging and default), CRITI- CAL, WARN, INFO, DEBUG. Type: ReadWrite Return string password Description: The password previously set creating the object. Type: Readonly Return string username Description: The username as previously set creating the object. Type: Readonly Return string 6 Chapter 2. Device Class

11 CHAPTER 3 Facts TBD 7

12 8 Chapter 3. Facts

13 CHAPTER 4 Interface Feature Interface feature provide access to all physical and virtual network interface of the device. 4.1 Interface Naming Convention Since there isn t a common industry standard to name interfaces, PN define a flexible convention that should be mapped by the individual implementation of this module to the actual device. Each interface is identified by three digits separated by dots, for example The first digit identify the physical units within a set of devices, for example connected with a stacking technology, but seen from the library throughout a single IP address or hostname. The second digit represent the slot within the physical device. The digit 0 identify interfaces that belong to the main board and are not on a separated card. The last digit is a number uniquely identify the interface on the main board or card. 4.2 Operations [String] Description: Return a dictionary with specific interface information (String) Description: Return a dictionary with all the interfaces information 4.3 Methods update 9

14 4.3.2 items keys 4.4 Parameters configured_duplex ReadOnly Type: String configured_polarity ReadOnly Type: String configured_speed ReadOnly Type: String current_duplex ReadOnly Type: String 10 Chapter 4. Interface Feature

15 4.4.5 current_polarity ReadOnly Type: String current_speed ReadOnly Type: String description ReadWrite Type: String Description: A description string for the the interface enable ReadWrite Type: Boolean Description: True means that the interface is enabled hardware ReadWrite Type: String Description: The interface hardware that is make the interface Supported hardware are: Ethernet Vlan 4.4. Parameters 11

16 link ReadOnly Type: Boolean Description: True means that the interface is up or running state 12 Chapter 4. Interface Feature

17 CHAPTER 5 Vlan Feature Vlan feature provide access to ethernet layer2 Vlan of the device. 5.1 Operations [String] Description: Return a dictionary with specific vlan information (String) Description: Return a dictionary with all the vlan information 5.2 Methods add_interface delete_interface create 13

18 5.2.4 delete keys items update 5.3 Parameters mtu Optional ReadWrite Type: Integer name ReadWrite Type: String state Optional ReadOnly Type: Boolean 14 Chapter 5. Vlan Feature

19 5.3.4 tagged ReadOnly Type: List of Strings type ReadOnly Type: String Description: Supported type are: Static Dynamic untagged ReadOnly Type: List of Strings 5.3. Parameters 15

20 16 Chapter 5. Vlan Feature

21 CHAPTER 6 Cookbook TBD 17

22 18 Chapter 6. Cookbook

23 CHAPTER 7 Developing Py-Networking TBD 19