update docs
This commit is contained in:
180
conn/core.py
180
conn/core.py
@ -16,37 +16,45 @@ import threading
|
|||||||
class node:
|
class node:
|
||||||
''' This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.
|
''' This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.
|
||||||
|
|
||||||
Attributes:
|
### Attributes:
|
||||||
|
|
||||||
- output (str) -- Output of the commands you ran with run or test
|
- output (str): Output of the commands you ran with run or test
|
||||||
-- method.
|
method.
|
||||||
- result(bool) -- True if expected value is found after running
|
|
||||||
-- the commands using test method.
|
- result(bool): True if expected value is found after running
|
||||||
|
the commands using test method.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''):
|
def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''):
|
||||||
'''
|
'''
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- unique (str) -- Unique name to assign to the node.
|
- unique (str): Unique name to assign to the node.
|
||||||
- host (str) -- IP address or hostname of the node.
|
|
||||||
|
|
||||||
Optional Parameters:
|
- host (str): IP address or hostname of the node.
|
||||||
|
|
||||||
- options (str) -- Additional options to pass the ssh/telnet for
|
### Optional Parameters:
|
||||||
-- connection.
|
|
||||||
- logs (str) -- Path/file for storing the logs. You can use
|
- options (str): Additional options to pass the ssh/telnet for
|
||||||
-- ${unique},${host}, ${port}, ${user}, ${protocol}
|
connection.
|
||||||
-- as variables.
|
|
||||||
- password (str) -- Encrypted or plaintext password.
|
- logs (str): Path/file for storing the logs. You can use
|
||||||
- port (str) -- Port to connect to node, default 22 for ssh and 23
|
${unique},${host}, ${port}, ${user}, ${protocol}
|
||||||
-- for telnet.
|
as variables.
|
||||||
- protocol (str) -- Select ssh or telnet. Default is ssh.
|
|
||||||
- user (str) -- Username to of the node.
|
- password (str): Encrypted or plaintext password.
|
||||||
- config (obj) -- Pass the object created with class configfile with
|
|
||||||
-- key for decryption and extra configuration if you
|
- port (str): Port to connect to node, default 22 for ssh and 23
|
||||||
-- are using connection manager.
|
for telnet.
|
||||||
|
|
||||||
|
- protocol (str): Select ssh or telnet. Default is ssh.
|
||||||
|
|
||||||
|
- user (str): Username to of the node.
|
||||||
|
|
||||||
|
- config (obj): Pass the object created with class configfile with
|
||||||
|
key for decryption and extra configuration if you
|
||||||
|
are using connection manager.
|
||||||
'''
|
'''
|
||||||
if config == '':
|
if config == '':
|
||||||
self.idletime = 0
|
self.idletime = 0
|
||||||
@ -140,10 +148,10 @@ class node:
|
|||||||
'''
|
'''
|
||||||
Allow user to interact with the node directly, mostly used by connection manager.
|
Allow user to interact with the node directly, mostly used by connection manager.
|
||||||
|
|
||||||
Optional Parameters:
|
### Optional Parameters:
|
||||||
|
|
||||||
- debug (bool) -- If True, display all the connecting information
|
- debug (bool): If True, display all the connecting information
|
||||||
-- before interact. Default False.
|
before interact. Default False.
|
||||||
'''
|
'''
|
||||||
connect = self._connect(debug = debug)
|
connect = self._connect(debug = debug)
|
||||||
if connect == True:
|
if connect == True:
|
||||||
@ -167,26 +175,28 @@ class node:
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node and return the output.
|
Run a command or list of commands on the node and return the output.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or a list of str.
|
str or a list of str.
|
||||||
|
|
||||||
Optional Named Parameters:
|
### Optional Named Parameters:
|
||||||
|
|
||||||
- folder (str) -- Path where output log should be stored, leave
|
- folder (str): Path where output log should be stored, leave
|
||||||
-- empty to disable logging.
|
empty to disable logging.
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
|
||||||
-- work for most nodes. Change it if your connection
|
|
||||||
-- need some special symbol.
|
|
||||||
- stdout (bool) -- Set True to send the command output to stdout.
|
|
||||||
-- default False.
|
|
||||||
|
|
||||||
Returns:
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
str -> Output of the commands you ran on the node.
|
- stdout (bool):Set True to send the command output to stdout.
|
||||||
|
default False.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
str: Output of the commands you ran on the node.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -232,24 +242,25 @@ class node:
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or list of str.
|
str or list of str.
|
||||||
- expected (str) -- Expected text to appear after running
|
|
||||||
-- all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
- expected (str) : Expected text to appear after running
|
||||||
|
all the commands on the node.
|
||||||
|
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
### Optional Named Parameters:
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
-- work for most nodes. Change it if your connection
|
running. Usually linux uses ">" or EOF while
|
||||||
-- need some special symbol.
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
### Returns:
|
### Returns:
|
||||||
bool -- true if expected value is found after running the commands
|
bool: true if expected value is found after running the commands
|
||||||
false if prompt is found before.
|
false if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -402,7 +413,7 @@ class nodes:
|
|||||||
port(str), protocol(str), user(str).
|
port(str), protocol(str), user(str).
|
||||||
For reference on subkeys check node class.
|
For reference on subkeys check node class.
|
||||||
|
|
||||||
Optional Parameters:
|
### Optional Parameters:
|
||||||
|
|
||||||
- config (obj): Pass the object created with class configfile with key
|
- config (obj): Pass the object created with class configfile with key
|
||||||
for decryption and extra configuration if you are using
|
for decryption and extra configuration if you are using
|
||||||
@ -426,17 +437,34 @@ class nodes:
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist.
|
Run a command or list of commands on all the nodes in nodelist.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
folder (str): Path where output log should be stored, leave empty to disable logging.
|
list of str.
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
|
||||||
stdout (bool): Set True to send the command output to stdout. default False.
|
|
||||||
parallel (int): Number of nodes to run the commands simultaneously. Default is 10, if there are more nodes that this value, nodes are groups in groups with max this number of members.
|
|
||||||
|
|
||||||
Returns:
|
### Optional Named Parameters:
|
||||||
dict: Dictionary formed by nodes unique as keys, Output of the commands you ran on the node as value.
|
|
||||||
|
folder (str): Path where output log should be stored, leave empty
|
||||||
|
to disable logging.
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while routers
|
||||||
|
use ">" or "#". The default value should work for
|
||||||
|
most nodes. Change it if your connection need some
|
||||||
|
special symbol.
|
||||||
|
|
||||||
|
stdout (bool): Set True to send the command output to stdout.
|
||||||
|
Default False.
|
||||||
|
|
||||||
|
parallel (int): Number of nodes to run the commands simultaneously.
|
||||||
|
Default is 10, if there are more nodes that this
|
||||||
|
value, nodes are groups in groups with max this
|
||||||
|
number of members.
|
||||||
|
|
||||||
|
###Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, Output of the
|
||||||
|
commands you ran on the node as value.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
@ -466,15 +494,27 @@ class nodes:
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
commands (str): Expected text to appear after running all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
list of str.
|
||||||
|
|
||||||
Returns:
|
expected (str) : Expected text to appear after running all the
|
||||||
dict: Dictionary formed by nodes unique as keys, value is True if expected value is found after running the commands, False if prompt is found before.
|
commands on the node.
|
||||||
|
|
||||||
|
### Optional Named Parameters:
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, value is True if
|
||||||
|
expected value is found after running the commands, False
|
||||||
|
if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
|
|||||||
@ -8,9 +8,12 @@
|
|||||||
<meta name="description" content="" />
|
<meta name="description" content="" />
|
||||||
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
|
||||||
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
|
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
|
||||||
|
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/fundation.min.css" crossorigin>
|
||||||
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||||||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
||||||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||||||
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
|
||||||
|
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<main>
|
<main>
|
||||||
@ -322,33 +325,38 @@ __pdoc__ = {
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.</p>
|
<div class="desc"><p>This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.</p>
|
||||||
<p>Attributes:
|
<h3 id="attributes">Attributes:</h3>
|
||||||
</p>
|
<pre><code>- output (str): Output of the commands you ran with run or test
|
||||||
<pre><code>- output (str) -- Output of the commands you ran with run or test
|
method.
|
||||||
-- method.
|
|
||||||
- result(bool) -- True if expected value is found after running
|
- result(bool): True if expected value is found after running
|
||||||
-- the commands using test method.
|
the commands using test method.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Parameters:
|
<h3 id="parameters">Parameters:</h3>
|
||||||
</p>
|
<pre><code>- unique (str): Unique name to assign to the node.
|
||||||
<pre><code>- unique (str) -- Unique name to assign to the node.
|
|
||||||
- host (str) -- IP address or hostname of the node.
|
- host (str): IP address or hostname of the node.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Optional Parameters:
|
<h3 id="optional-parameters">Optional Parameters:</h3>
|
||||||
</p>
|
<pre><code>- options (str): Additional options to pass the ssh/telnet for
|
||||||
<pre><code>- options (str) -- Additional options to pass the ssh/telnet for
|
connection.
|
||||||
-- connection.
|
|
||||||
- logs (str) -- Path/file for storing the logs. You can use
|
- logs (str): Path/file for storing the logs. You can use
|
||||||
-- ${unique},${host}, ${port}, ${user}, ${protocol}
|
${unique},${host}, ${port}, ${user}, ${protocol}
|
||||||
-- as variables.
|
as variables.
|
||||||
- password (str) -- Encrypted or plaintext password.
|
|
||||||
- port (str) -- Port to connect to node, default 22 for ssh and 23
|
- password (str): Encrypted or plaintext password.
|
||||||
-- for telnet.
|
|
||||||
- protocol (str) -- Select ssh or telnet. Default is ssh.
|
- port (str): Port to connect to node, default 22 for ssh and 23
|
||||||
- user (str) -- Username to of the node.
|
for telnet.
|
||||||
- config (obj) -- Pass the object created with class configfile with
|
|
||||||
-- key for decryption and extra configuration if you
|
- protocol (str): Select ssh or telnet. Default is ssh.
|
||||||
-- are using connection manager.
|
|
||||||
|
- user (str): Username to of the node.
|
||||||
|
|
||||||
|
- config (obj): Pass the object created with class configfile with
|
||||||
|
key for decryption and extra configuration if you
|
||||||
|
are using connection manager.
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
@ -357,37 +365,45 @@ __pdoc__ = {
|
|||||||
<pre><code class="python">class node:
|
<pre><code class="python">class node:
|
||||||
''' This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.
|
''' This class generates a node object. Containts all the information and methods to connect and interact with a device using ssh or telnet.
|
||||||
|
|
||||||
Attributes:
|
### Attributes:
|
||||||
|
|
||||||
- output (str) -- Output of the commands you ran with run or test
|
- output (str): Output of the commands you ran with run or test
|
||||||
-- method.
|
method.
|
||||||
- result(bool) -- True if expected value is found after running
|
|
||||||
-- the commands using test method.
|
- result(bool): True if expected value is found after running
|
||||||
|
the commands using test method.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''):
|
def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''):
|
||||||
'''
|
'''
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- unique (str) -- Unique name to assign to the node.
|
- unique (str): Unique name to assign to the node.
|
||||||
- host (str) -- IP address or hostname of the node.
|
|
||||||
|
|
||||||
Optional Parameters:
|
- host (str): IP address or hostname of the node.
|
||||||
|
|
||||||
- options (str) -- Additional options to pass the ssh/telnet for
|
### Optional Parameters:
|
||||||
-- connection.
|
|
||||||
- logs (str) -- Path/file for storing the logs. You can use
|
- options (str): Additional options to pass the ssh/telnet for
|
||||||
-- ${unique},${host}, ${port}, ${user}, ${protocol}
|
connection.
|
||||||
-- as variables.
|
|
||||||
- password (str) -- Encrypted or plaintext password.
|
- logs (str): Path/file for storing the logs. You can use
|
||||||
- port (str) -- Port to connect to node, default 22 for ssh and 23
|
${unique},${host}, ${port}, ${user}, ${protocol}
|
||||||
-- for telnet.
|
as variables.
|
||||||
- protocol (str) -- Select ssh or telnet. Default is ssh.
|
|
||||||
- user (str) -- Username to of the node.
|
- password (str): Encrypted or plaintext password.
|
||||||
- config (obj) -- Pass the object created with class configfile with
|
|
||||||
-- key for decryption and extra configuration if you
|
- port (str): Port to connect to node, default 22 for ssh and 23
|
||||||
-- are using connection manager.
|
for telnet.
|
||||||
|
|
||||||
|
- protocol (str): Select ssh or telnet. Default is ssh.
|
||||||
|
|
||||||
|
- user (str): Username to of the node.
|
||||||
|
|
||||||
|
- config (obj): Pass the object created with class configfile with
|
||||||
|
key for decryption and extra configuration if you
|
||||||
|
are using connection manager.
|
||||||
'''
|
'''
|
||||||
if config == '':
|
if config == '':
|
||||||
self.idletime = 0
|
self.idletime = 0
|
||||||
@ -481,10 +497,10 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Allow user to interact with the node directly, mostly used by connection manager.
|
Allow user to interact with the node directly, mostly used by connection manager.
|
||||||
|
|
||||||
Optional Parameters:
|
### Optional Parameters:
|
||||||
|
|
||||||
- debug (bool) -- If True, display all the connecting information
|
- debug (bool): If True, display all the connecting information
|
||||||
-- before interact. Default False.
|
before interact. Default False.
|
||||||
'''
|
'''
|
||||||
connect = self._connect(debug = debug)
|
connect = self._connect(debug = debug)
|
||||||
if connect == True:
|
if connect == True:
|
||||||
@ -508,26 +524,28 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node and return the output.
|
Run a command or list of commands on the node and return the output.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or a list of str.
|
str or a list of str.
|
||||||
|
|
||||||
Optional Named Parameters:
|
### Optional Named Parameters:
|
||||||
|
|
||||||
- folder (str) -- Path where output log should be stored, leave
|
- folder (str): Path where output log should be stored, leave
|
||||||
-- empty to disable logging.
|
empty to disable logging.
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
|
||||||
-- work for most nodes. Change it if your connection
|
|
||||||
-- need some special symbol.
|
|
||||||
- stdout (bool) -- Set True to send the command output to stdout.
|
|
||||||
-- default False.
|
|
||||||
|
|
||||||
Returns:
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
str -> Output of the commands you ran on the node.
|
- stdout (bool):Set True to send the command output to stdout.
|
||||||
|
default False.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
str: Output of the commands you ran on the node.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -573,24 +591,25 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or list of str.
|
str or list of str.
|
||||||
- expected (str) -- Expected text to appear after running
|
|
||||||
-- all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
- expected (str) : Expected text to appear after running
|
||||||
|
all the commands on the node.
|
||||||
|
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
### Optional Named Parameters:
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
-- work for most nodes. Change it if your connection
|
running. Usually linux uses ">" or EOF while
|
||||||
-- need some special symbol.
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
### Returns:
|
### Returns:
|
||||||
bool -- true if expected value is found after running the commands
|
bool: true if expected value is found after running the commands
|
||||||
false if prompt is found before.
|
false if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -718,10 +737,9 @@ __pdoc__ = {
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>Allow user to interact with the node directly, mostly used by connection manager.</p>
|
<div class="desc"><p>Allow user to interact with the node directly, mostly used by connection manager.</p>
|
||||||
<p>Optional Parameters:
|
<h3 id="optional-parameters">Optional Parameters:</h3>
|
||||||
</p>
|
<pre><code>- debug (bool): If True, display all the connecting information
|
||||||
<pre><code>- debug (bool) -- If True, display all the connecting information
|
before interact. Default False.
|
||||||
-- before interact. Default False.
|
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
@ -731,10 +749,10 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Allow user to interact with the node directly, mostly used by connection manager.
|
Allow user to interact with the node directly, mostly used by connection manager.
|
||||||
|
|
||||||
Optional Parameters:
|
### Optional Parameters:
|
||||||
|
|
||||||
- debug (bool) -- If True, display all the connecting information
|
- debug (bool): If True, display all the connecting information
|
||||||
-- before interact. Default False.
|
before interact. Default False.
|
||||||
'''
|
'''
|
||||||
connect = self._connect(debug = debug)
|
connect = self._connect(debug = debug)
|
||||||
if connect == True:
|
if connect == True:
|
||||||
@ -760,26 +778,25 @@ __pdoc__ = {
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>Run a command or list of commands on the node and return the output.</p>
|
<div class="desc"><p>Run a command or list of commands on the node and return the output.</p>
|
||||||
<p>Parameters:
|
<h3 id="parameters">Parameters:</h3>
|
||||||
</p>
|
<pre><code>- commands (str/list): Commands to run on the node. Should be
|
||||||
<pre><code>- commands (str/list) -- Commands to run on the node. Should be
|
str or a list of str.
|
||||||
-- str or a list of str.
|
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Optional Named Parameters:
|
<h3 id="optional-named-parameters">Optional Named Parameters:</h3>
|
||||||
</p>
|
<pre><code>- folder (str): Path where output log should be stored, leave
|
||||||
<pre><code>- folder (str) -- Path where output log should be stored, leave
|
empty to disable logging.
|
||||||
-- empty to disable logging.
|
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
-- running. Usually linux uses ">" or EOF while
|
running. Usually linux uses ">" or EOF while
|
||||||
-- routers use ">" or "#". The default value should
|
routers use ">" or "#". The default value should
|
||||||
-- work for most nodes. Change it if your connection
|
work for most nodes. Change it if your connection
|
||||||
-- need some special symbol.
|
need some special symbol.
|
||||||
- stdout (bool) -- Set True to send the command output to stdout.
|
|
||||||
-- default False.
|
- stdout (bool):Set True to send the command output to stdout.
|
||||||
|
default False.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Returns:
|
<h3 id="returns">Returns:</h3>
|
||||||
</p>
|
<pre><code>str: Output of the commands you ran on the node.
|
||||||
<pre><code>str -> Output of the commands you ran on the node.
|
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
@ -789,26 +806,28 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node and return the output.
|
Run a command or list of commands on the node and return the output.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or a list of str.
|
str or a list of str.
|
||||||
|
|
||||||
Optional Named Parameters:
|
### Optional Named Parameters:
|
||||||
|
|
||||||
- folder (str) -- Path where output log should be stored, leave
|
- folder (str): Path where output log should be stored, leave
|
||||||
-- empty to disable logging.
|
empty to disable logging.
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
|
||||||
-- work for most nodes. Change it if your connection
|
|
||||||
-- need some special symbol.
|
|
||||||
- stdout (bool) -- Set True to send the command output to stdout.
|
|
||||||
-- default False.
|
|
||||||
|
|
||||||
Returns:
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
str -> Output of the commands you ran on the node.
|
- stdout (bool):Set True to send the command output to stdout.
|
||||||
|
default False.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
str: Output of the commands you ran on the node.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -856,23 +875,23 @@ __pdoc__ = {
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>Run a command or list of commands on the node, then check if expected value appears on the output after the last command.</p>
|
<div class="desc"><p>Run a command or list of commands on the node, then check if expected value appears on the output after the last command.</p>
|
||||||
<p>Parameters:
|
<h3 id="parameters">Parameters:</h3>
|
||||||
</p>
|
<pre><code>- commands (str/list): Commands to run on the node. Should be
|
||||||
<pre><code>- commands (str/list) -- Commands to run on the node. Should be
|
str or list of str.
|
||||||
-- str or list of str.
|
|
||||||
- expected (str) -- Expected text to appear after running
|
- expected (str) : Expected text to appear after running
|
||||||
-- all the commands on the node.
|
all the commands on the node.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Optional Named Parameters: </p>
|
<h3 id="optional-named-parameters">Optional Named Parameters:</h3>
|
||||||
<pre><code>- prompt (str) -- Prompt to be expected after a command is finished
|
<pre><code>- prompt (str): Prompt to be expected after a command is finished
|
||||||
-- running. Usually linux uses ">" or EOF while
|
running. Usually linux uses ">" or EOF while
|
||||||
-- routers use ">" or "#". The default value should
|
routers use ">" or "#". The default value should
|
||||||
-- work for most nodes. Change it if your connection
|
work for most nodes. Change it if your connection
|
||||||
-- need some special symbol.
|
need some special symbol.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h3 id="returns">Returns:</h3>
|
<h3 id="returns">Returns:</h3>
|
||||||
<pre><code>bool -- true if expected value is found after running the commands
|
<pre><code>bool: true if expected value is found after running the commands
|
||||||
false if prompt is found before.
|
false if prompt is found before.
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
@ -882,24 +901,25 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
|
|
||||||
- commands (str/list) -- Commands to run on the node. Should be
|
- commands (str/list): Commands to run on the node. Should be
|
||||||
-- str or list of str.
|
str or list of str.
|
||||||
- expected (str) -- Expected text to appear after running
|
|
||||||
-- all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
- expected (str) : Expected text to appear after running
|
||||||
|
all the commands on the node.
|
||||||
|
|
||||||
- prompt (str) -- Prompt to be expected after a command is finished
|
### Optional Named Parameters:
|
||||||
-- running. Usually linux uses ">" or EOF while
|
|
||||||
-- routers use ">" or "#". The default value should
|
- prompt (str): Prompt to be expected after a command is finished
|
||||||
-- work for most nodes. Change it if your connection
|
running. Usually linux uses ">" or EOF while
|
||||||
-- need some special symbol.
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
### Returns:
|
### Returns:
|
||||||
bool -- true if expected value is found after running the commands
|
bool: true if expected value is found after running the commands
|
||||||
false if prompt is found before.
|
false if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
connect = self._connect()
|
connect = self._connect()
|
||||||
@ -975,8 +995,7 @@ __pdoc__ = {
|
|||||||
port(str), protocol(str), user(str).
|
port(str), protocol(str), user(str).
|
||||||
For reference on subkeys check node class.
|
For reference on subkeys check node class.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Optional Parameters:
|
<h3 id="optional-parameters">Optional Parameters:</h3>
|
||||||
</p>
|
|
||||||
<pre><code>- config (obj): Pass the object created with class configfile with key
|
<pre><code>- config (obj): Pass the object created with class configfile with key
|
||||||
for decryption and extra configuration if you are using
|
for decryption and extra configuration if you are using
|
||||||
connection manager.
|
connection manager.
|
||||||
@ -1017,7 +1036,7 @@ __pdoc__ = {
|
|||||||
port(str), protocol(str), user(str).
|
port(str), protocol(str), user(str).
|
||||||
For reference on subkeys check node class.
|
For reference on subkeys check node class.
|
||||||
|
|
||||||
Optional Parameters:
|
### Optional Parameters:
|
||||||
|
|
||||||
- config (obj): Pass the object created with class configfile with key
|
- config (obj): Pass the object created with class configfile with key
|
||||||
for decryption and extra configuration if you are using
|
for decryption and extra configuration if you are using
|
||||||
@ -1041,17 +1060,34 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist.
|
Run a command or list of commands on all the nodes in nodelist.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
folder (str): Path where output log should be stored, leave empty to disable logging.
|
list of str.
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
|
||||||
stdout (bool): Set True to send the command output to stdout. default False.
|
|
||||||
parallel (int): Number of nodes to run the commands simultaneously. Default is 10, if there are more nodes that this value, nodes are groups in groups with max this number of members.
|
|
||||||
|
|
||||||
Returns:
|
### Optional Named Parameters:
|
||||||
dict: Dictionary formed by nodes unique as keys, Output of the commands you ran on the node as value.
|
|
||||||
|
folder (str): Path where output log should be stored, leave empty
|
||||||
|
to disable logging.
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while routers
|
||||||
|
use ">" or "#". The default value should work for
|
||||||
|
most nodes. Change it if your connection need some
|
||||||
|
special symbol.
|
||||||
|
|
||||||
|
stdout (bool): Set True to send the command output to stdout.
|
||||||
|
Default False.
|
||||||
|
|
||||||
|
parallel (int): Number of nodes to run the commands simultaneously.
|
||||||
|
Default is 10, if there are more nodes that this
|
||||||
|
value, nodes are groups in groups with max this
|
||||||
|
number of members.
|
||||||
|
|
||||||
|
###Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, Output of the
|
||||||
|
commands you ran on the node as value.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
@ -1081,15 +1117,27 @@ __pdoc__ = {
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
commands (str): Expected text to appear after running all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
list of str.
|
||||||
|
|
||||||
Returns:
|
expected (str) : Expected text to appear after running all the
|
||||||
dict: Dictionary formed by nodes unique as keys, value is True if expected value is found after running the commands, False if prompt is found before.
|
commands on the node.
|
||||||
|
|
||||||
|
### Optional Named Parameters:
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, value is True if
|
||||||
|
expected value is found after running the commands, False
|
||||||
|
if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
@ -1122,19 +1170,32 @@ __pdoc__ = {
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>Run a command or list of commands on all the nodes in nodelist.</p>
|
<div class="desc"><p>Run a command or list of commands on all the nodes in nodelist.</p>
|
||||||
<p>Parameters:<br>
|
<h3 id="parameters">Parameters:</h3>
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.</p>
|
<pre><code>commands (str/list): Commands to run on the node. Should be str or
|
||||||
<p>Optional Named Parameters:<br>
|
list of str.
|
||||||
folder
|
</code></pre>
|
||||||
(str): Path where output log should be stored, leave empty to disable logging.<br>
|
<h3 id="optional-named-parameters">Optional Named Parameters:</h3>
|
||||||
prompt
|
<pre><code>folder (str): Path where output log should be stored, leave empty
|
||||||
(str): Prompt to be expected after a command is finished running. Usually linux uses
|
to disable logging.
|
||||||
">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.<br>
|
|
||||||
stdout
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
(bool): Set True to send the command output to stdout. default False.<br>
|
running. Usually linux uses ">" or EOF while routers
|
||||||
parallel (int): Number of nodes to run the commands simultaneously. Default is 10, if there are more nodes that this value, nodes are groups in groups with max this number of members.</p>
|
use ">" or "#". The default value should work for
|
||||||
<p>Returns:<br>
|
most nodes. Change it if your connection need some
|
||||||
dict: Dictionary formed by nodes unique as keys, Output of the commands you ran on the node as value.</p></div>
|
special symbol.
|
||||||
|
|
||||||
|
stdout (bool): Set True to send the command output to stdout.
|
||||||
|
Default False.
|
||||||
|
|
||||||
|
parallel (int): Number of nodes to run the commands simultaneously.
|
||||||
|
Default is 10, if there are more nodes that this
|
||||||
|
value, nodes are groups in groups with max this
|
||||||
|
number of members.
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="returns">Returns:</h3>
|
||||||
|
<pre><code>dict: Dictionary formed by nodes unique as keys, Output of the
|
||||||
|
commands you ran on the node as value.
|
||||||
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
<span>Expand source code</span>
|
<span>Expand source code</span>
|
||||||
@ -1143,17 +1204,34 @@ dict: Dictionary formed by nodes unique as keys, Output of the commands you ran
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist.
|
Run a command or list of commands on all the nodes in nodelist.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
folder (str): Path where output log should be stored, leave empty to disable logging.
|
list of str.
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
|
||||||
stdout (bool): Set True to send the command output to stdout. default False.
|
|
||||||
parallel (int): Number of nodes to run the commands simultaneously. Default is 10, if there are more nodes that this value, nodes are groups in groups with max this number of members.
|
|
||||||
|
|
||||||
Returns:
|
### Optional Named Parameters:
|
||||||
dict: Dictionary formed by nodes unique as keys, Output of the commands you ran on the node as value.
|
|
||||||
|
folder (str): Path where output log should be stored, leave empty
|
||||||
|
to disable logging.
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while routers
|
||||||
|
use ">" or "#". The default value should work for
|
||||||
|
most nodes. Change it if your connection need some
|
||||||
|
special symbol.
|
||||||
|
|
||||||
|
stdout (bool): Set True to send the command output to stdout.
|
||||||
|
Default False.
|
||||||
|
|
||||||
|
parallel (int): Number of nodes to run the commands simultaneously.
|
||||||
|
Default is 10, if there are more nodes that this
|
||||||
|
value, nodes are groups in groups with max this
|
||||||
|
number of members.
|
||||||
|
|
||||||
|
###Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, Output of the
|
||||||
|
commands you ran on the node as value.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
@ -1185,15 +1263,25 @@ dict: Dictionary formed by nodes unique as keys, Output of the commands you ran
|
|||||||
</code></dt>
|
</code></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<div class="desc"><p>Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.</p>
|
<div class="desc"><p>Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.</p>
|
||||||
<p>Parameters:<br>
|
<h3 id="parameters">Parameters:</h3>
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.<br>
|
<pre><code>commands (str/list): Commands to run on the node. Should be str or
|
||||||
commands (str): Expected text to appear after running all the commands on the node.</p>
|
list of str.
|
||||||
<p>Optional Named Parameters:<br>
|
|
||||||
prompt
|
expected (str) : Expected text to appear after running all the
|
||||||
(str): Prompt to be expected after a command is finished running. Usually linux uses
|
commands on the node.
|
||||||
">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.</p>
|
</code></pre>
|
||||||
<p>Returns:<br>
|
<h3 id="optional-named-parameters">Optional Named Parameters:</h3>
|
||||||
dict: Dictionary formed by nodes unique as keys, value is True if expected value is found after running the commands, False if prompt is found before.</p></div>
|
<pre><code>prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="returns">Returns:</h3>
|
||||||
|
<pre><code>dict: Dictionary formed by nodes unique as keys, value is True if
|
||||||
|
expected value is found after running the commands, False
|
||||||
|
if prompt is found before.
|
||||||
|
</code></pre></div>
|
||||||
<details class="source">
|
<details class="source">
|
||||||
<summary>
|
<summary>
|
||||||
<span>Expand source code</span>
|
<span>Expand source code</span>
|
||||||
@ -1202,15 +1290,27 @@ dict: Dictionary formed by nodes unique as keys, value is True if expected value
|
|||||||
'''
|
'''
|
||||||
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
|
||||||
|
|
||||||
Parameters:
|
### Parameters:
|
||||||
commands (str/list): Commands to run on the node. Should be a str or a list of str.
|
|
||||||
commands (str): Expected text to appear after running all the commands on the node.
|
|
||||||
|
|
||||||
Optional Named Parameters:
|
commands (str/list): Commands to run on the node. Should be str or
|
||||||
prompt (str): Prompt to be expected after a command is finished running. Usually linux uses ">" or EOF while routers use ">" or "#". The default value should work for most nodes. Change it if your connection need some special symbol.
|
list of str.
|
||||||
|
|
||||||
Returns:
|
expected (str) : Expected text to appear after running all the
|
||||||
dict: Dictionary formed by nodes unique as keys, value is True if expected value is found after running the commands, False if prompt is found before.
|
commands on the node.
|
||||||
|
|
||||||
|
### Optional Named Parameters:
|
||||||
|
|
||||||
|
prompt (str): Prompt to be expected after a command is finished
|
||||||
|
running. Usually linux uses ">" or EOF while
|
||||||
|
routers use ">" or "#". The default value should
|
||||||
|
work for most nodes. Change it if your connection
|
||||||
|
need some special symbol.
|
||||||
|
|
||||||
|
### Returns:
|
||||||
|
|
||||||
|
dict: Dictionary formed by nodes unique as keys, value is True if
|
||||||
|
expected value is found after running the commands, False
|
||||||
|
if prompt is found before.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
args = {}
|
args = {}
|
||||||
|
|||||||
Reference in New Issue
Block a user