4.1. capture via jumpssh execution module

class nettoolkit.capture.executions.Captures_via_Jump_Server(server: str = '', server_login_username: str = '', server_private_key_file: str = None, server_login_password: str = None, devices: list = <factory>, device_username: str = '', device_password: str = '', cmds_list_dict: dict = <factory>, output_path: str = '.')

Bases: Multi_Execution, Validate

cmds_list_dict: dict

device_password: str = ''

device_username: str = ''

devices: list

execute(device)

abstract class method, to be executed for each item in self.items

Parameters:

hn (str, int, float) – individual items to be executed for each

output_path: str = '.'

print_report(tablefmt=None)

server: str = ''

server_login_password: str = None

server_login_username: str = ''

server_private_key_file: str = None

update_reporting_dict(device, D)

validate_inputs()

nettoolkit.capture.executions.capture_by_jump_server_login(server, server_login_username, server_private_key_file=None, server_login_password=None, devices=[], devices_auth={'en': '', 'pw': '', 'un': ''}, cmds_list_dict={}, output_path='.', append=False, missing_only=False, cumulative=True, max_connections=100, tablefmt='rounded_outline', failed_retry_count=2, interactive_cmd_report=True, final_cmd_report=False, standard_output=True)

4.2. capture via jumpssh jump_server module

class nettoolkit.capture.jump_server.JumpServer(server: str = '', server_login_username: str = '', server_private_key_file: str = None, server_login_password: str = None)

Bases: object

connect_server()

create_server_session()

erase_hostkey(host)

get_cmd_output(cmd)

get_remote_session(*args, **kwargs)

server: str = ''

server_login_password: str = None

server_login_username: str = ''

server_private_key_file: str = None

4.3. capture via jumpssh device module

class nettoolkit.capture.device.Device(jump_host: <built-in function any>, device: str, device_username: str, device_password: str = '', output_path: str = '', cumulative: bool = False, interactive_cmd_report: bool = False, final_cmd_report: bool = False, failed_retry_count: int = 2, append: bool = False, missing_only: bool = False, standard_output: bool = True, cmds_list_dict: dict = <factory>)

Bases: object

append: bool = False

capture()

cmds_list_dict: dict

create_device_session(attempt=0)

create_output_file()

cumulative: bool = False

device: str

device_password: str = ''

device_types = {'arista': ('arista', 'eos'), 'cisco': ('cisco', 'ios'), 'juniper': ('juniper', 'junos')}

device_username: str

failed_retry_count: int = 2

filter_captured_commands()

final_cmd_report: bool = False

init_var()

interactive_cmd_report: bool = False

is_cmd_capture_available(cmd)

is_valid_device_type()

is_valid_session()

jump_host: any

missing_only: bool = False

output_path: str = ''

pre_checks_and_sets()

remark_char_dict = {'arista': '!', 'cisco': '!', 'juniper': '#'}

standard_output: bool = True

write_output()

4.4. capture via jumpssh commands module

class nettoolkit.capture.commands.Command(cmd: str, device: str, device_session: <built-in function any>, device_type: str, output_file: str, missing_only: bool = False, output_file_read: str = '', remark_char: str = '', standard_output: bool = True, interactive_cmd_report: bool = False, final_cmd_report: bool = False, failed_retry_count: int = 2)

Bases: object

append_output_to_file()

property banner_lines

capture()

cmd: str

device: str

device_session: any

device_type: str

property double_line

failed_retry_count: int = 2

final_cmd_report: bool = False

interactive_cmd_report: bool = False

is_cmd_capture_available()

log_message(msg)

missing_only: bool = False

output_file: str

output_file_read: str = ''

remark_char: str = ''

standard_output: bool = True

static strip_extra_lf_characters(cmd_op)

write_output_to_file()

class nettoolkit.capture.commands.Commands(list_of_cmds: list = <factory>, device: str = '', device_session: <built-in function any> = '', device_type: str = '', output_file: str = '', remark_char: str = '', standard_output: bool = True, missing_only: bool = False, cumulative: bool = False, interactive_cmd_report: bool = False, final_cmd_report: bool = False, failed_retry_count: int = 2)

Bases: object

capture()

cumulative: bool = False

device: str = ''

device_session: any = ''

device_type: str = ''

failed_retry_count: int = 2

final_cmd_report: bool = False

interactive_cmd_report: bool = False

list_of_cmds: list

missing_only: bool = False

output_file: str = ''

read_capture_file()

remark_char: str = ''

standard_output: bool = True

4.5. capture via jumpssh validations module

class nettoolkit.capture.validations.Validate

Bases: object

input_append_bool()

input_cmds_list_dict_dict()

input_cumulative_bool()

input_device_username_str()

input_devices_iterable()

input_final_cmd_report_bool()

input_interactive_cmd_report_bool()

input_max_connections_int()

input_missing_only_bool()

input_server_login_username_str()

input_server_str()

input_tablefmt_str()

4.6. capture via jumpssh exceptions module

nettoolkit.capture.exceptions.Report_Bug_cisco_CSCsq51052(device)