ncclient:NETCONF Python client

class OperationError(NCClientError):

    pass

    def __list__(self):

        return self._dict.keys()

class XMLConverter:

        self._root = XMLConverter.build(spec)

        # some etree versions don't always include xml decl e.g. with utf-8

            return ((u'<?xml version="1.0" encoding="%s"?>'

                     % encoding).encode(encoding) + xml)

        elif 'xml' in spec:

            return ET.XML(spec['xml'])

# Copyright 2009 Shikhar Bhushan

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#    http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

import capabilities

import operations

import transport

SESSION_TYPES = {

    'ssh': transport.SSHSession

}

OPERATIONS = {

    'get': operations.Get,

    'get-config': operations.GetConfig,

    'edit-config': operations.EditConfig,

    'copy-config': operations.CopyConfig,

    'validate': operations.Validate,

    'commit': operations.Commit,

    'discard-changes': operations.DiscardChanges,

    'delete-config': operations.DeleteConfig,

    'lock': operations.Lock,

    'unlock': operations.Unlock,

    'close_session': operations.CloseSession,

    'kill-session': operations.KillSession,

}

class Manager(type):

    'Facade for the API'

    def connect(self, session_type, *args, **kwds):

        self._session = SESSION_TYPES[session_type](capabilities.CAPABILITIES)

        self._session.connect(*args, **kwds)

    def __getattr__(self, name):

        if name in OPERATIONS:

            return OPERATIONS[name](self._session).request

        else:

            raise AttributeError

from ncclient.rpc import RPC

    SPEC = {

        'tag': 'edit-config',

        'children': [

            { 'target': None }

        ]

    }

    def request(self):

        pass

    SPEC = {

    }

    def request(self):

        pass

    SPEC = {

        'tag': 'delete-config',

        'children': [

            'tag': 'target',

            'children': {'tag': None }

        ]

    }

    def request(self, target=None, targeturl=None):

        spec = deepcopy(DeleteConfig.SPEC)

    DEPENDS = ['urn:ietf:params:netconf:capability:validate:1.0']

    SPEC = {}

    def request(self):

        pass

    SPEC = {'tag': 'commit'}

    def request(self):

        return self._request(Commit.SPEC)

    DEPENDS = ['urn:ietf:params:netconf:capability:candidate:1.0']

    SPEC = {'tag': 'discard-changes'}

    def request(self):

        return self._request(DiscardChanges.SPEC)

from ncclient.rpc import RPC

# TODO - a context manager around some <target> would be real neat

NOTIFICATION_NS = 'urn:ietf:params:xml:ns:netconf:notification:1.0'

from copy import deepcopy

from ncclient.rpc import RPC

def build_filter(spec, type, criteria):

    filter = {

        'tag': 'filter',

        'attributes': {'type': type}

    }

    if type=='subtree':

        if isinstance(criteria, dict):

            filter['children'] = [criteria]

        else:

            filter['text'] = criteria

    elif type=='xpath':

        filter['attributes']['select'] = criteria

        'children': []

    def request(self, filter=None):

        spec = deepcopy(SPEC)

        if filter is not None:

            spec['children'].append(build_filter(*filter))

        return self._request(spec)

    SPEC = {

        'tag': 'get-config',

        'children': [ { 'tag': 'source', 'children': {'tag': None } } ]

    }

    def request(self, source='running', filter=None):

        spec = deepcopy(SPEC)

        spec['children'][0]['children']['tag'] = source

        if filter is not None:

            spec['children'].append(build_filter(*filter))

        return self._request(spec)

from ncclient.rpc import RPC

# Copyright 2009 Shikhar Bhushan

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#    http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

from rpc import RPC

from reply import RPCReply

class ReplyTimeoutError(Exception):

    pass

__all__ = [

    'RPC',

    'RPCReply',

    'ReplyTimeoutError'

]

# Copyright 2009 Shikhar Bhushan

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#    http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

from threading import Lock

from weakref import WeakValueDictionary

import logging

logger = logging.getLogger('ncclient.rpc.listener')

class RPCReplyListener(Listener):

    # one instance per session

    def __new__(cls, session):

        instance = session.get_listener_instance(cls)

        if instance is None:

            instance = object.__new__(cls)

            instance._lock = Lock()

            instance._id2rpc = WeakValueDictionary()

            instance._pipelined = session.can_pipeline

            instance._errback = None

            session.add_listener(instance)

        return instance

    def register(self, id, rpc):

        with self._lock:

            self._id2rpc[id] = rpc

    def callback(self, root, raw):

        tag, attrs = root

        if __(tag) != 'rpc-reply':

            return

        rpc = None

        for key in attrs:

            if __(key) == 'message-id':

                id = attrs[key]

                try:

                    with self._lock:

                        rpc = self._id2rpc.pop(id)

                except KeyError:

                    logger.warning('no object registered for message-id: [%s]' % id)

                except Exception as e:

                    logger.debug('error - %r' % e)

                break

        else:

            if not self._pipelined:

                with self._lock:

                    assert(len(self._id2rpc) == 1)

                    rpc = self._id2rpc.values()[0]

                    self._id2rpc.clear()

            else:

                logger.warning('<rpc-reply> without message-id received: %s' % raw)

        logger.debug('delivering to %r' % rpc)

        rpc.deliver(raw)

    def set_errback(self, errback):

        self._errback = errback

    def errback(self, err):

        if self._errback is not None:

            self._errback(err)

logger = logging.getLogger('ncclient.rpc.reply')

        self._root = None

        root = self._root = ET.fromstring(self._raw) # <rpc-reply> element

    def root(self):

        return self._root

    @property

from listener import RPCReplyListener

import logging

logger = logging.getLogger('ncclient.rpc')

    def __init__(self, session, async=False, timeout=None):

        if not session.can_pipeline:

            raise UserWarning('Asynchronous mode not supported for this device/session')

        self._timeout = timeout

    def _build(opspec, encoding='utf-8'):

        "TODO: docstring"

        spec = {

            'tag': _('rpc'),

            'attributes': {'message-id': self._id},

            'children': opspec

            }

        return TreeBuilder(spec).to_string(encoding)

    def _request(self, op, timeout=None):

            self._reply_event.wait(timeout)

            if self._reply_event.isSet():

                self._reply.parse()

                return self._reply

            else:

                raise ReplyTimeoutError

    def set_async(self, bool): self._async = bool

    async = property(fget=lambda self: self._async, fset=set_async)

    def set_timeout(self, timeout): self._timeout = timeout

    timeout = property(fget=lambda self: self._timeout, fset=set_timeout)

    @property

    def can_pipeline(self):

        return True

    def can_pipeline(self):

        if 'Cisco' in self._transport.remote_version:

            return False

        # elif ..

        return True