added pydocs for netclient

This commit is contained in:
bharnden 2019-10-01 15:38:23 -07:00
parent af7faa85df
commit 4079df9739
3 changed files with 148 additions and 26 deletions

View file

@ -53,7 +53,7 @@ class NodeBase(object):
self.type = None
self.server = None
self.services = None
# ifindex is key, PyCoreNetIf instance is value
# ifindex is key, CoreInterface instance is value
self._netif = {}
self.ifindex = 0
self.canvas = None
@ -364,6 +364,17 @@ class CoreNodeBase(NodeBase):
return common
def network_cmd(self, args):
"""
Runs a command for a node that is used to configure and setup network interfaces.
:param list[str]|str args: command to run
:return: combined stdout and stderr
:rtype: str
:raises CoreCommandError: when a non-zero exit status occurs
"""
raise NotImplementedError
def check_cmd(self, args):
"""
Runs shell command on node.