a developing networker

OnePK – Interacting with Interfaces

17 Nov 2014 » Coding, Networking
This entry is part 4 of 5 in the series Getting started with Cisco OnePK

Getting information from your network devices is really helpful, but actually change device configurations is even more helpful! This post will have a few examples of how to do just that with scripts that will shutdown a specified interface and change an interface IP address. This is where the fun begins, so strap into your chairs and get ready for some network automation!

Shutting down an Interface

This first example’s goal is to shut down an interface programmatically. In order to specify an interface, we’ll search the interfaces for a passed in IP address.

from onep_connect import connect
from onep.interfaces import InterfaceFilter

# Connect to the network element
# (will raise a ValueError if bad IP address or credentials)
ne = connect('', 'admin', 'admin')

    #Create Interface Filter and find interface by IP
    if_filter = InterfaceFilter(interface_type=1)
    for interface in ne.get_interface_list(if_filter):
        if '' in interface.get_address_list():
                print '%s has been shutdown.' %

    # Finally have the application disconnect from the Network Element  

When we run this script from the command line, this is the output:

$ python admin admin 1
Loopback0 has been shutdown.

Ok, let’s break this down now. We use really similar code to an example in the previous post that will get the IP addresses for each interface. We iterate through each interface looking for the IP addresses specified, and apply the .shut_down() method to it. You can see in the full example here, if a value of 1 (shutdown) or 0 (enable) is passed into the `.shut_down()` method, that value is passed to the method, otherwise we just shutdown the interface with a value of 1.

Changing an Interface IP Address

If you’re going through an IP address range migration this next example could be very valuable to shave hours off the update process. Let’s look at what it takes to change and Interface IP address programmatically:

from onep_connect import connect
from onep.core.util import OnepConstants
from onep.core.util import HostIpCheck

# Connect using IOS device connection details
ne = connect('', 'admin', 'admin')

    #set IP address and prefix
    ip_address = ''
    ip_prefix = 24
    # Test for IPv4 or IPv6 address and assign accordingly
    if HostIpCheck(ip_address).is_ipv4():
        scope_type = OnepConstants.OnepAddressScopeType.ONEP_ADDRESS_IPv4_PRIMARY
    elif HostIpCheck(ip_address).is_ipv6():
        scope_type = OnepConstants.OnepAddressScopeType.ONEP_ADDRESS_IPv6_ALL
        raise ValueError('%s is not a valid IP address' % ip_address)
    #get interface by name
    interface_name = 'Fa0/1'
        iface = ne.get_interface_by_name(inteface_name)
        raise ValueError('The \'%s\' interface does not exist on this Network Element.' % interface_name)

    iface.set_address(1, scope_type, ip_address, ip_prefix)

    print 'The %s interface has been configured with the address: %s/%s' % (interface_name, ip_address, ip_prefix)

    # Finally have the application disconnect from the Network Element  

It looks like there’s a lot going on, but there are really just a few simple steps:

  • Connect to the IOS device
  • Set the IP address and prefix values (this can be done through user input as well).
  • Test the IP address to make sure it is valid.
  • Set the address on the interface we specified by name.
  • Print the output and disconnect.

The only new object here is the `OnepAddressScopeType`, you can read about the possible scope types here. Also, you can see more options when using the `.set_address()` method of the NetworkInterface object here.

To see how this example can be made into a CLI script which takes all the values in as arguments, check out the full example in my OnePK GitHub repo here.

Saving the Network Element Configuration

Being able to make these changes via script is great for bulk changes, but remember that a change is only saved in running_configuration until it’s written to the NVRAM of the IOS device. These changes above would be lost with a reload or power off. Luckily though, the OnePK library includes a `VtyHelper` class to add some config saving abilities to our script:

from one_connect import connect
# This is our VtyHelper class
from onep.vty.util import VtyHelper

# Connect to our network element
ne = connect('', 'admin', 'admin')

###  Make config changes (interface IPs, shutdown interfaces)

# Now we're ready to save the config
ne_vty = VtyHelper(ne)
# Save confirmed with output: '\r\nBuilding configuration...\r\n[OK]'

# Saved and ready to disconnect

The Vty module in OnePK has plenty of other options for running commands and receiving output via the CLI if the other OnePK classes don’t offer what you need. I’ll go more in depth in a later post.

This was just an introduction to making configuration changes on an IOS device. The next post will cover more interface config changes like applying a VLAN or adding ACLs. I know, I’m just as excited as you are! Thanks for reading and check back soon.