Welcome to rancidcmd’s documentation!

Contents:

RancidCmd.

class rancidcmd.RancidCmd(**kwargs)[source]

Class RancidCmd.

Attributes:

login (str):RANCID login command(clogin, jlogin, etc).
user (str):Login username.
password (str):Login password.
address (str):Host name or address.
enable_password (str, optional):
 Enable password for clogin. Default is None.
timeout(int, optional):
 Timeout value(seconds). Default is 10 seconds.
encoding(str, optional):
 Encoding type. Default is ‘utf-8’.

Using example:

static check_cloginrc(name='.cloginrc')[source]

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.
cmd_exec(command)[source]

Login and command execution.

Args:

command (str):Command for execution.

Returns:

dict:Example is below.
{
‘std_err’: ‘’, ‘std_out’: ‘’,

}

decode_bytes(byte_data)[source]

Change string with encoding setting.

Args:

byte_data (bytes):
 Popen output.
execute(command)[source]

Command execution.

Args:

command (str):Example is “show version”.

Returns:

dict:Example is below.
{
‘std_err’: ‘’, ‘std_out’: ‘’,

}

generate_cmd(command)[source]

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"'
static touch(path)[source]

Make empty file.

Args:

path (str):File path.

Indices and tables