netconf¶

This package supports creating both netconf clients and servers. Additionally a CLI netconf client is included. The following modules are present:

base - Shared netconf support classes.
error - Netconf error classes.
client - Netconf client classes.
server - Netconf server classes.
util - Netconf utility functions.

netconf uses _sshutil and thus supports your SSH agent and SSH config when using the client.

Contents:

Installation¶

At the command line:

$ pip install sshutil

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv sshutil
$ pip install sshutil

Usage¶

Command Line Tool¶

To get the capabilities of a server:

$ netconf-client --hello --host example.com

To request config from a server that has your key:

$ netconf-client --host example.com <<<"<get-config/>"

Development¶

To use netconf in a project:

import netconf

Netconf Client¶

To open a session to server:

from netconf.client import NetconfSSHSession

session = NetconfSSHSession(host, port, username, password)

To send and RPC to a server:

rpcout = session.send_rpc("<my-rpc/>")

Netconf Server¶

To create a simple server listening on port 830 that handles one RPC <my-cool-rpc>:

from netconf import nsmap_update, server
import netconf.util as ncutil

MODEL_NS = "urn:my-urn:my-model"
nsmap_update({'pfx': MODEL_NS})

class MyServer (object):
    def __init__ (self, user, pw):
        controller = server.SSHUserPassController(username=user, password=pw)
        self.server = server.NetconfSSHServer(server_ctl=controller, server_methods=self)

    def nc_append_capabilities(self, caps):
        ncutil.subelm(caps, "capability").text = MODEL_NS

    def rpc_my_cool_rpc (self, session, rpc, *params):
        data = ncutil.elm("data")
        data.append(ncutil.leaf_elm("pfx:result", "RPC result string"))
        return data

# ...
server = MyServer("myuser", "mysecert")
# ...

Reference¶

The `netconf.base` Module¶

class netconf.base.NetconfFramingTransport(stream, max_chunk, debug)¶

Bases: netconf.base.NetconfPacketTransport

Packetize an ssh stream into netconf PDUs – doesn’t need to be SSH specific

close()¶

is_active()¶

receive_pdu(new_framing)¶

send_pdu(msg, new_framing)¶

class netconf.base.NetconfPacketTransport¶

Bases: object

receive_pdu(new_framing)¶

send_pdu(msg, new_framing)¶

class netconf.base.NetconfSession(stream, debug, session_id, max_chunk=16384)¶

Bases: object

Netconf Protocol Server and Client

close()¶

is_active()¶

reader_exits()¶

reader_handle_message(msg)¶

send_hello(caplist, session_id=None)¶

send_message(msg)¶

class netconf.base.NetconfTransportMixin¶

Bases: object

close()¶

connect()¶

netconf.base.chunkit(msg, maxsend, minsend=0, pad=u'\n')¶: chunkit iterates over a msg returning chunks of at most maxsend size, and of at least minsend size if non-zero. Padding will be added if required. This function currently requires that maxsend is at least large enough to hold 2 minsend chunks.

netconf.base.lookahead(iterable)¶: Return an element and an indication if it’s the last element

The `netconf.client` Module¶

class netconf.client.NetconfClientSession(stream, debug=False)¶

Bases: netconf.base.NetconfSession

Netconf Protocol

close()¶

is_reply_ready(msg_id)¶: Check whether reply is ready (or session closed)

reader_exits()¶

reader_handle_message(msg)¶: Handle a message, lock is already held

send_rpc(rpc, timeout=None)¶

send_rpc_async(rpc, noreply=False)¶

wait_reply(msg_id, timeout=None)¶

class netconf.client.NetconfSSHSession(host, port=830, username=None, password=None, debug=False, cache=None, proxycmd=None)¶: Bases: netconf.client.NetconfClientSession

class netconf.client.Timeout(timeout)¶

Bases: object

is_expired()¶

remaining()¶

The `netconf.error` Module¶

exception netconf.error.ChannelClosed¶: Bases: netconf.error.NetconfException

exception netconf.error.FramingError¶: Bases: netconf.error.NetconfException

exception netconf.error.NetconfException¶: Bases: exceptions.Exception

exception netconf.error.RPCError(output, tree, error)¶

Bases: netconf.error.NetconfException

get_error_info()¶

get_error_severity()¶

get_error_tag()¶

get_error_type()¶

exception netconf.error.RPCServerError(origmsg, etype, tag, **kwargs)¶

Bases: netconf.error.NetconfException

get_reply_msg()¶

exception netconf.error.RPCSvrBadElement(origmsg, element, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.RPCSvrErrBadMsg(origmsg)¶

Bases: netconf.error.RPCServerError

If the server raises this exception the and netconf 1.0 is in use, the session will be closed

exception netconf.error.RPCSvrErrNotImpl(origmsg, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.RPCSvrException(origmsg, exception, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.RPCSvrInvalidValue(origmsg, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.RPCSvrMissingElement(origmsg, tag, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.RPCSvrUnknownElement(origmsg, element, **kwargs)¶: Bases: netconf.error.RPCServerError

exception netconf.error.ReplyTimeoutError¶: Bases: netconf.error.NetconfException

exception netconf.error.SessionError¶: Bases: netconf.error.NetconfException

netconf.error.TimeoutError¶: alias of ReplyTimeoutError

The `netconf.ncclient` Module¶

netconf.ncclient.main(*margs)¶

The `netconf.server` Module¶

class netconf.server.NetconfMethods¶

Bases: object

This is an abstract class that is used to document the server methods functionality

The server return not-implemented if the method is not found in the methods object, so feel free to use duck-typing here (i.e., no need to inherit)

nc_append_capabilities(capabilities)¶: The server should append any capabilities it supports to capabilities

rpc_copy_config(unused_session, rpc, *unused_params)¶

rpc_delete_config(unused_session, rpc, *unused_params)¶

rpc_edit_config(unused_session, rpc, *unused_params)¶

rpc_get(session, rpc, filter_or_none)¶: Passed the filter element or None if not present

rpc_get_config(session, rpc, source_elm, filter_or_none)¶: Passed the source element

rpc_lock(unused_session, rpc, *unused_params)¶

rpc_unlock(unused_session, rpc, *unused_params)¶

class netconf.server.NetconfSSHServer(server_ctl=None, server_methods=None, port=830, host_key=None, debug=False)¶

Bases: sshutil.server.SSHServer

A netconf server

allocate_session_id()¶

class netconf.server.NetconfServerSession(channel, server, unused_extra_args, debug)¶

Bases: netconf.base.NetconfSession

Netconf Server-side Session Protocol

close()¶

handled_rpc_methods = set([u'close-session', u'kill-session'])¶

reader_exits()¶

reader_handle_message(msg)¶: Handle a message, lock is already held

send_rpc_reply(rpc_reply, origmsg)¶

send_rpc_reply_error(error)¶

class netconf.server.SSHAuthController(users=None)¶

Bases: paramiko.server.ServerInterface

check_auth_none(unused_username)¶

check_auth_password(username, password)¶

check_auth_publickey(username, key)¶

check_channel_request(kind, chanid)¶

check_channel_subsystem_request(channel, name)¶

get_allowed_auths(username)¶

get_user_auth_keys(username)¶: Parse the users’s authorized_keys file if any to look for authorized keys

class netconf.server.SSHUserPassController(username=None, password=None)¶

Bases: paramiko.server.ServerInterface

check_auth_none(username)¶

check_auth_password(username, password)¶

check_channel_request(kind, chanid)¶

check_channel_subsystem_request(channel, name)¶

get_allowed_auths(username)¶

The `netconf.util` Module¶

netconf.util.elm(tag, attrib=None, **extra)¶

netconf.util.filter_containment_iter(fcontain_elm, dest_node, containment_nodes, leaf_elms, append_to)¶

Given a containment filter node (or None) verify that all leaf elements either match, have corresponding selection nodes (empty) or are not present.

If all leaf criteria are met then the iterator will return a triple of (new_filter_node, new_dest_node, new_data). new_filter_node corresponds to the matched containment node which is returned in new_dest_node, and new_data will be an element corresponding to the passed in dest_node.

These should be processed by calling filter_containment_iter again.

Additionally the correct leaf data will be added to dest_node, and dest_node will be appended to append_to if append_to is not None.

This implements RFC6241 section 6.2.5

netconf.util.filter_leaf_allows(filter_elm, xpath, value)¶

Check the value at the xpath specified leaf matches the value.

If filter_elm is None then allow.
If there is no xpath element then allow if there are no other children.
XXX what about xpath that has embedded predicates! perhaps what we want to call this is a normal path not an xpath.

netconf.util.filter_leaf_allows_add(filter_elm, tag, data, value)¶

netconf.util.filter_leaf_values(fcontain_elm, dest_node, leaf_elms, append_to)¶

Given a containment element (or None) verify that all leaf elements in leaf_elms either match, have corresponding selection nodes (empty) or are not present.

Additionally the correct leaf data will be added to dest_node, and dest_node will be appended to append_to if append_to is not None.

The return value with be True, False, or a possibly empty set of selection/containment nodes The only failing value is False, if True is returned then the caller should include all containment sibling nodes, otherwise the caller should process the list of containment/selection nodes.

netconf.util.filter_list_iter(filter_list, key_xpath, keys)¶: Return key, elm pairs that are allowed by keys using the values found using the given key_xpath

netconf.util.filter_node_match(filter_node, match_elm)¶

Given a filter node element and a nodename and attribute dictionary return true if the filter element matches the elmname, attributes and value (if not None).

The filter element can use a wildcard namespace or a specific namespace the attributes can be missing from the filter node but otherwise must match and the value is only checked for a match if it is not None.

netconf.util.filter_node_match_no_value(filter_node, match_elm)¶

netconf.util.filter_tag_match(filter_tag, elm_tag)¶

netconf.util.is_selection_node(felm)¶

netconf.util.leaf(tag, value, attrib=None, **extra)¶

netconf.util.leaf_elm(tag, value, attrib=None, **extra)¶

netconf.util.qname(tag)¶

netconf.util.subelm(pelm, tag, attrib=None, **extra)¶

netconf¶

Installation¶

Usage¶

Command Line Tool¶

Development¶

Netconf Client¶

Netconf Server¶

Reference¶

The netconf.base Module¶

The netconf.client Module¶

The netconf.error Module¶

The netconf.ncclient Module¶

The netconf.server Module¶

The netconf.util Module¶

The `netconf.base` Module¶

The `netconf.client` Module¶

The `netconf.error` Module¶

The `netconf.ncclient` Module¶

The `netconf.server` Module¶

The `netconf.util` Module¶