some misc code examples

git-svn-id: http://ncclient.googlecode.com/svn/trunk@138 6dbcf712-26ac-11de-a2f3-1373824ab735

diff --git a/examples/NOTE b/examples/NOTE
new file mode 100644 (file)
index 0000000..2e0ce1a
--- /dev/null
+++ b/examples/NOTE
@@ -0,0 +1 @@
+Very... ad-hoc examples here! More concrete, well-written examples... forthcoming.

diff --git a/examples/interactive.txt b/examples/interactive.txt
new file mode 100644 (file)
index 0000000..71db7a7
--- /dev/null
+++ b/examples/interactive.txt
@@ -0,0 +1,71 @@
+# importing shows some warning because the Crypto library uses deprecated modules, but that's ok...
+>>> from ncclient import manager
+/home/sbhushan/local/lib/python2.6/site-packages/Crypto/Hash/SHA.py:6: DeprecationWarning: the sha module is deprecated; use the hashlib module instead
+  from sha import *
+/home/sbhushan/local/lib/python2.6/site-packages/Crypto/Hash/MD5.py:6: DeprecationWarning: the md5 module is deprecated; use hashlib instead
+  from md5 import *
+
+# i use agent forwarding from my machine to meat; and SSHSession looks for agent's keys unless told not to -- so i need not specify a password
+>>> m = manager.connect('broccoli', 22, username='sbhushan')
+
+# a copy config
+>>> reply = m.copy_config(source='running', target='candidate')
+>>> reply.ok
+True
+
+# try to make a checkpoint
+>>> reply = m.copy_config(source='candidate', target='file://checkpoint.conf')
+Traceback (most recent call last):
+  File "<stdin>", line 1, in <module>
+  File "ncclient/manager.py", line 90, in <lambda>
+    copy_config = lambda self, *args, **kwds: self.do('copy-config', *args, **kwds)
+  File "ncclient/manager.py", line 73, in do
+    raise reply.error
+ncclient.operations.rpc.RPCError: syntax error in url element
+# ok, now fixed by putting another "/" after url scheme
+>>> reply = m.copy_config(source='candidate', target='file:///checkpoint.conf')
+>>> reply.ok
+True
+
+# validation
+>>> reply = m.validate(source='<config>not a valid config</config>')
+Traceback (most recent call last):
+  File "<stdin>", line 1, in <module>
+  File "ncclient/manager.py", line 93, in <lambda>
+    validate = lambda self, *args, **kwds: self.do('validate', *args, **kwds)
+  File "ncclient/manager.py", line 73, in do
+    raise reply.error
+ncclient.operations.rpc.RPCError: Unexpected content: 'not a valid config'
+
+# discard and commit...
+>>> m.discard_changes()
+<?xml version="1.0" encoding="UTF-8"?>
+<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:11b42210-43bc-11de-b876-00e0812e961e"><ok/></rpc-reply>
+>>> m.commit().ok
+True
+
+# locking
+>>> m.lock('candidate')
+<?xml version="1.0" encoding="UTF-8"?>
+<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:2caf54cc-43bc-11de-b876-00e0812e961e"><ok/></rpc-reply>
+>>> m.unlock('candidate')
+<?xml version="1.0" encoding="UTF-8"?>
+<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:30146760-43bc-11de-b876-00e0812e961e"><ok/></rpc-reply>
+
+# lets try a fake operation, since its a new op we can't use manager
+
+>>> from ncclient.operations import RPC
+>>> class FakeOp(RPC):
+...     def request(self):
+...     return self._request({'tag': 'fake-op'})
+...
+>>> reply = FakeOp(m.session).request()
+>>> reply.error
+{'error-type': 'rpc', 'error-severity': 'error', 'error-tag': 'unknown-element', 'error-path': '/rpc', 'error-info': '<?xml version=\'1.0\' encoding=\'UTF-8\'?>\n<netconf:error-info xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"><netconf:bad-element>fake-op</netconf:bad-element>\n</netconf:error-info>\n'}
+>>> reply.error.type
+'rpc'
+>>> reply.error.severity
+'error'
+>>> reply.error.tag
+'unknown-element'
+# and so on..
\ No newline at end of file

diff --git a/examples/misc.py b/examples/misc.py
new file mode 100644 (file)
index 0000000..8db44f1
--- /dev/null
+++ b/examples/misc.py
@@ -0,0 +1,107 @@
+#import logging
+#logging.basicConfig(level=logging.DEBUG)
+
+from ncclient import manager
+from ncclient.operations import RPCError
+
+m = manager.connect('broccoli', 22, username='sbhushan')
+
+# add user
+print 'Add user:',
+config = """<config>
+    <aaa xmlns="http://tail-f.com/ns/aaa/1.1">
+       <authentication>
+           <users>
+               <user>
+                   <name>testtailf</name>
+                   <uid>9099</uid>
+                   <gid>1</gid>
+                   <password>testtailf</password>
+                   <ssh_keydir/>
+                   <homedir/>
+               </user>
+           </users>
+       </authentication>
+    </aaa>
+</config>"""
+try:
+    m.edit_config(target='candidate', config=config)
+except RPCError as e:
+    print 'error:', e
+else:
+    print 'OK'
+
+# get using xpath filter
+print 'Get using XPath filter:',
+expr = "aaa/authentication/users/user[name='testtailf']"
+try:
+    reply = m.get_config(source='candidate', filter=("xpath", expr))
+except RPCError as e:
+    print 'error:', e
+else:
+    print reply.data_xml
+
+# get using subtree filter
+print 'Get using subtree filter:',
+criteria = """<aaa xmlns="http://tail-f.com/ns/aaa/1.1">
+    <authentication>
+       <users>
+           <user><name>testtailf</name></user>
+       </users>
+    </authentication>
+</aaa>"""
+try:
+    reply = m.get_config(source='candidate', filter=("subtree", criteria))
+except RPCError as e:
+    print 'error:', e
+else:
+    print reply.data_xml
+
+# modify user
+print 'Modify user:',
+config = """<config>
+    <aaa xmlns="http://tail-f.com/ns/aaa/1.1">
+       <authentication>
+           <users>
+               <user>
+            <name>testtailf</name>
+                   <uid>9011</uid>
+                   <homedir>abc123</homedir>
+               </user>
+           </users>
+       </authentication>
+    </aaa>
+</config>"""
+try:
+    reply = m.edit_config(target='candidate', config=config)
+except RPCError as e:
+    print 'error:', e
+else:
+    print 'OK'
+
+print 'Deleting user:',
+config = """<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>testtailf</name>
+               </user>
+           </users>
+       </authentication>
+    </aaa>
+</config>"""
+try:
+    m.edit_config(target='candidate', config=config)
+except RPCError as e:
+    print 'error: ', e
+else:
+    print 'OK'
+
+print 'Closing session:',
+try:
+    m.close_session()
+except RPCError as e:
+    print 'error', e
+else:
+    print 'OK'
\ No newline at end of file

diff --git a/examples/test.py b/examples/test.py
new file mode 100644 (file)
index 0000000..f5de968
--- /dev/null
+++ b/examples/test.py
@@ -0,0 +1,10 @@
+from ncclient import manager
+
+import logging
+logging.basicConfig(level=logging.DEBUG)
+
+with manager.connect('broccoli', 22, username='sbhushan') as m:
+    with m.locked('candidate'):
+        reply = m.copy_config(source='running', target='candidate')
+
+print reply

diff --git a/examples/test2.py b/examples/test2.py
new file mode 100644 (file)
index 0000000..e1be490
--- /dev/null
+++ b/examples/test2.py
@@ -0,0 +1,34 @@
+from ncclient.transport import SSHSession
+from ncclient.operations import CloseSession
+from ncclient.util import PrintListener
+from ncclient.capabilities import CAPABILITIES
+from ncclient import operations
+
+import logging
+logging.basicConfig(level=logging.DEBUG)
+
+from ncclient.operations.rpc import RPC
+class FakeOp(RPC):
+    def request(self):
+        return self._request({'tag': 'fake-operation'})
+
+s = SSHSession(CAPABILITIES)
+#s.add_listener(PrintListener())
+s.load_known_hosts()
+s.connect('broccoli', 22, username='sbhushan')
+
+fo = FakeOp(s)
+fo_reply = fo.request()
+if not fo_reply.ok:
+    print 'error dictionary: %r' % fo_reply.error
+else:
+    print 'fake op went ok?!'
+    print fo_reply
+
+go = operations.Get(s)
+go.request()
+print 'GET_REPLY', go.reply.data_xml
+
+cs = CloseSession(s)
+cs_reply = cs.request()
+print 'closesession ok:', cs_reply.ok