Coverage for rancidcmd : 97%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# -*- coding: utf-8 -*-
"""Class RancidCmd.
Attributes:
:login (str): RANCID login command(clogin, jlogin, etc). :user (str): Login username. :password (str): Login password. :address (str): Host name or ip address. :enable_password (str, optional): Enable password for clogin. Default is None. :option(int, optional): Option example: '-d -x "commands.txt"'. Default is None. :timeout(int, optional): Timeout value(seconds). Default is 10 seconds. :encoding(str, optional): Encoding type. Default is 'utf-8'.
Using example:
* Please see README. https://github.com/mtoshi/rancidcmd/blob/master/README.rst
* Sample code. https://github.com/mtoshi/rancidcmd/blob/master/samples/sample.py
"""
"""Constructor.
Args:
:login (str): RANCID login command(clogin, jlogin, etc). :user (str): Login username. :password (str): Login password. :address (str): Host name or ip address. :enable_password (str, optional): Enable password for clogin. Default is None. :option(int, optional): Option example: '-d -x "commands.txt"'. Default is None. :timeout(int, optional): Timeout value(seconds). Default is 10 seconds. :encoding(str, optional): Encoding type. Default is 'utf-8'.
"""
"""Check -x option.
"-c" gets commands from command-line. "-x" gets commnads from file.
These are for command option and exclusive. If "-x" option is specified, then "-c" command is ignored. """
"""Generate command.
Args:
:command (str): Example is "show version".
Returns:
:str: Return the command string.
If there is the "enable_password". ::
'xlogin -t 10 -u admin -p password -e enable_password -c "show version"'
If you have not set the "enable_password". ::
'xlogin -t 10 -u admin -p password -c "show version"'
""" command = '' else:
option = self.option
self.login, self.timeout, self.user, self.password, enable_password, option, command, self.address)
"""Change string with encoding setting.
Args:
:byte_data (bytes): Popen output.
"""
"""Login and command execution.
Args:
:command (str): Command for execution.
Returns:
:dict: Example is below. ::
{ 'std_err': '', 'std_out': '', } """ shell=True, stdout=PIPE, stderr=PIPE) 'std_err': self.decode_bytes(std_err)}
"""Execute command string check.
Args:
:command (str): Example is "show version".
Returns:
:str: Return the command string. """
"""Command execution.
Args:
:command (str): Example is "show version".
Returns:
:dict: Example is below. ::
{ 'std_err': '', 'std_out': '', }
"""
def touch(path): """Make empty file.
Args:
:path (str): File path.
"""
"""Check rancid settings file.
Note:
If RANCID settings file is not exists, then make empty settings file.
Args:
:name (str, optional): RANCID settings file name. Default is ".cloginrc".
Returns:
:str: RANCID settings file path.
""" |