Module Expr Str ImportFrom alias ImportFrom alias Import alias Import alias Import alias Import alias Import alias ImportFrom alias ImportFrom alias alias ImportFrom alias alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults Str Str Str Str Str Num Str NameLoad Num NameLoad NameLoad NameLoad NameLoad NameLoad Str NameLoad body If NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad orelse If NameLoad body Assign AttributeStore NameLoad attr NameLoad If BoolOpAnd UnaryOpNot NameLoad UnaryOpNot NameLoad body Raise Call NameLoad Str Assign AttributeStore NameLoad attr Call NameLoad NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Str If UnaryOpNot NameLoad body Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr orelse Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If Call AttributeLoad NameLoad attr NameLoad body Assign NameStore Call AttributeLoad NameLoad attr With Call NameLoad NameLoad NameStore body Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad orelse Assign NameStore Dict If Call AttributeLoad NameLoad attr Str body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str orelse If Call AttributeLoad NameLoad attr Str body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str orelse Assign NameStore NameLoad If CompareEq SubscriptLoad NameLoad Index Str Num body Assign SubscriptStore NameLoad Index Str Call NameLoad Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr If CompareEq SubscriptLoad NameLoad Index Str Str body Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr If NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad Num body Expr Str Return Dict Str Str Str Str Str Str Str Str AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults Num NameLoad Num NameLoad NameLoad body Expr Str Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr If BoolOpAnd AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr TryExcept body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad Str attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Raise Call NameLoad NameLoad ExceptHandler type AttributeLoad AttributeLoad NameLoad attr attr name NameStore body Assign NameStore Call AttributeLoad Str attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpAdd Str Call NameLoad NameLoad Raise Call NameLoad NameLoad If NameLoad body Expr Call NameLoad Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Expr Call AttributeLoad NameLoad attr If NameLoad body Expr Call NameLoad Str Expr Call AttributeLoad NameLoad attr Num If Call AttributeLoad NameLoad attr body Return Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str Return Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareGtE NameLoad AttributeLoad NameLoad attr body Return NameLoad orelse Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults Num body Expr Str Pass decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str Num body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Num Num body Expr Str Assign NameStore Num Expr Call AttributeLoad NameLoad attr NameLoad While CompareLtE NameLoad NameLoad body If Call AttributeLoad AttributeLoad NameLoad attr attr body Return NameLoad orelse Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore BinOpMult NameLoad Num If CompareGtE NameLoad Num body Assign NameStore Num Expr Call AttributeLoad NameLoad attr NameLoad AugAssignAdd NameStore Num Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Num Num NameLoad body Expr Str Assign NameStore Num Expr Call AttributeLoad NameLoad attr NameLoad While CompareLtE NameLoad NameLoad body If Call AttributeLoad AttributeLoad NameLoad attr attr body Return NameLoad orelse Expr Call AttributeLoad NameLoad attr NameLoad AugAssignAdd NameStore Num Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str Str Num body Expr Str Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad If UnaryOpNot CompareIn SubscriptLoad NameLoad Index Num TupleLoad NameLoad NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad Assign AttributeStore NameLoad attr SubscriptLoad NameLoad Slice Num Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults Num body Expr Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Str If Call AttributeLoad AttributeLoad NameLoad attr attr body Assign NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Num While BoolOpAnd CompareLtE NameLoad Num UnaryOpNot NameLoad body If Call AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str If AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr AugAssignAdd NameStore Num Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num Assign NameStore Call AttributeLoad NameLoad attr If UnaryOpNot NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If Call AttributeLoad AttributeLoad NameLoad attr attr body Return Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str orelse Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults Num Num NameLoad NameLoad body Expr Str Assign NameStore NameLoad If NameLoad body Expr Call NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Expr Call NameLoad Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad For NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad body AugAssignAdd NameStore NameLoad If AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Expr Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore SubscriptLoad NameLoad Index Num If CompareIn AttributeLoad NameLoad attr NameLoad body Return Call AttributeLoad Str attr SubscriptLoad NameLoad Slice Num orelse Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str Num body Expr Str Assign NameStore Str If UnaryOpNot NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad While NameLoad body TryExcept body AugAssignAdd NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str If Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad body Return NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr body Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str Num body Expr Str Assign NameStore Str If UnaryOpNot NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr While NameLoad body TryExcept body AugAssignAdd NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str If BoolOpOr Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad body Return NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr body Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad Num Num NameLoad NameLoad NameLoad body Expr Str Assign NameStore NameLoad If CompareIs NameLoad NameLoad body If NameLoad body TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad handlers ExceptHandler type NameLoad body Assign NameStore AttributeLoad NameLoad attr orelse Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr orelse Assign NameStore NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Expr Call NameLoad Call AttributeLoad Str attr NameLoad Expr Call NameLoad Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr BinOpMult NameLoad Num Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore Num Assign NameStore Str While CompareLtE NameLoad NameLoad body If Call AttributeLoad AttributeLoad NameLoad attr attr body AugAssignAdd NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore SubscriptLoad NameLoad Index Num If CompareIn NameLoad NameLoad body Assign NameStore BinOpAdd NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword Str keyword NameLoad Assign SubscriptStore NameLoad Index Num NameLoad Assign NameStore Call AttributeLoad Str attr NameLoad handlers ExceptHandler type NameLoad body Pass If Call AttributeLoad NameLoad attr NameLoad NameLoad body Break orelse Expr Call AttributeLoad NameLoad attr BinOpMult NameLoad Num AugAssignAdd NameStore Num orelse Raise Call NameLoad Call AttributeLoad Str attr NameLoad If AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Str Return Call AttributeLoad NameLoad attr NameLoad Str decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Str If CompareIn NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore SubscriptLoad NameLoad Slice Num Return Call AttributeLoad Str attr NameLoad orelse Assign NameStore Call NameLoad NameLoad Return SubscriptLoad NameLoad Slice NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str Return Call AttributeLoad NameLoad attr Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str AugAssignAdd NameStore Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad NameLoad attr Return CompareIn NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str Str AttributeLoad NameLoad attr body Expr Str Assign NameStore Str If UnaryOpNot Call AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad AugAssignAdd NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr AugAssignAdd NameStore Call AttributeLoad NameLoad attr If UnaryOpNot Call AttributeLoad NameLoad attr body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Assign NameStore Str If Call AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad AugAssignAdd NameStore Call AttributeLoad NameLoad attr If Call AttributeLoad NameLoad attr body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad NameLoad attr Return CompareIn NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Assign NameStore Str If UnaryOpNot Call AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr If UnaryOpNot Call AttributeLoad NameLoad attr body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Assign NameStore Str If Call AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr If Call AttributeLoad NameLoad attr body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Num Num body Expr Str Assign NameStore Num While CompareLtE NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad If Call AttributeLoad AttributeLoad NameLoad attr attr body Expr Yield Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr Str Str orelse Expr Call AttributeLoad NameLoad attr BinOpMult NameLoad Num If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr body Break AugAssignAdd NameStore Num decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad kwarg body Expr Str With Call AttributeLoad NameLoad attr NameLoad keyword Str NameStore body Return Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad Num Num NameLoad NameLoad body Expr Str Assign NameStore NameLoad If CompareIs NameLoad NameLoad body Return Str If UnaryOpNot Call NameLoad NameLoad Str body Raise Call NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr For NameStore NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr BinOpDiv NameLoad Num For NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad body AugAssignAdd NameStore NameLoad If NameLoad body AugAssignAdd NameStore Call AttributeLoad NameLoad attr If NameLoad body Expr Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore NameLoad If NameLoad body Expr Call NameLoad Str Expr Call NameLoad BinOpMod Str Call NameLoad NameLoad Assign NameStore BinOpAdd Call NameLoad Num Str Assign NameStore BinOpAdd Call NameLoad Num Str Assign NameStore BinOpAdd Call NameLoad Num Str Assign NameStore BinOpAdd Call NameLoad Num Str Assign NameStore BinOpAdd Call NameLoad Num Str Assign NameStore ListLoad NameLoad NameLoad NameLoad NameLoad Assign NameStore NameLoad For NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Str NameLoad If NameLoad body Expr Call NameLoad BinOpMod Str NameLoad Expr Call NameLoad BinOpMod Str Call NameLoad NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Pass decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call NameLoad Str decorator_list decorator_list
N/A N/A 
Base connection class for netmiko

Handles SSH connection and methods that are generically applicable to different
platforms (Cisco and non-Cisco).

Also defines methods that should generally be supported by child classes
 __future__ print_function __future__ unicode_literals N/A paramiko N/A time N/A socket N/A re N/A io os path netmiko.netmiko_globals MAX_BUFFER BACKSPACE_CHAR netmiko.ssh_exception NetMikoTimeoutException NetMikoAuthenticationException BaseSSHConnection N/A object N/A N/A 
    Defines vendor independent methods.

    Otherwise method left as a stub method.
     __init__ N/A N/A self ip host username password secret port device_type verbose global_delay_factor use_keys key_file ssh_strict system_host_keys alt_host_keys alt_key_file ssh_config_file N/A 22 False 0.1 False None False False False None N/A N/A ip N/A N/A N/A self host ip N/A N/A self ip ip N/A N/A host N/A N/A N/A self host host N/A N/A N/A ip N/A host N/A N/A N/A ValueError Either ip or host must be set N/A N/A self port N/A int port N/A N/A self username username N/A N/A self password password N/A N/A self secret secret N/A N/A self device_type device_type N/A N/A self ansi_escape_codes False N/A N/A self global_delay_factor global_delay_factor N/A N/A self base_prompt N/A N/A ssh_strict N/A N/A N/A self key_policy N/A N/A paramiko AutoAddPolicy N/A N/A N/A self key_policy N/A N/A paramiko RejectPolicy N/A N/A self system_host_keys system_host_keys N/A N/A self alt_host_keys alt_host_keys N/A N/A self alt_key_file alt_key_file N/A N/A self ssh_config_file ssh_config_file N/A N/A N/A self establish_connection verbose verbose use_keys use_keys key_file key_file N/A N/A N/A self session_preparation N/A session_preparation N/A N/A self N/A N/A N/A 
        Prepare the session after the connection has been established

        This method handles some of vagaries that occur between various devices
        early on in the session.

        In general, it should include:
        self.set_base_prompt()
        self.disable_paging()   # if applicable
         N/A N/A N/A self set_base_prompt N/A N/A N/A self disable_paging N/A _use_ssh_config N/A N/A self connect_dict N/A N/A N/A 
        Update SSH connection parameters based on contents of SSH 'config' file

        This method modifies the connect_dict dictionary, returns None
         N/A full_path N/A N/A path abspath N/A N/A path expanduser N/A self ssh_config_file N/A N/A N/A path exists full_path N/A N/A ssh_config_instance N/A N/A paramiko SSHConfig N/A N/A open full_path f N/A N/A N/A N/A ssh_config_instance parse f N/A host_specifier N/A N/A {0}:{1} format N/A self host N/A self port N/A source N/A N/A ssh_config_instance lookup host_specifier N/A N/A source N/A N/A N/A N/A source get proxycommand N/A N/A proxy N/A N/A paramiko ProxyCommand N/A source N/A proxycommand N/A N/A N/A N/A source get ProxyCommand N/A N/A proxy N/A N/A paramiko ProxyCommand N/A source N/A proxycommand N/A N/A proxy None N/A N/A N/A connect_dict N/A port 22 N/A N/A N/A connect_dict N/A port N/A int N/A N/A source get port N/A self port N/A N/A N/A connect_dict N/A username N/A N/A N/A connect_dict N/A username N/A N/A source get username N/A self username N/A proxy N/A N/A N/A connect_dict N/A sock proxy N/A N/A connect_dict N/A hostname N/A N/A source get hostname N/A self host N/A _connect_params_dict N/A N/A self use_keys key_file timeout N/A False None 8 N/A N/A Convert Paramiko connect params to a dictionary. N/A N/A hostname port username password look_for_keys allow_agent key_filename timeout N/A self host N/A self port N/A self username N/A self password use_keys False key_file timeout N/A establish_connection N/A N/A self sleep_time verbose timeout use_keys key_file N/A 3 True 8 False None N/A N/A 
        Establish SSH connection to the network device

        Timeout will generate a NetMikoTimeoutException
        Authentication failure will generate a NetMikoAuthenticationException

        use_keys is a boolean that allows ssh-keys to be used for authentication
         N/A ssh_connect_params N/A N/A self _connect_params_dict use_keys use_keys key_file key_file timeout timeout N/A N/A self ssh_config_file N/A N/A N/A N/A self _use_ssh_config ssh_connect_params N/A N/A self remote_conn_pre N/A N/A paramiko SSHClient N/A N/A self system_host_keys N/A N/A N/A N/A N/A self remote_conn_pre load_system_host_keys N/A N/A N/A self alt_host_keys N/A N/A path isfile N/A self alt_key_file N/A N/A N/A N/A N/A self remote_conn_pre load_host_keys N/A self alt_key_file N/A N/A N/A N/A self remote_conn_pre set_missing_host_key_policy N/A self key_policy N/A N/A N/A N/A N/A N/A self remote_conn_pre connect ssh_connect_params N/A N/A N/A N/A socket error N/A N/A msg N/A N/A Connection to device timed-out: {device_type} {ip}:{port} format device_type N/A self device_type ip N/A self host port N/A self port N/A N/A NetMikoTimeoutException msg N/A N/A N/A N/A paramiko ssh_exception AuthenticationException N/A auth_err N/A N/A msg N/A N/A Authentication failure: unable to connect {device_type} {ip}:{port} format device_type N/A self device_type ip N/A self host port N/A self port N/A msg N/A N/A str auth_err N/A N/A NetMikoAuthenticationException msg N/A verbose N/A N/A N/A print N/A N/A SSH connection established to {0}:{1} format N/A self host N/A self port N/A N/A self remote_conn N/A N/A N/A self remote_conn_pre invoke_shell N/A N/A N/A N/A self remote_conn settimeout timeout N/A N/A N/A self special_login_handler N/A verbose N/A N/A N/A print Interactive SSH session established N/A N/A N/A time sleep 0.1 N/A N/A N/A self wait_for_recv_ready_newline N/A N/A N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A select_delay_factor N/A N/A self delay_factor N/A N/A N/A Choose the greater of delay_factor or self.global_delay_factor. N/A N/A delay_factor N/A self global_delay_factor N/A N/A delay_factor N/A N/A N/A self global_delay_factor N/A special_login_handler N/A N/A self delay_factor N/A 0.1 N/A N/A Handler for devices like WLC, Avaya ERS that throw up characters prior to login. N/A N/A disable_paging N/A N/A self command delay_factor N/A terminal length 0 0.1 N/A N/A Disable paging default to a Cisco CLI method. N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd command N/A output N/A N/A self read_until_prompt N/A N/A self ansi_escape_codes N/A N/A output N/A N/A self strip_ansi_escape_codes output N/A output N/A wait_for_recv_ready_newline N/A N/A self delay_factor max_loops N/A 0.1 20 N/A N/A Wait for data to be in the buffer so it can be received. N/A i 0 N/A N/A N/A time sleep delay_factor N/A N/A i max_loops N/A N/A N/A N/A N/A self remote_conn recv_ready N/A N/A True N/A N/A N/A N/A N/A self remote_conn sendall N/A delay_factor N/A delay_factor 1.1 N/A N/A delay_factor 8 N/A N/A delay_factor 8 N/A N/A N/A time sleep delay_factor N/A i 1 N/A N/A NetMikoTimeoutException Timed out waiting for recv_ready N/A wait_for_recv_ready N/A N/A self delay_factor max_loops send_newline N/A 0.1 100 False N/A N/A Wait for data to be in the buffer so it can be received. N/A i 0 N/A N/A N/A time sleep delay_factor N/A N/A i max_loops N/A N/A N/A N/A N/A self remote_conn recv_ready N/A N/A True N/A N/A N/A N/A time sleep delay_factor N/A i 1 N/A N/A NetMikoTimeoutException Timed out waiting for recv_ready N/A set_base_prompt N/A N/A self pri_prompt_terminator alt_prompt_terminator delay_factor N/A # > 0.1 N/A N/A 
        Sets self.base_prompt

        Used as delimiter for stripping of trailing prompt in output.

        Should be set to something that is general and applies in multiple contexts. For Cisco
        devices this will be set to router hostname (i.e. prompt without '>' or '#').

        This will be set on entering user exec or privileged exec on Cisco, but not when
        entering/exiting config mode.
         N/A prompt N/A N/A self find_prompt delay_factor delay_factor N/A N/A N/A N/A prompt N/A -1 N/A pri_prompt_terminator alt_prompt_terminator N/A N/A N/A ValueError N/A N/A Router prompt not found: {0} format prompt N/A N/A self base_prompt N/A prompt N/A -1 N/A N/A self base_prompt N/A find_prompt N/A N/A self delay_factor N/A 0.1 N/A N/A Finds the current network device prompt, last line only. N/A delay_factor N/A N/A self select_delay_factor delay_factor N/A N/A N/A self clear_buffer N/A N/A N/A N/A self remote_conn sendall N/A N/A N/A time sleep delay_factor N/A prompt N/A N/A N/A N/A self remote_conn recv_ready N/A N/A prompt N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A prompt N/A N/A prompt strip N/A N/A self ansi_escape_codes N/A N/A prompt N/A N/A self strip_ansi_escape_codes prompt N/A count 0 N/A N/A N/A count 10 N/A prompt N/A N/A N/A N/A self wait_for_recv_ready N/A N/A prompt N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A self ansi_escape_codes N/A N/A prompt N/A N/A self strip_ansi_escape_codes prompt N/A prompt N/A N/A prompt strip N/A count 1 N/A prompt N/A N/A self normalize_linefeeds prompt N/A prompt N/A N/A N/A prompt split N/A -1 N/A prompt N/A N/A prompt strip N/A N/A prompt N/A N/A N/A ValueError N/A N/A Unable to find prompt: {} format prompt N/A N/A N/A time sleep delay_factor N/A N/A N/A self clear_buffer N/A prompt N/A clear_buffer N/A N/A self N/A N/A N/A Read any data available in the channel up to MAX_BUFFER N/A N/A N/A N/A self remote_conn recv_ready N/A N/A N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A None N/A send_command N/A N/A self command_string delay_factor max_loops strip_prompt strip_command N/A 0.1 150 True True N/A N/A 
        Execute command_string on the SSH channel.

        Use delay based mechanism to obtain output.  Strips echoed characters and router prompt.

        delay_factor can be used to increase the delays.

        max_loops can be used to increase the number of times it reads the data buffer

        Returns the output of the command.
         N/A debug False N/A debug N/A N/A N/A print In send_command N/A delay_factor N/A N/A self select_delay_factor delay_factor N/A output N/A N/A N/A self clear_buffer N/A command_string N/A N/A self normalize_cmd command_string N/A debug N/A N/A N/A print N/A N/A Command is: {0} format command_string N/A N/A N/A N/A self remote_conn sendall command_string N/A tmp_output N/A N/A self receive_data_generator delay_factor delay_factor max_loops max_loops N/A N/A output tmp_output N/A N/A self ansi_escape_codes N/A N/A output N/A N/A self strip_ansi_escape_codes output N/A output N/A N/A self normalize_linefeeds output N/A strip_command N/A N/A output N/A N/A self strip_command command_string output N/A strip_prompt N/A N/A output N/A N/A self strip_prompt output N/A debug N/A N/A N/A print output N/A output N/A strip_prompt N/A N/A self a_string N/A N/A N/A 
        Strip the trailing router prompt from the output
         N/A response_list N/A N/A a_string split N/A last_line N/A response_list N/A -1 N/A N/A N/A self base_prompt last_line N/A N/A N/A N/A join N/A response_list N/A -1 N/A N/A a_string N/A read_until_prompt N/A N/A self N/A N/A N/A Read channel until self.base_prompt detected. Return ALL data available. N/A N/A N/A self read_until_pattern N/A read_until_pattern N/A N/A self pattern re_flags N/A 0 N/A N/A Read channel until pattern detected. Return ALL data available. N/A output N/A N/A pattern N/A N/A pattern N/A self base_prompt N/A pattern N/A N/A re escape pattern N/A True N/A N/A N/A N/A output N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A N/A re search pattern output flags re_flags N/A N/A output N/A N/A N/A N/A socket timeout N/A N/A N/A NetMikoTimeoutException Timed-out reading channel, data not available. N/A read_until_prompt_or_pattern N/A N/A self pattern re_flags N/A 0 N/A N/A Read until either self.base_prompt or pattern is detected. Return ALL data available. N/A output N/A N/A pattern N/A N/A pattern N/A self base_prompt N/A pattern N/A N/A re escape pattern N/A base_prompt_pattern N/A N/A re escape N/A self base_prompt N/A True N/A N/A N/A N/A output N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A N/A N/A re search pattern output flags re_flags N/A N/A re search base_prompt_pattern output flags re_flags N/A N/A output N/A N/A N/A N/A socket timeout N/A N/A N/A NetMikoTimeoutException Timed-out reading channel, data not available. N/A send_command_expect N/A N/A self command_string expect_string delay_factor max_loops auto_find_prompt strip_prompt strip_command N/A None 0.2 500 True True True N/A N/A 
        Send command to network device retrieve output until router_prompt or expect_string

        By default this method will keep waiting to receive data until the network device prompt is
        detected. The current network device prompt will be determined automatically.

        command_string = command to execute
        expect_string = pattern to search for uses re.search (use raw strings)
        delay_factor = decrease the initial delay before we start looking for data
        max_loops = number of iterations before we give up and raise an exception
        strip_prompt = strip the trailing prompt from the output
        strip_command = strip the leading command from the output

        self.global_delay_factor is not used (to make this method faster)
         N/A debug False N/A N/A expect_string None N/A N/A auto_find_prompt N/A N/A N/A N/A prompt N/A N/A self find_prompt delay_factor delay_factor N/A N/A N/A ValueError N/A N/A prompt N/A self base_prompt N/A N/A prompt N/A self base_prompt N/A search_pattern N/A N/A re escape N/A N/A prompt strip N/A N/A search_pattern expect_string N/A command_string N/A N/A self normalize_cmd command_string N/A debug N/A N/A N/A print N/A N/A Command is: {0} format command_string N/A N/A print N/A N/A Search to stop receiving data is: '{0}' format search_pattern N/A N/A N/A time sleep N/A delay_factor 1 N/A N/A N/A self clear_buffer N/A N/A N/A N/A self remote_conn sendall command_string N/A i 1 N/A output N/A N/A i max_loops N/A N/A N/A N/A N/A self remote_conn recv_ready N/A N/A output N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A N/A lines N/A N/A output split N/A first_line N/A lines N/A 0 N/A N/A BACKSPACE_CHAR first_line N/A N/A pattern N/A search_pattern .*$ N/A first_line N/A N/A re sub pattern repl string first_line N/A N/A lines N/A 0 first_line N/A output N/A N/A join lines N/A N/A N/A IndexError N/A N/A N/A N/A N/A re search search_pattern output N/A N/A N/A N/A N/A N/A time sleep N/A delay_factor 1 N/A i 1 N/A N/A N/A IOError N/A N/A Search pattern never detected in send_command_expect: {0} format search_pattern N/A N/A self ansi_escape_codes N/A N/A output N/A N/A self strip_ansi_escape_codes output N/A output N/A N/A self normalize_linefeeds output N/A strip_command N/A N/A output N/A N/A self strip_command command_string output N/A strip_prompt N/A N/A output N/A N/A self strip_prompt output N/A output N/A strip_backspaces N/A N/A output N/A N/A N/A Strip any backspace characters out of the output. N/A backspace_char N/A N/A N/A output replace backspace_char N/A staticmethod strip_command N/A N/A command_string output N/A N/A N/A 
        Strip command_string from output string

        Cisco IOS adds backspaces into output for long commands (i.e. for commands that line wrap)
         N/A backspace_char N/A N/A backspace_char output N/A N/A output N/A N/A output replace backspace_char N/A output_lines N/A N/A output split N/A new_output N/A output_lines N/A 1 N/A N/A N/A join new_output N/A N/A command_length N/A len command_string N/A N/A output N/A command_length N/A staticmethod normalize_linefeeds N/A N/A a_string N/A N/A N/A Convert '

','
', '

' to '
. N/A newline N/A N/A re compile (\r\r\n|\r\n|\n\r) N/A N/A N/A newline sub a_string N/A staticmethod normalize_cmd N/A N/A command N/A N/A N/A Normalize CLI commands to have a single trailing newline. N/A command N/A N/A command rstrip N/A command N/A command N/A staticmethod check_enable_mode N/A N/A self check_string N/A N/A N/A Check if in enable mode. Return boolean. N/A N/A N/A N/A self remote_conn sendall N/A output N/A N/A self read_until_prompt N/A N/A check_string output N/A enable N/A N/A self cmd pattern re_flags N/A password N/A re IGNORECASE N/A N/A Enter enable mode. N/A output N/A N/A N/A N/A self check_enable_mode N/A N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd cmd N/A output N/A N/A self read_until_prompt_or_pattern pattern pattern re_flags re_flags N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd N/A self secret N/A output N/A N/A self read_until_prompt N/A N/A N/A N/A self check_enable_mode N/A N/A N/A ValueError Failed to enter enable mode. N/A output N/A exit_enable_mode N/A N/A self exit_command N/A N/A N/A Exit enable mode. N/A output N/A N/A N/A self check_enable_mode N/A N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd exit_command N/A output N/A N/A self read_until_prompt N/A N/A N/A self check_enable_mode N/A N/A N/A ValueError Failed to exit enable mode. N/A output N/A check_config_mode N/A N/A self check_string N/A N/A N/A Checks if the device is in configuration mode or not. N/A N/A N/A N/A self remote_conn sendall N/A output N/A N/A self read_until_prompt N/A N/A check_string output N/A config_mode N/A N/A self config_command N/A N/A N/A Enter into config_mode. N/A output N/A N/A N/A N/A self check_config_mode N/A N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd config_command N/A output N/A N/A self read_until_prompt N/A N/A N/A N/A self check_config_mode N/A N/A N/A ValueError Failed to enter configuration mode. N/A output N/A exit_config_mode N/A N/A self exit_config N/A N/A N/A Exit from configuration mode. N/A output N/A N/A N/A self check_config_mode N/A N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd exit_config N/A output N/A N/A self read_until_prompt N/A N/A N/A self check_config_mode N/A N/A N/A ValueError Failed to exit configuration mode N/A output N/A receive_data_generator N/A N/A self delay_factor max_loops N/A 0.1 150 N/A N/A Generator to collect all data available in channel. N/A i 0 N/A N/A i max_loops N/A N/A N/A N/A time sleep delay_factor N/A N/A N/A N/A self remote_conn recv_ready N/A N/A N/A N/A N/A N/A N/A N/A self remote_conn recv MAX_BUFFER decode utf-8 ignore N/A N/A N/A N/A time sleep N/A delay_factor 8 N/A N/A N/A N/A N/A self remote_conn recv_ready N/A N/A N/A i 1 N/A send_config_from_file N/A N/A self config_file N/A None kwargs N/A N/A 
        Send configuration commands down the SSH channel from a file.

        The file is processed line-by-line and each command is sent down the
        SSH channel.

        **kwargs are passed to send_config_set method.
         N/A N/A N/A io open config_file encoding utf-8 cfg_file N/A N/A N/A N/A self send_config_set cfg_file kwargs N/A send_config_set N/A N/A self config_commands exit_config_mode delay_factor max_loops strip_prompt strip_command N/A None True 0.1 150 False False N/A N/A 
        Send configuration commands down the SSH channel.

        config_commands is an iterable containing all of the configuration commands.
        The commands will be executed one after the other.

        Automatically exits/enters configuration mode.
         N/A debug False N/A N/A config_commands None N/A N/A N/A N/A N/A hasattr config_commands __iter__ N/A N/A N/A ValueError Invalid argument passed into send_config_set N/A output N/A N/A self config_mode N/A cmd config_commands N/A N/A N/A N/A N/A self remote_conn sendall N/A N/A self normalize_cmd cmd N/A N/A N/A time sleep N/A delay_factor 2.0 N/A tmp_output N/A N/A self receive_data_generator delay_factor delay_factor max_loops max_loops N/A N/A output tmp_output N/A exit_config_mode N/A N/A output N/A N/A self exit_config_mode N/A debug N/A N/A N/A print output N/A output N/A strip_ansi_escape_codes N/A N/A string_buffer N/A N/A N/A 
        Remove any ANSI (VT100) ESC codes from the output

        http://en.wikipedia.org/wiki/ANSI_escape_code

        Note: this does not capture ALL possible ANSI Escape Codes only the ones
        I have encountered

        Current codes that are filtered:
        ESC = '' or chr(27)
        ESC = is the escape character [^ in hex ('')
        ESC[24;27H   Position cursor
        ESC[?25h     Show the cursor
        ESC[E        Next line (HP does ESC-E)
        ESC[2K       Erase line
        ESC[1;24r    Enable scrolling from start to row end

        HP ProCurve's and F5 LTM's require this (possible others)
         N/A debug False N/A debug N/A N/A N/A print In strip_ansi_escape_codes N/A N/A print N/A repr = %s N/A repr string_buffer N/A code_position_cursor N/A N/A chr 27 \[\d+;\d+H N/A code_show_cursor N/A N/A chr 27 \[\?25h N/A code_next_line N/A N/A chr 27 E N/A code_erase_line N/A N/A chr 27 \[2K N/A code_enable_scroll N/A N/A chr 27 \[\d+;\d+r N/A code_set N/A code_position_cursor code_show_cursor code_erase_line code_enable_scroll N/A output string_buffer N/A ansi_esc_code code_set N/A N/A output N/A N/A re sub ansi_esc_code output N/A output N/A N/A re sub code_next_line output N/A debug N/A N/A N/A print N/A new_output = %s output N/A N/A print N/A repr = %s N/A repr output N/A output N/A staticmethod cleanup N/A N/A self N/A N/A N/A 
        Any needed cleanup before closing connection
         N/A N/A disconnect N/A N/A self N/A N/A N/A 
        Gracefully close the SSH connection
         N/A N/A N/A self cleanup N/A N/A N/A N/A self remote_conn_pre close N/A commit N/A N/A self N/A N/A N/A 
        Commit method for platforms that support this
         N/A N/A AttributeError Network device does not support 'commit()' method N/A N/A