ncclient:NETCONF Python client

#! /usr/bin/env python2.6

#

# Connect to the NETCONF server passed on the command line and

# display their capabilities. This script and the following scripts

# all assume that the user calling the script is known by the server

# and that suitable SSH keys are in place. For brevity and clarity

# of the examples, we omit proper exception handling.

#

# $ ./nc01.py broccoli

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

def demo(host, user):

    with manager.connect(host=host, port=22, username=user) as m:

        for c in m.server_capabilities:

            print c

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"))

#! /usr/bin/env python2.6 

#

# Retrieve the running config from the NETCONF server passed on the

# command line using get-config and write the XML configs to files.

#

# $ ./nc02.py broccoli

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

def demo(host, user):

    with manager.connect(host=host, port=22, username=user) as m:

        c = m.get_config(source='running').data_xml

        with open("%s.xml" % host, 'w') as f:

            f.write(c)

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"))

#! /usr/bin/env python2.6 

#

# Retrieve a portion selected by an XPATH expression from the running

# config from the NETCONF server passed on the command line using

# get-config and write the XML configs to files.

#

# $ ./nc03.py broccoli "aaa/authentication/users/user[name='schoenw']"

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

def demo(host, user, expr):

    with manager.connect(host=host, port=22, username=user) as m:

        assert(":xpath" in m.server_capabilities)

        c = m.get_config(source='running', filter=('xpath', expr)).data_xml

        with open("%s.xml" % host, 'w') as f:

            f.write(c)

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"), sys.argv[2])

#! /usr/bin/env python2.6 

#

# Create a new user to the running configuration using edit-config

# and the test-option provided by the :validate capability.

#

# $ ./nc04.py broccoli bob 42 42

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

def demo(host, user, name, uid, gid):

    snippet = """<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">

      <aaa xmlns="http://tail-f.com/ns/aaa/1.1">

        <authentication> <users> <user xc:operation="create">

        <name>%s</name> <uid>%s</uid> <gid>%s</gid>

        <password>*</password> <ssh_keydir/> <homedir/>

      </user></users></authentication></aaa></config>""" % (name, uid, gid)

    with manager.connect(host=host, port=22, username=user) as m:

        assert(":validate" in m.server_capabilities)

        m.edit_config(target='running', config=snippet,

                      test_option='test-then-set')

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"), sys.argv[2], sys.argv[3], sys.argv[4])

#! /usr/bin/env python2.6 

#

# Delete an existing user from the running configuration using

# edit-config and the test-option provided by the :validate

# capability.

#

# $ ./nc05.py broccoli bob

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

def demo(host, user, name):

    snippet = """<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">

      <aaa xmlns="http://tail-f.com/ns/aaa/1.1">

        <authentication> <users> <user xc:operation="delete">

        <name>%s</name>

      </user></users></authentication></aaa></config>""" % name

    with manager.connect(host=host, port=22, username=user) as m:

        assert(":validate" in m.server_capabilities)

        m.edit_config(target='running', config=snippet,

                      test_option='test-then-set')

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"), sys.argv[2])

#! /usr/bin/env python2.6 

#

# Delete a list of existing users from the running configuration using

# edit-config; protect the transaction using a lock.

#

# $ ./nc06.py broccoli bob alice

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

template = """<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">

  <aaa xmlns="http://tail-f.com/ns/aaa/1.1">

  <authentication> <users> <user xc:operation="delete">

  <name>%s</name> </user></users></authentication></aaa></config>"""

def demo(host, user, names):

    with manager.connect(host=host, port=22, username=user) as m:

        with m.locked(target='running'):

            for n in names:

                m.edit_config(target='running', config=template % n)

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"), sys.argv[2:])

#! /usr/bin/env python2.6 

#

# Delete a list of existing users from the running configuration using

# edit-config and the candidate datastore protected by a lock.

#

# $ ./nc07.py broccoli bob alice

import sys, os, warnings

warnings.simplefilter("ignore", DeprecationWarning)

from ncclient import manager

template = """<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">

  <aaa xmlns="http://tail-f.com/ns/aaa/1.1">

  <authentication> <users> <user xc:operation="delete">

  <name>%s</name> </user></users></authentication></aaa></config>"""

def demo(host, user, names):

    with manager.connect(host=host, port=22, username=user) as m:

        assert(":candidate" in m.server_capabilities)

        with m.locked(target='candidate'):

            m.discard_changes()

            for n in names:

                m.edit_config(target='candidate', config=template % n)

            m.commit()

if __name__ == '__main__':

    demo(sys.argv[1], os.getenv("USER"), sys.argv[2:])