From e03485d3e5157042b91db6679df084433ff022b1 Mon Sep 17 00:00:00 2001
From: Mallikarjunarao Kosuri <venkatamallikarjunarao.kosuri@adtran.com>
Date: Sat, 3 Dec 2016 08:26:37 +0530
Subject: [PATCH] improved docs

---
 docs/index.html                         | 2 +-
 src/NcclientLibrary/NcclientKeywords.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/index.html b/docs/index.html
index f314fcd..1bb348b 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -468,7 +468,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>Documentation for test library <code>NcclientKeywords\x3c/code>.\x3c/p>","generated":"2016-10-28 20:14:16","inits":[],"keywords":[{"args":["alias"],"doc":"<p>Request graceful termination of the NETCONF session, and also close the transport.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>","matched":true,"name":"Close Session","shortdoc":"Request graceful termination of the NETCONF session, and also close the","tags":[]},{"args":["alias","confirmed=False","timeout=None"],"doc":"<p>Commit the candidate configuration as the device?s new current configuration. Depends on the :candidate capability.\x3c/p>\n<p>A confirmed commit (i.e. if confirmed is True) is reverted if there is no followup commit within the timeout interval. If no timeout is specified the confirm timeout defaults to 600 seconds (10 minutes). A confirming commit may have the confirmed parameter but this is not required. Depends on the :confirmed-commit capability.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>confirmed\x3c/code> whether this is a confirmed commit\x3c/p>\n<p><code>timeout\x3c/code> specifies the confirm timeout in seconds\x3c/p>","matched":true,"name":"Commit","shortdoc":"Commit the candidate configuration as the device?s new current","tags":[]},{"args":["*args","**kwds"],"doc":"<p>Initialize a Manager over the SSH transport.\x3c/p>","matched":true,"name":"Connect","shortdoc":"Initialize a Manager over the SSH transport.","tags":[]},{"args":["alias","source","target"],"doc":"<p>Create or replace an entire configuration datastore with the contents of another complete configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> is the name of the configuration datastore to use as the source of the copy operation or config element containing the configuration subtree to copy\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to use as the destination of the copy operation\x3c/p>","matched":true,"name":"Copy Config","shortdoc":"Create or replace an entire configuration datastore with the contents","tags":[]},{"args":["alias","target"],"doc":"<p>Delete a configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> specifies the name or URL of configuration datastore to delete.\x3c/p>","matched":true,"name":"Delete Config","shortdoc":"Delete a configuration datastore.","tags":[]},{"args":["alias"],"doc":"<p>Revert the candidate configuration to the currently running configuration. Any uncommitted changes are discarded.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>","matched":true,"name":"Discard Changes","shortdoc":"Revert the candidate configuration to the currently running","tags":[]},{"args":["alias","rpc_command","source=None","filter=None"],"doc":"<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>rpc_command\x3c/code> specifies rpc command to be dispatched either in plain text or in xml element format (depending on command)\x3c/p>\n<p><code>source\x3c/code> name of the configuration datastore being queried\x3c/p>\n<p><code>filter\x3c/code> specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)\x3c/p>","matched":true,"name":"Dispatch","shortdoc":"``alias`` that will be used to identify the Session object in the cache","tags":[]},{"args":["alias","target","config","default_operation=None","test_option=None","error_option=None"],"doc":"<p>Loads all or part of the specified config to the target configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore being edited\x3c/p>\n<p><code>config\x3c/code> is the configuration, which must be rooted in the config element.  It can be specified either as a string or an Element.\x3c/p>\n<p><code>default_operation\x3c/code> if specified must be one of { ?merge?, ?replace?, or ?none? }\x3c/p>\n<p><code>test_option\x3c/code> if specified must be one of { ?test_then_set?, ?set? }\x3c/p>\n<p><code>error_option\x3c/code> if specified must be one of { ?stop-on-error?, ?continue-on-error?, ?rollback-on-error? }\x3c/p>\n<p>The ?rollback-on-error? error_option depends on the :rollback-on-error adaptability.\x3c/p>","matched":true,"name":"Edit Config","shortdoc":"Loads all or part of the specified config to the target","tags":[]},{"args":["alias","filter_type=subtree","filter_criteria=None"],"doc":"<p>Retrieve running configuration and device state information.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>filter_typoe\x3c/code> specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)\x3c/p>\n<p><code>filter_criteria\x3c/code> A tuple of (xml, xpath)\x3c/p>\n<p><b>*Filter parameters*\x3c/b>\x3c/p>\n<p>Where a method takes a filter argument, it can take on the following types:\x3c/p>\n<p>A tuple of (type, criteria).\x3c/p>\n<p>Here type has to be one of <code>xpath\x3c/code> or <code>subtree\x3c/code>. For <code>xpath\x3c/code> the criteria should be a string containing the XPath expression. For <code>subtree\x3c/code> the criteria should be an XML string or an Element object containing the criteria.\x3c/p>\n<p>A &lt;filter&gt; element as an XML string or an Element object.\x3c/p>","matched":true,"name":"Get","shortdoc":"Retrieve running configuration and device state information.","tags":[]},{"args":["alias","source","filter_type=subtree","filter_criteria=None"],"doc":"<p>Retrieve all or part of a specified configuration.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> name of the configuration datastore being queried\x3c/p>\n<p><code>filter_type\x3c/code> xml string or subtree value\x3c/p>\n<p><code>filter_criteria\x3c/code> tuple values (xml and xpath)\x3c/p>\n<p><b>*Filter parameters*\x3c/b>\x3c/p>\n<p>Where a method takes a filter argument, it can take on the following type:\x3c/p>\n<p>A tuple of (type, criteria).\x3c/p>\n<p>Here type has to be one of <code>xpath\x3c/code> or <code>subtree\x3c/code>. For <code>xpath\x3c/code> the criteria should be a string containing the XPath expression. For <code>subtree\x3c/code> the criteria should be an XML string or an Element object containing the criteria.\x3c/p>\n<p>A &lt;filter&gt; element as an XML string or an Element object.\x3c/p>","matched":true,"name":"Get Config","shortdoc":"Retrieve all or part of a specified configuration.","tags":[]},{"args":[],"doc":"<p>Returns server caps\x3c/p>","matched":true,"name":"Get Server Capabilities","shortdoc":"Returns server caps","tags":[]},{"args":[],"doc":"<p>Returns server supported YANG modules\x3c/p>","matched":true,"name":"Get Yang Modules","shortdoc":"Returns server supported YANG modules","tags":[]},{"args":["alias","session_id"],"doc":"<p>Force the termination of a NETCONF session (not the current one!)\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>session_id\x3c/code> is the session identifier of the NETCONF session to be terminated as a string\x3c/p>","matched":true,"name":"Kill Session","shortdoc":"Force the termination of a NETCONF session (not the current one!)","tags":[]},{"args":["alias","target"],"doc":"<p>Allows the client to lock the configuration system of a device.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to lock\x3c/p>","matched":true,"name":"Lock","shortdoc":"Allows the client to lock the configuration system of a device.","tags":[]},{"args":["alias","target"],"doc":"<p>Returns a context manager for a lock on a datastore, where target is the name of the configuration datastore to lock.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to unlock\x3c/p>","matched":true,"name":"Locked","shortdoc":"Returns a context manager for a lock on a datastore, where target","tags":[]},{"args":["alias","target"],"doc":"<p>Release a configuration lock, previously obtained with the lock operation.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to unlock\x3c/p>","matched":true,"name":"Unlock","shortdoc":"Release a configuration lock, previously obtained with the lock","tags":[]},{"args":["alias","source"],"doc":"<p>Validate the contents of the specified configuration.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> is the name of the configuration datastore being validated or config element containing the configuration subtree to be validated\x3c/p>","matched":true,"name":"Validate","shortdoc":"Validate the contents of the specified configuration.","tags":[]}],"name":"NcclientKeywords","named_args":true,"scope":"global","version":""};
+libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>Documentation for test library <code>NcclientKeywords\x3c/code>.\x3c/p>","generated":"2016-12-03 08:25:28","inits":[],"keywords":[{"args":["alias"],"doc":"<p>Request graceful termination of the NETCONF session, and also close the transport.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>","matched":true,"name":"Close Session","shortdoc":"Request graceful termination of the NETCONF session, and also close the","tags":[]},{"args":["alias","confirmed=False","timeout=None"],"doc":"<p>Commit the candidate configuration as the device?s new current configuration. Depends on the :candidate capability.\x3c/p>\n<p>A confirmed commit (i.e. if confirmed is True) is reverted if there is no followup commit within the timeout interval. If no timeout is specified the confirm timeout defaults to 600 seconds (10 minutes). A confirming commit may have the confirmed parameter but this is not required. Depends on the :confirmed-commit capability.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>confirmed\x3c/code> whether this is a confirmed commit\x3c/p>\n<p><code>timeout\x3c/code> specifies the confirm timeout in seconds\x3c/p>","matched":true,"name":"Commit","shortdoc":"Commit the candidate configuration as the device?s new current","tags":[]},{"args":["*args","**kwds"],"doc":"<p>Initialize a Manager over the SSH transport.\x3c/p>","matched":true,"name":"Connect","shortdoc":"Initialize a Manager over the SSH transport.","tags":[]},{"args":["alias","source","target"],"doc":"<p>Create or replace an entire configuration datastore with the contents of another complete configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> is the name of the configuration datastore to use as the source of the copy operation or config element containing the configuration subtree to copy\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to use as the destination of the copy operation\x3c/p>","matched":true,"name":"Copy Config","shortdoc":"Create or replace an entire configuration datastore with the contents","tags":[]},{"args":["alias","target"],"doc":"<p>Delete a configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> specifies the name or URL of configuration datastore to delete.\x3c/p>","matched":true,"name":"Delete Config","shortdoc":"Delete a configuration datastore.","tags":[]},{"args":["alias"],"doc":"<p>Revert the candidate configuration to the currently running configuration. Any uncommitted changes are discarded.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>","matched":true,"name":"Discard Changes","shortdoc":"Revert the candidate configuration to the currently running","tags":[]},{"args":["alias","rpc_command","source=None","filter=None"],"doc":"<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>rpc_command\x3c/code> specifies rpc command to be dispatched either in plain text or in xml element format (depending on command)\x3c/p>\n<p><code>source\x3c/code> name of the configuration datastore being queried\x3c/p>\n<p><code>filter\x3c/code> specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)\x3c/p>","matched":true,"name":"Dispatch","shortdoc":"``alias`` that will be used to identify the Session object in the cache","tags":[]},{"args":["alias","target","config","default_operation=None","test_option=None","error_option=None","format=xml"],"doc":"<p>Loads all or part of the specified config to the target configuration datastore.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore being edited\x3c/p>\n<p><code>config\x3c/code> is the configuration, which must be rooted in the config element.  It can be specified either as a string or an Element.\x3c/p>\n<p><code>default_operation\x3c/code> if specified must be one of { ?merge?, ?replace?, or ?none? }\x3c/p>\n<p><code>test_option\x3c/code> if specified must be one of { ?test_then_set?, ?set? }\x3c/p>\n<p><code>error_option\x3c/code> if specified must be one of { ?stop-on-error?, ?continue-on-error?, ?rollback-on-error? }\x3c/p>\n<p><code>format\x3c/code> if specified must be one of { ?xml?, ?text?}\x3c/p>\n<p>The ?rollback-on-error? error_option depends on the :rollback-on-error adaptability.\x3c/p>","matched":true,"name":"Edit Config","shortdoc":"Loads all or part of the specified config to the target","tags":[]},{"args":["alias","filter_type=subtree","filter_criteria=None"],"doc":"<p>Retrieve running configuration and device state information.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>filter_typoe\x3c/code> specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)\x3c/p>\n<p><code>filter_criteria\x3c/code> A tuple of (xml, xpath)\x3c/p>\n<p><b>*Filter parameters*\x3c/b>\x3c/p>\n<p>Where a method takes a filter argument, it can take on the following types:\x3c/p>\n<p>A tuple of (filter_type, filter_criteria).\x3c/p>\n<p>Here type has to be one of <code>xpath\x3c/code> or <code>subtree\x3c/code>. For <code>xpath\x3c/code> the criteria should be a string containing the XPath expression. For <code>subtree\x3c/code> the criteria should be an XML string or an Element object containing the criteria.\x3c/p>\n<p>A &lt;filter&gt; element as an XML string or an Element object.\x3c/p>","matched":true,"name":"Get","shortdoc":"Retrieve running configuration and device state information.","tags":[]},{"args":["alias","source","filter_type=subtree","filter_criteria=None"],"doc":"<p>Retrieve all or part of a specified configuration.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> name of the configuration datastore being queried\x3c/p>\n<p><code>filter_type\x3c/code> if specified must be one of <code>xpath\x3c/code> or <code>subtree\x3c/code>\x3c/p>\n<p><code>filter_criteria\x3c/code> tuple values (xml and xpath)\x3c/p>\n<p><b>*Filter parameters*\x3c/b>\x3c/p>\n<p>Where a method takes a filter argument, it can take on the following type:\x3c/p>\n<p>A tuple of (filter_type, filter_criteria).\x3c/p>\n<p>Here type has to be one of <code>xpath\x3c/code> or <code>subtree\x3c/code>. For <code>xpath\x3c/code> the criteria should be a string containing the XPath expression. For <code>subtree\x3c/code> the criteria should be an XML string or an Element object containing the criteria.\x3c/p>\n<p>A &lt;filter&gt; element as an XML string or an Element object.\x3c/p>","matched":true,"name":"Get Config","shortdoc":"Retrieve all or part of a specified configuration.","tags":[]},{"args":[],"doc":"<p>Returns server caps\x3c/p>","matched":true,"name":"Get Server Capabilities","shortdoc":"Returns server caps","tags":[]},{"args":[],"doc":"<p>Returns server supported YANG modules\x3c/p>","matched":true,"name":"Get Yang Modules","shortdoc":"Returns server supported YANG modules","tags":[]},{"args":["alias","session_id"],"doc":"<p>Force the termination of a NETCONF session (not the current one!)\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>session_id\x3c/code> is the session identifier of the NETCONF session to be terminated as a string\x3c/p>","matched":true,"name":"Kill Session","shortdoc":"Force the termination of a NETCONF session (not the current one!)","tags":[]},{"args":["alias","target"],"doc":"<p>Allows the client to lock the configuration system of a device.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to lock\x3c/p>","matched":true,"name":"Lock","shortdoc":"Allows the client to lock the configuration system of a device.","tags":[]},{"args":["alias","target"],"doc":"<p>Returns a context manager for a lock on a datastore, where target is the name of the configuration datastore to lock.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to unlock\x3c/p>","matched":true,"name":"Locked","shortdoc":"Returns a context manager for a lock on a datastore, where target","tags":[]},{"args":["alias","target"],"doc":"<p>Release a configuration lock, previously obtained with the lock operation.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>target\x3c/code> is the name of the configuration datastore to unlock\x3c/p>","matched":true,"name":"Unlock","shortdoc":"Release a configuration lock, previously obtained with the lock","tags":[]},{"args":["alias","source"],"doc":"<p>Validate the contents of the specified configuration.\x3c/p>\n<p><code>alias\x3c/code> that will be used to identify the Session object in the cache\x3c/p>\n<p><code>source\x3c/code> is the name of the configuration datastore being validated or config element containing the configuration subtree to be validated\x3c/p>","matched":true,"name":"Validate","shortdoc":"Validate the contents of the specified configuration.","tags":[]}],"name":"NcclientKeywords","named_args":true,"scope":"global","version":""};
 </script>
 <title></title>
 </head>
diff --git a/src/NcclientLibrary/NcclientKeywords.py b/src/NcclientLibrary/NcclientKeywords.py
index 8e59091..bdb25ac 100644
--- a/src/NcclientLibrary/NcclientKeywords.py
+++ b/src/NcclientLibrary/NcclientKeywords.py
@@ -349,7 +349,7 @@ def get(self, alias, filter_type='subtree', filter_criteria=None):
         Where a method takes a filter argument, it can take on the following
         types:
 
-        A tuple of (type, criteria).
+        A tuple of (filter_type, filter_criteria).
 
             Here type has to be one of ``xpath`` or ``subtree``.
             For ``xpath`` the criteria should be a string containing the XPath