Файловый менеджер - Редактировать - /opt/imh-python/lib/python3.9/site-packages/netmiko/__pycache__/base_connection.cpython-39.pyc
Ðазад
a v�h�> � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z ddl m Z ddl Z ddl Z ddlmZmZmZ ddlmZ ddlmZmZ dd lmZmZmZ dd lm Z m Z m Z m Z m Z m!Z!m"Z" dd lm#Z# G d d � d e$�Z%G dd� de%�Z&dS )z� 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 � N)�deque)�path)�Lock)�retry�stop_after_attempt�wait_exponential)�log)� MAX_BUFFER�BACKSPACE_CHAR)�NetmikoTimeoutException� NetmikoAuthenticationException�ConfigInvalidException)� write_bytes�check_serial_port�get_structured_data�get_structured_data_genie�get_structured_data_ttp�run_ttp_template�select_cmd_verify)� m_exec_timec ' @ sp e Zd ZdZd�dd�Zdd� Zdd� Zdd� Zdd� Zd�dd�Z d�d d �Z d d � Z d d!� Z d"d#� Z d$d%� Zd&d'� Zd(d)� Zd*d+� Zd�d-d.�Zd�d/d0�Zd1d2� Zd3d4� Zd�d5d6�Zd�d;d<�Zd�d>d?�Zd@dA� ZdBdC� ZdDdE� ZdFdG� Z d�dHdI�Z d�dLdM�Z d�dOdP�Z dQdR� Z dSdT� Z!d�dUdV�Z"d�dXdY�Z#d�dZd[�Z$e%e&d\d dd]�e'd�d d^�d�dadb��Z(d�dcdd�Z)d�dedf�Z*e+d�dgdh��Z,didj� Z-dkdl� Z.e+d�dndo��Z/dpdq� Z0e1drds� �Z2dtdu� Z3dvdw� Z4dxdy� Z5d�dzd{�Z6dd|de7j8fd}d~�Z9d�dd��Z:d�d�d��Z;d�d�d��Z<d�d�d��Z=d�d�d��Z>d�d�d��Z?d�d�� Z@d�d�d��ZAd�d�� ZBd�d�� ZCd�d�� ZDd�d�� ZEd�d�d��ZFd�d�� ZGi fd�d��ZHdS )��BaseConnectionzZ Defines vendor independent methods. Otherwise method left as a stub method. � NF� � � � �d �< r T�write�asciic( ) C s� d| _ d| _d| _| du r4d|vr*d| _q:| j| _n| | _| du rFdn| | _|r\|�� | _n|rj|�� | _|s�|s�d|vr�td��|du r�d|v r�d}nd }t|�| _ || _ || _ || _ || _ d | _|| _|| _|| _|| _|| _|| _|| _|| _|$| _|%| _|&| _d| _|"| _d | _ d | _ |!du�rbt |!t ��rD| j |!|#d � n t |!t!j"��rZ|!| _ntd ��d dt#j$t#j%t#j&d�| _'| du �r�i } | j'�(| � d|v �r�d| _| j'�)d�}(t*|(�}(| j'�(d|(i� | | _+| | _,| | _-| | _.| j+�r�| j-dk�r�d| _-d| _/t0� | _1d|v �r&d| _2|�p d| _ n�d|v �rDd| _2|�p>d| _ nnd| _2|�s\t3�4� | _5n t3�6� | _5| | _7| �r�t8�9t8�:| ��nd| _;| | _<|| _=|| _>|| _?|| _@|| _A|| _B|'�r�| �C� dS )a� Initialize attributes for establishing connection to target device. :param ip: IP address of target device. Not required if `host` is provided. :type ip: str :param host: Hostname of target device. Not required if `ip` is provided. :type host: str :param username: Username to authenticate against target device if required. :type username: str :param password: Password to authenticate against target device if required. :type password: str :param secret: The enable password if target device requires one. :type secret: str :param port: The destination port used to connect to the target device. :type port: int or None :param device_type: Class selection based on device type. :type device_type: str :param verbose: Enable additional messages to standard output. :type verbose: bool :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1). :type global_delay_factor: int :param use_keys: Connect to target device using SSH keys. :type use_keys: bool :param key_file: Filename path of the SSH key file to use. :type key_file: str :param pkey: SSH key object to use. :type pkey: paramiko.PKey :param passphrase: Passphrase to use for encrypted key; password will be used for key decryption if not specified. :type passphrase: str :param allow_agent: Enable use of SSH key-agent. :type allow_agent: bool :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which means unknown SSH host keys will be accepted). :type ssh_strict: bool :param system_host_keys: Load host keys from the users known_hosts file. :type system_host_keys: bool :param alt_host_keys: If `True` host keys will be loaded from the file specified in alt_key_file. :type alt_host_keys: bool :param alt_key_file: SSH host key file to use (if alt_host_keys=True). :type alt_key_file: str :param ssh_config_file: File name of OpenSSH configuration file. :type ssh_config_file: str :param timeout: Connection timeout. :type timeout: float :param session_timeout: Set a timeout for parallel requests. :type session_timeout: float :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response. :type auth_timeout: float :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko). :type banner_timeout: float :param keepalive: Send SSH keepalive packets at a specific interval, in seconds. Currently defaults to 0, for backwards compatibility (it will not attempt to keep the connection alive). :type keepalive: int :param default_enter: Character(s) to send to correspond to enter key (default: ). :type default_enter: str :param response_return: Character(s) to use in normalized return data to represent enter key (default: ) :type response_return: str :param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor to select smallest of global and specific. Sets default global_delay_factor to .1 (default: False) :type fast_cli: boolean :param session_log: File path or BufferedIOBase subclass object to write the session log to. :type session_log: str :param session_log_record_writes: The session log generally only records channel reads due to eliminate command duplication due to command echo. You can enable this if you want to record both channel reads and channel writes in the log (default: False). :type session_log_record_writes: boolean :param session_log_file_mode: "write" or "append" for session_log file mode (default: "write") :type session_log_file_mode: str :param allow_auto_change: Allow automatic configuration changes for terminal settings. (default: False) :type allow_auto_change: bool :param encoding: Encoding to be used when writing bytes to the output channel. (default: ascii) :type encoding: str :param sock: An open socket or socket-like object (such as a `.Channel`) to use for communication to the target host (default: None). :type sock: socket :param global_cmd_verify: Control whether command echo verification is enabled or disabled (default: None). Global attribute takes precedence over function `cmd_verify` argument. Value of `None` indicates to use function `cmd_verify` argument. :type global_cmd_verify: bool|None :param auto_connect: Control whether Netmiko automatically establishes the connection as part of the object creation (default: True). :type auto_connect: bool NTz �telnet� �serialz Either ip or host must be set� � F)�filename�modezRsession_log must be a path to a file, a file handle, or a BufferedIOBase subclass.ZCOM1i�% )�portZbaudrateZbytesizeZparityZstopbitsr' r 皙�����?r Z_telnetZ_serial�ssh)D� remote_connZ _config_mode� TELNET_RETURN�RETURN�RESPONSE_RETURN�strip�host� ValueError�intr' �username�password�secret� device_type�ansi_escape_codes�verbose� auth_timeout�banner_timeout�blocking_timeout� conn_timeout�session_timeout�timeout� keepalive�allow_auto_change�encoding�sock� session_log�session_log_record_writes�_session_log_close�_session_log_fin� isinstance�str�open_session_log�io�BufferedIOBaser" Z EIGHTBITSZ PARITY_NONEZ STOPBITS_ONE�serial_settings�update�popr �fast_cli� _legacy_mode�global_delay_factor�global_cmd_verify� base_promptr �_session_locker�protocol�paramikoZ AutoAddPolicy� key_policyZ RejectPolicy�use_keysr �abspath� expanduser�key_file�pkey� passphrase� allow_agent�system_host_keys� alt_host_keys� alt_key_file�ssh_config_file�_open))�self�ipr/ r2 r3 r4 r' r5 r7 rP rQ rW rZ r[ r\ r] Z ssh_strictr^ r_ r` ra r; r8 r9 r: r= r< r> Z default_enterZresponse_returnrK rN rO rB rC Zsession_log_file_moder? r@ rA Z auto_connectZ comm_port� re ��/root/rpmbuild/BUILDROOT/imh-python39-modules-3.9.7-92.el8.x86_64/opt/imh-python/lib/python3.9/site-packages/netmiko/base_connection.py�__init__0 s� 1 �� �zBaseConnection.__init__c C s | � � | �� | �� dS )z7Decouple connection creation from __init__ for mocking.N)�_modify_connection_params�establish_connection�_try_session_preparation�rc re re rf rb ` s zBaseConnection._openc C s | S )z,Establish a session using a Context Manager.re rk re re rf � __enter__f s zBaseConnection.__enter__c C s | � � dS )z4Gracefully close connection on Context Manager exit.N)� disconnect)rc �exc_type� exc_value� tracebackre re rf �__exit__j s zBaseConnection.__exit__c C s dS )z5Modify connection parameters prior to SSH connection.Nre rk re re rf rh n s z(BaseConnection._modify_connection_params�Timeout exceeded!c C s& |sdS t � � | | jkr"t|��dS )aD Raise NetmikoTimeoutException if waiting too much in the serving queue. :param start: Initial start time to see if session lock timeout has been exceeded :type start: float (from time.time() call i.e. epoch time) :param msg: Exception message if timeout was exceeded :type msg: str F)�timer< r )rc �start�msgre re rf �_timeout_exceededr s z BaseConnection._timeout_exceededc C s4 |s t � � }| j�d�s0| �|d�s0t �d� q dS )a Try to acquire the Netmiko session lock. If not available, wait in the queue until the channel is available again. :param start: Initial start time to measure the session timeout :type start: float (from time.time() call i.e. epoch time) Fz%The netmiko channel is not available!r( T)rs rS �acquirerv �sleep)rc rt re re rf �_lock_netmiko_session� s � z$BaseConnection._lock_netmiko_sessionc C s | j �� r| j �� dS )z= Release the channel at the end of the task. N)rS �locked�releaserk re re rf �_unlock_netmiko_session� s z&BaseConnection._unlock_netmiko_sessionc C s� | j dkr"| j�t|| jd�� nV| j dkrD| j�t|| jd�� n4| j dkrp| j�t|| jd�� | j�� ntd��z4t� d� t|| jd��� | j s�| j r�| � |� W n ty� Y n0 dS )��Generic handler that will write to both SSH and telnet channel. :param out_data: data to be written to the channel :type out_data: str (can be either unicode/byte string) r) �r@ r r" zInvalid protocol specifiedzwrite_channel: {}N)rT r* �sendallr r@ r �flushr0 r �debug�formatrE rC �_write_session_log�UnicodeDecodeError�rc Zout_datare re rf �_write_channel� s$ �� z BaseConnection._write_channelc C s� | j d ur�t|�dkr�| jr*|�| jd�}| jr>|�| jd�}t| j tj�rn| �|�}| j � t || j d�� n| j � | �|�� | j � � d S )Nr z********r~ ) rB �lenr3 �replacer4 rF rI rJ �normalize_linefeedsr r r@ r� )rc �datare re rf r� � s z!BaseConnection._write_session_logc C s. | � � z| �|� W | �� n | �� 0 dS )r} N)ry r� r| r� re re rf � write_channel� s z BaseConnection.write_channelc C s� t d�}| jdu r t�d� dS | jdkr�zRt�d� | jj�tj tj � | jj�tj tj � | jj�tj tj � W dS t y� Y dS 0 nLz"t�d� | � |� | jj �� W S tjtfy� tjd dd � Y dS 0 dS ) z8Returns a boolean flag with the state of the connection.r Nz5Connection is not initialised, is_alive returns FalseFr zSending IAC + NOPTzSending the NULL bytezUnable to send)�exc_info)�chrr* r �errorrT r� rA r � telnetlibZIAC�NOP�AttributeErrorr� � transportZ is_active�socket�EOFError)rc �nullre re rf �is_alive� s* zBaseConnection.is_alivec C s� | j dkrPd}| j�� rN| j�t�}t|�dkr8td��||�dd�7 }qq�qnV| j dkrn| j�� �dd�}n8| j dkr�d}| jj dkr�|| j� | jj ��dd�7 }q|| j r�| � |�}t �d |� �� | �|� |S ) �JGeneric handler that will read all the data from an SSH or telnet channel.r) r r �'Channel stream closed by remote device.�utf-8�ignorer r" zread_channel: )rT r* Z recv_ready�recvr r� r� �decodeZread_very_eagerZ in_waiting�readr6 �strip_ansi_escape_codesr r� r� )rc �outputZoutbufre re rf � _read_channel� s* � z BaseConnection._read_channelc C s0 d}| � � z| �� }W | �� n | �� 0 |S )r� r )ry r� r| )rc r� re re rf � read_channel s zBaseConnection.read_channel� c C sh d}|st �| j�}t�d|� �� d}d}|dkrBt| j| �}||k �rV| jdkr�z�zj| �� | j � t �}t |�dkr�t d��|�d d �}| jr�| �|�}t�d |� �� ||7 }| �|� W n tjy� td ��Y n0 W | �� n | �� 0 n| jd k�s|| �� 7 }t j|||d��r<t�d|� d|� �� |S t�|| j � |d7 }qBtd|� ���dS )a� Function that reads channel until pattern is detected. pattern takes a regular expression. By default pattern will be self.base_prompt Note: this currently reads beyond pattern. In the case of SSH it reads MAX_BUFFER. In the case of telnet it reads all non-blocking data. There are dependencies here like determining whether in config_mode that are actually depending on reading beyond pattern. :param pattern: Regular expression pattern used to identify the command is done (defaults to self.base_prompt) :type pattern: str (regular expression) :param re_flags: regex flags used in conjunction with pattern to search for prompt (defaults to no flags) :type re_flags: int :param max_loops: max number of iterations to read the channel before raising exception. Will default to be based upon self.timeout. :type max_loops: int r z Pattern is: r r( r� r) r r� r� r� z _read_channel_expect read_data: z.Timed-out reading channel, data not available.r r" ��flagszPattern found: � z8Timed-out reading channel, pattern not found in output: N)�re�escaperR r r� r1 r= rT ry r* r� r r� r� r� r6 r� r� r� r r| r� �searchrs rx rP )rc �pattern�re_flags� max_loopsr� �i� loop_delay�new_datare re rf �_read_channel_expect sH � �z#BaseConnection._read_channel_expectc C s� d}d}| � |�}|dkr0|dkr0t| j| �}|dk rH| jsH| jrHd}d}d}||kr�t�|| � | �� }|r|||7 }n&t�|| � | �� }|s�q�n||7 }|d7 }qP|S )a� Read data on the channel based on timing delays. Attempt to read channel max_loops number of times. If no data this will cause a 15 second delay. Once data is encountered read channel for another two seconds (2 * delay_factor) to make sure reading of channel is complete. :param delay_factor: multiplicative factor to adjust delay when reading channel (delays get multiplied by this factor) :type delay_factor: int or float :param max_loops: maximum number of loops to iterate through before returning channel data. Will default to be based upon self.timeout. :type max_loops: int r( � r r� r r )�select_delay_factorr1 r= rO rN rs rx r� )rc � delay_factorr� r� Z final_delayZ channel_datar� r� re re rf �_read_channel_timingW s, z#BaseConnection._read_channel_timingc O s | j |i |��S )zHRead channel until self.base_prompt detected. Return ALL data available.�r� �rc �args�kwargsre re rf �read_until_prompt� s z BaseConnection.read_until_promptc O s | j |i |��S )z?Read channel until pattern detected. Return ALL data available.r� r� re re rf �read_until_pattern� s z!BaseConnection.read_until_patternc C s* t �| j�}|r d�||�}| j||d�S )a" Read until either self.base_prompt or pattern is detected. :param pattern: the pattern used to identify that the output is complete (i.e. stop reading when pattern is detected). pattern will be combined with self.base_prompt to terminate output reading when the first of self.base_prompt or pattern is detected. :type pattern: regular expression string :param re_flags: regex flags used in conjunction with pattern to search for prompt (defaults to no flags) :type re_flags: int z({}|{}))r� )r� r� rR r� r� )rc r� r� Zcombined_patternre re rf � read_until_prompt_or_pattern� s z+BaseConnection.read_until_prompt_or_pattern�#\s*$�>\s*$�(?:[Uu]ser:|sername|ogin)�asswordc C s | � ||||||� d S )N)� telnet_login)rc �pri_prompt_terminator�alt_prompt_terminator�username_pattern� pwd_patternr� r� re re rf � serial_login� s �zBaseConnection.serial_login�"(?:user:|username|login|user name)c C s | � |�}|dk r"| js"| jr"d}t�d| � d}d}d} | |k�r��z| �� }||7 }tj||tjd�r�| � | j d � t�d| � | �� }||7 }tj||tjd��r | � | j d � t�d| � | �� }||7 }tj||tj d��stj||tj d��r |W S tj||tj d��s2tj||tj d��r8|W S | � | j � t�d| � | d7 } W q< t�y� | j�� d| j� �} t| ��Y q<0 q<| � | j � t�d| � | �� }||7 }tj||tj d��s�tj||tj d��r�|S d| j� �} | j�� t| ��dS )a� Telnet login. Can be username/password or just password. :param pri_prompt_terminator: Primary trailing delimiter for identifying a device prompt :type pri_prompt_terminator: str :param alt_prompt_terminator: Alternate trailing delimiter for identifying a device prompt :type alt_prompt_terminator: str :param username_pattern: Pattern used to identify the username prompt :type username_pattern: str :param delay_factor: See __init__: global_delay_factor :type delay_factor: int :param max_loops: Controls the wait time in conjunction with the delay_factor (default: 20) r r r� � g �?zLogin failed: N)r� rO rN rs rx r� r� r� �Ir� r2 r3 �Mr+ r� r* �closer/ r ) rc r� r� r� r� r� r� r� Z return_msgr� ru re re rf r� � sd ��� � zBaseConnection.telnet_loginc C s. z | � � W n ty( | �� � Y n0 dS )a5 In case of an exception happening during `session_preparation()` Netmiko should gracefully clean-up after itself. This might be challenging for library users to do since they do not have a reference to the object. This is possibly related to threads used in Paramiko. N)�session_preparation� Exceptionrm rk re re rf rj s z'BaseConnection._try_session_preparationc C s< | � � | �� | �� | �� t�d| j � | �� dS )a� Prepare the session after the connection has been established This method handles some differences that occur between various devices early on in the session. In general, it should include: self._test_channel_read() self.set_base_prompt() self.disable_paging() self.set_terminal_width() self.clear_buffer() g333333�?N)�_test_channel_read�set_base_prompt�set_terminal_width�disable_pagingrs rx rP � clear_bufferrk re re rf r� s z"BaseConnection.session_preparationc C sj |� � }t�t�| j��}t�|�rtt�� }tj |ddd��&}|� |� |� | j �}W d � qx1 sh0 Y ni }d|v r�t� |d �}nrd|v r�tt|d �d���}t|�dkr�td ��|�d | j�} |�d | j �} d �|| | |d �} t� | �}nd}|d dk�r&t|�d | j��|d < |d dk�rF|�d| j�|d< |�rT||d< |�d | j �|d < |S )z�Update SSH connection parameters based on contents of SSH config file. :param dict_arg: Dictionary of SSH connection parameters :type dict_arg: dict �rtr� r~ NZ proxycommandZ proxyjump�,r z;ProxyJump with more than one proxy server is not supported.r' �hostnamezssh -F {} -W {}:{} {}r r$ r2 r �userrA )�copyr rX rY ra �existsrU Z SSHConfigrI �open�parse�lookupr/ Z ProxyCommand�list�reversed�splitr� r0 �getr' r� r1 r2 ) rc Zdict_argZ connect_dict� full_pathZssh_config_instance�f�source�proxyZhopsr' r/ �cmdre re rf �_use_ssh_config4 s: , � z BaseConnection._use_ssh_configc C sN | j | j| j| j| j| j| j| j| j| j | j | j | j d� }| j rJ| �|�}|S )z6Generate dictionary of Paramiko connection parameters.) r� r' r2 r3 Z look_for_keysr] Z key_filenamer[ r\ r= r8 r9 rA )r/ r' r2 r3 rW r] rZ r[ r\ r; r8 r9 rA ra r� )rc Z conn_dictre re rf �_connect_params_dictc s" � z#BaseConnection._connect_params_dictc C s: | � |�}|r(|r(| � |�}| �||�}|r6| �|�}|S )z�Strip out command echo, trailing router prompt and ANSI escape codes. :param output: Output from a remote network device :type output: unicode string :param strip_command: :type strip_command: )r� � strip_command� strip_prompt)rc r� r� �command_stringr� re re rf �_sanitize_outputz s z BaseConnection._sanitize_output� �� c C s: | j dkr.tj| j| j| jd�| _| �� �n| j dkrXtj f i | j ��| _| � � �n�| j dk�r6| � � }| � � | _z| jjf i |�� W �n4 tj�y } zb| �� d| j� d| j� d| j� d�}d t|�v r�d | j� d| j� �}|�� }t|��W Y d }~n�d }~0 tjj�yt } zL| �� d | j� d| j� d| j� d�}|| jt|� 7 }t|��W Y d }~nXd }~0 tjj �y� } z2| �� d t|�v �r�d}t|��n� W Y d }~n d }~0 0 | j �r�t d| j� d| j� �� | jj d||d�| _| j� | j!� | j"�r | jj#�$| j"� | �%� | j �r6t d� dS )a� Establish SSH connection to the network device Timeout will generate a NetmikoTimeoutException Authentication failure will generate a NetmikoAuthenticationException :param width: Specified width of the VT100 terminal window (default: 511) :type width: int :param height: Specified height of the VT100 terminal window (default: 1000) :type height: int r )r' r= r" r) z�TCP connection to device failed. Common causes of this problem are: 1. Incorrect hostname or IP address. 2. Wrong TCP port. 3. Intermediate firewall blocking access. Device settings: r� �:z zName or service not knownzBDNS failure--the hostname you provided was not resolvable in DNS: Nz�Authentication to device failed. Common causes of this problem are: 1. Invalid username and password 2. Incorrect SSH-key file 3. Connecting to the wrong device Device settings: zNo existing sessionz]Paramiko: 'No existing session' error: try increasing 'conn_timeout' to 10 seconds or larger.z SSH connection established to Zvt100)�term�width�heightz#Interactive SSH session establishedr )&rT r� ZTelnetr/ r' r= r* r� r" ZSerialrK r� r� �_build_ssh_client�remote_conn_pre�connectr� r� �paramiko_cleanupr5 rG �lstripr rU Z ssh_exceptionZAuthenticationExceptionr, r Z SSHExceptionr7 �printZ invoke_shell� settimeoutr: r> r� Z set_keepalive�special_login_handler)rc r� r� Zssh_connect_paramsZ conn_errorru Zauth_errZno_session_errre re rf ri � sz � ��� ��� ��� � �z#BaseConnection.establish_connection�( c C s� d dd�}d}| j dd�}|d }t�|d � d }||kr�|| �� 7 }|r`|r`t�||�rtq�n|rhq�n | �| j� ||�}t�|� |d 7 }q4|r�|S td ��d S )a, Try to read the channel (generally post login) verify you receive data back. :param count: the number of times to check the channel for data :type count: int :param pattern: Regular expression pattern used to determine end of channel read :type pattern: str 皙�����?� c S s | | } | |kr|} | S )z(Increment sleep time to a maximum value.re )� main_delay� increment�maximumre re rf �_increment_delay� s z;BaseConnection._test_channel_read.<locals>._increment_delayr �r� r( � r r zTimed out waiting for dataN)r� r� ) r� rs rx r� r� r� r� r, r )rc �countr� r� r� r� r� r� re re rf r� � s( z!BaseConnection._test_channel_readc C sD t �� }| jr|�� | jr4t�| j�r4|�| j� |� | j � |S )z$Prepare for Paramiko SSH connection.) rU Z SSHClientr^ Zload_system_host_keysr_ r �isfiler` Zload_host_keysZset_missing_host_key_policyrV )rc r� re re rf r� s z BaseConnection._build_ssh_clientc C s8 | j r |r|| jkr|S | jS n|| jkr.|S | jS dS )a Choose the greater of delay_factor or self.global_delay_factor (default). In fast_cli choose the lesser of delay_factor of self.global_delay_factor. :param delay_factor: See __init__: global_delay_factor :type delay_factor: int N)rN rP �rc r� re re rf r� " s z"BaseConnection.select_delay_factorc C s dS )zRHandler for devices like WLC, Extreme ERS that throw up characters prior to login.Nre r re re rf r� 5 s z$BaseConnection.special_login_handler�terminal length 0c C s� | � |�}| �|�}t�d� t�d|� �� | �|� |r^| jdur^| jt�|� � �d�}n|rp| j|d�}n| � � }t�|� � t�d� |S )z�Disable paging default to a Cisco CLI method. :param command: Device command to disable pagination of output :type command: str :param delay_factor: See __init__: global_delay_factor :type delay_factor: int zIn disable_pagingz Command: F�r� zExiting disable_paging) r� � normalize_cmdr r� r� rQ r� r� r� r. r� �rc �commandr� � cmd_verifyr� r� re re rf r� 9 s z BaseConnection.disable_pagingc C sj |sdS | � |�}| �|�}| �|� |rL| jdurL| jt�|�� �d�}n|r^| j|d�}n| �� }|S )a� CLI terminals try to automatically adjust the line based on the width of the terminal. This causes the output to get distorted when accessed programmatically. Set terminal width to 511 which works on a broad set of devices. :param command: Command string to send to the device :type command: str :param delay_factor: See __init__: global_delay_factor :type delay_factor: int r Fr ) r� r r� rQ r� r� r� r. r� r re re rf r� T s z!BaseConnection.set_terminal_widthg ��Q� �?)Z multiplier�min�max)�wait�stop�reraise�#�>c C sB | j |d�}|d ||fvr.tdt|�� ���|dd� | _| jS )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. :param pri_prompt_terminator: Primary trailing delimiter for identifying a device prompt :type pri_prompt_terminator: str :param alt_prompt_terminator: Alternate trailing delimiter for identifying a device prompt :type alt_prompt_terminator: str :param delay_factor: See __init__: global_delay_factor :type delay_factor: int r� ���zRouter prompt not found: N)� find_promptr0 �reprrR )rc r� r� r� �promptre re rf r� q s z BaseConnection.set_base_promptc C s� | � |�}| �� | �| j� |d }t�|� | �� �� }d}|dkr�|s�| �� �� }|s�| �| j� t�|� |dkr�|d9 }n|d7 }|d7 }q@| �|�}|� | j �d }|�� }|s�t d|� ���t�|d � | �� t � d |� �� |S ) z�Finds the current network device prompt, last line only. :param delay_factor: See __init__: global_delay_factor :type delay_factor: int r( r � � r� r r zUnable to find prompt: z[find_prompt()]: prompt is )r� r� r� r, rs rx r� r. r� r� r- r0 r r� )rc r� � sleep_timer r re re rf r � s2 zBaseConnection.find_promptc C s\ d| j }td�D ]D}t�|� | �� }|s0 qXt�d� |r|d9 }|dkrRdn|}qdS )z'Read any data available in the channel.r( r� z(Clear buffer detects data in the channelr� r N)rP �rangers rx r� r r� )rc �backoffr �_r� re re rf r� � s zBaseConnection.clear_bufferc C sj | dur | } d}| � |�}|r(| �|�}| �|� |�� }|r�| r�| jt�|�d�}| �|�}|�|�dkr�|� |�dd� }| j � |�}|� � }|� | j � |� �}n|}t �d|� �� || j||d�7 }| j||||d�}|�r t|| j|�� |d�}t|t��s |S | �r,t|| d �}t|t��s,|S | �rVt|| j|�� d �}t|t��sV|S t �d |� �� |S ) a} Execute command_string on the SSH channel using a delay-based mechanism. Generally used for show commands. :param command_string: The command to be executed on the remote device. :type command_string: str :param delay_factor: Multiplying factor used to adjust delays (default: 1). :type delay_factor: int or float :param max_loops: Controls wait time in conjunction with delay_factor. Will default to be based upon self.timeout. :type max_loops: int :param strip_prompt: Remove the trailing router prompt from the output (default: True). :type strip_prompt: bool :param strip_command: Remove the echo of the command from the output (default: True). :type strip_command: bool :param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool :param use_textfsm: Process command output through TextFSM template (default: False). :type use_textfsm: bool :param textfsm_template: Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default: None). :type textfsm_template: str :param use_ttp: Process command output through TTP template (default: False). :type use_ttp: bool :param ttp_template: Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default: None). :type ttp_template: str :param use_genie: Process command output through PyATS/Genie parser (default: False). :type use_genie: bool :param cmd_verify: Verify command echo before proceeding (default: False). :type cmd_verify: bool :param cmd_echo: Deprecated (use cmd_verify instead) :type cmd_echo: bool Nr r r z$send_command_timing current output: �r� r� �r� r� r� ��platformr �template�r �r r z"send_command_timing final output: )r� r r� r. r� r� r� r� r r� r- �joinr� r r� r� r� r r5 rF rG r r )rc r� r� r� r� r� � normalize� use_textfsm�textfsm_template�use_ttp� ttp_template� use_genier Zcmd_echor� r� r� �structured_outputre re rf �send_command_timing� s` @ ��� � z"BaseConnection.send_command_timingc C s: |� | j�}|d }| j|v r2| j�|dd� �S |S dS )z�Strip the trailing router prompt from the output. :param a_string: Returned string from device :type a_string: str r N)r� r- rR r! )rc �a_stringZ response_list� last_linere re rf r� K s zBaseConnection.strip_promptc C sr zR|� | j�}|d }t|v rJ|d }tj|d|d�}||d< | j�|�}|dfW S tyl |df Y S 0 dS )a� In certain situations the first line will get repainted which causes a false match on the terminating pattern. Filter this out. returns a tuple of (data, first_line_processed) Where data is the original data potentially with the first line modified and the first_line_processed is a flag indicating that we have handled the first line. r z.*$r )�repl�stringTFN)r� r, r r� �subr! � IndexError)rc r� �search_pattern�lines� first_liner� re re rf �_first_line_handlerX s z"BaseConnection._first_line_handler�� c C s` d}| � |�}|dkr,|dkr,t| j| �}|du rz|rdz| j|d�}W qj ty` | j}Y qj0 n| j}t�|�� �}n|}|r�| � |�}t � || � | � � | � |� d}|�� }|�r(|�r(| jt�|�d�}| �|�}|�|�dk�r(|�|�dd� }| j�|�}|�� }|� | j� |� �}d}d}tdd �}d }||k�r�|�r�||7 }|�|� |�s�| �||�\}}t�||��r��q�nt�|d�|���r��q�t � || � |d7 }| �� }�q>td �|���| j ||||d �}| �rt || j |�� | d �}t |t ��s|S | �r2t!|| d�}t |t ��s2|S | �r\t"|| j |�� d�}t |t ��s\|S |S )aw Execute command_string on the SSH channel using a pattern-based mechanism. Generally used for show commands. 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. :param command_string: The command to be executed on the remote device. :type command_string: str :param expect_string: Regular expression pattern to use for determining end of output. If left blank will default to being based on router prompt. :type expect_string: str :param delay_factor: Multiplying factor used to adjust delays (default: 1). :type delay_factor: int :param max_loops: Controls wait time in conjunction with delay_factor. Will default to be based upon self.timeout. :type max_loops: int :param strip_prompt: Remove the trailing router prompt from the output (default: True). :type strip_prompt: bool :param strip_command: Remove the echo of the command from the output (default: True). :type strip_command: bool :param normalize: Ensure the proper enter is sent at end of command (default: True). :type normalize: bool :param use_textfsm: Process command output through TextFSM template (default: False). :type normalize: bool :param textfsm_template: Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default: None). :param use_ttp: Process command output through TTP template (default: False). :type use_ttp: bool :param ttp_template: Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default: None). :type ttp_template: str :param use_genie: Process command output through PyATS/Genie parser (default: False). :type normalize: bool :param cmd_verify: Verify command echo before proceeding (default: True). :type cmd_verify: bool g�������?r r4 Nr� r r r )�maxlenFz1Search pattern never detected in send_command: {}r r r r )#r� r1 r= r r0 rR r� r� r. r rs rx r� r� r� r� r r� r- r! r� r �appendr3 r� r� �IOErrorr� r� r r5 rF rG r r )rc r� Z expect_stringr� r� Zauto_find_promptr� r� r" r# r$ r% r& r' r r� r r0 r� r� r� r� Zpast_three_readsZfirst_line_processedr( re re rf � send_commands s� C � ���� � zBaseConnection.send_commandc O s | j |i |��S )z�Support previous name of send_command method. :param args: Positional arguments to send to send_command() :type args: list :param kwargs: Keyword arguments to send to send_command() :type kwargs: dict )r8 r� re re rf �send_command_expect% s z"BaseConnection.send_command_expectc C s d}| � |d�S )z�Strip any backspace characters out of the output. :param output: Output obtained from a remote network device. :type output: str �r )r� )r� �backspace_charre re rf �strip_backspaces0 s z BaseConnection.strip_backspacesc C sV d}||v r|� |d�}|�� }|�|�rN|�| j�}|dd� }| j�|�S |S dS )a� Strip command_string from output string Cisco IOS adds backspaces into output for long commands (i.e. for commands that line wrap) :param command_string: The command string sent to the device :type command_string: str :param output: The returned output as a result of the command string sent to the device :type output: str r: r r N)r� r. � startswithr� r- r! )rc r� r� r; r� � output_lines� new_outputre re rf r� : s z BaseConnection.strip_commandc C s: t �d�}|�| j|�}| jdkr2t �d| j|�S |S dS )z�Convert ` `,` `, ` ` to ` .` :param a_string: A string that may have non-normalized line feeds i.e. output returned from device, or a device prompt :type a_string: str z( | | | )r! r� N)r� �compiler. r- )rc r* �newlinere re rf r� W s z"BaseConnection.normalize_linefeedsc C s |� � }|| j7 }|S )z�Normalize CLI commands to have a single trailing newline. :param command: Command that may require line feed to be normalized :type command: str )�rstripr, �rc r re re rf r f s z BaseConnection.normalize_cmdc C s | � | j� | �� }||v S )z�Check if in enable mode. Return boolean. :param check_string: Identification of privilege mode from device :type check_string: str )r� r, r� )rc � check_stringr� re re rf �check_enable_modep s z BaseConnection.check_enable_modeZsswordc C s� d}d}| � � s�| �| �|�� z�d}| jdur\|| jt�|�� �d�7 }|�|�� �d }||vr�| j |vr�|| j ||d�7 }t� ||�r�| �| �| j �� || � � 7 }|r�t� ||�s�|| j|d�7 }n| � � s�t|��W n ty� t|��Y n0 |S )a� Enter enable mode. :param cmd: Device command to enter enable mode :type cmd: str :param pattern: pattern to search for indicating device is waiting for password :type pattern: str :param enable_pattern: pattern indicating you have entered enable mode :type pattern: str :param re_flags: Regular expression flags used in conjunction with pattern :type re_flags: int r z\Failed to enter enable mode. Please ensure you pass the 'secret' argument to ConnectHandler.Fr r �r� r� )rE r� r rQ r� r� r� r. r� rR r� r� r4 r� r0 r )rc r� r� Zenable_patternr� r� ru �end_datare re rf �enablez s0 � � zBaseConnection.enablec C s< d}| � � r8| �| �|�� || �� 7 }| � � r8td��|S )z�Exit enable mode. :param exit_command: Command that exits the session from privileged mode :type exit_command: str r zFailed to exit enable mode.)rE r� r r� r0 )rc Z exit_commandr� re re rf �exit_enable_mode� s z BaseConnection.exit_enable_modec C s. | � | j� |s| �� }n | j|d�}||v S )a Checks if the device is in configuration mode or not. :param check_string: Identification of configuration mode from the device :type check_string: str :param pattern: Pattern to terminate reading of channel :type pattern: str r )r� r, r� r� )rc rD r� r� re re rf �check_config_mode� s z BaseConnection.check_config_modec C sv d}| � � sr| �| �|�� | jdur@|| jt�|�� �d�7 }tj|||d�sb|| j||d�7 }| � � srt d��|S )a? Enter into config_mode. :param config_command: Configuration command to send to the device :type config_command: str :param pattern: Pattern to terminate reading of channel :type pattern: str :param re_flags: Regular expression flags :type re_flags: RegexFlag r Fr r� rF z#Failed to enter configuration mode.) rJ r� r rQ r� r� r� r. r� r0 )rc Zconfig_commandr� r� r� re re rf � config_mode� s �zBaseConnection.config_modec C s� d}| � � rr| �| �|�� | jdur@|| jt�|�� �d�7 }tj||tj d�sb|| j|d�7 }| � � rrt d��t � d|� �� |S )z�Exit from configuration mode. :param exit_config: Command to exit configuration mode :type exit_config: str :param pattern: Pattern to terminate reading of channel :type pattern: str r Fr r� z!Failed to exit configuration modezexit_config_mode: ) rJ r� r rQ r� r� r� r. r� r� r0 r r� )rc Z exit_configr� r� re re rf �exit_config_mode� s �z BaseConnection.exit_config_modec K sF t j|ddd��"}| j|fi |��W d � S 1 s80 Y dS )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. :param config_file: Path to configuration file to be sent to the device :type config_file: str :param kwargs: params to be sent to send_config_set method :type kwargs: dict r� r� r~ N)rI r� �send_config_set)rc � config_filer� Zcfg_filere re rf �send_config_from_file s z$BaseConnection.send_config_from_filec C s� | � |�}|du rdS t|t�r&|f}t|d�s8td��d} | r^|rJ|fnt� } | | j| � 7 } | jr�| jr�| s�|D ]} | � | � | �� qr| | j ||d�7 } �n |�s |D ]\} | � | � | �� t � |d � | r�| | j ||d�7 } tj| | tjd�r�d| � �}t|��q�| �s�| | j ||d�7 } n�|D ]�} | � | � | �� | jt�| �� �d �}| |7 } d t�| j�� d �}t�||��s�| j|d �}| |7 } | �r$tj| | tjd��r$d| � �}t|���q$|�r�| | �� 7 } | �| �} t�| � � | S ) 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. :param config_commands: Multiple configuration commands to be sent to the device :type config_commands: list or string :param exit_config_mode: Determines whether or not to exit config mode after complete :type exit_config_mode: bool :param delay_factor: Factor to adjust delays :type delay_factor: int :param max_loops: Controls wait time in conjunction with delay_factor (default: 150) :type max_loops: int :param strip_prompt: Determines whether or not to strip the prompt :type strip_prompt: bool :param strip_command: Determines whether or not to strip the command :type strip_command: bool :param config_mode_command: The command to enter into config mode :type config_mode_command: str :param cmd_verify: Whether or not to verify command echo for each command in config_set :type cmd_verify: bool :param enter_config_mode: Do you enter config mode before sending config commands :type exit_config_mode: bool :param error_pattern: Regular expression pattern to detect config errors in the output. :type error_pattern: str Nr �__iter__z,Invalid argument passed into send_config_setr g�������?r� z#Invalid input detected at command: r z(?:z|#))r� rF rG �hasattrr0 �tuplerK rN rO r� r r� rs rx r� r� r� r r� r� r. rR rL r� r r� )rc Zconfig_commandsrL r� r� r� r� Zconfig_mode_commandr Zenter_config_modeZ error_patternr� Z cfg_mode_argsr� ru r? r� re re rf rM sb 4 � � � z BaseConnection.send_config_setc C s� t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d } t d�d } t d�d } t d�d } t d�d } t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }t d�d }|||||| | || | ||||||||||||g}|}|D ]}t�|d|�}�qLt�|| j|�}t�| |�} | �r�t| �d��} t�| | | j |�}|S )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[K Erase line from cursor to the end of line ESC[2K Erase entire line ESC[1;24r Enable scrolling from start to row end ESC[?6l Reset mode screen with options 640 x 200 monochrome (graphics) ESC[?7l Disable line wrapping ESC[2J Code erase display ESC[00;32m Color Green (30 to 37 are different colors) more general pattern is ESC[\d\d;\d\dm and ESC[\d\d;\d\d;\d\dm ESC[6n Get cursor position ESC[1D Move cursor position leftward by x characters (1 in this case) HP ProCurve and Cisco SG300 require this (possible others). :param string_buffer: The string to be processed to remove ANSI escape codes :type string_buffer: str � z \[\d+;\d+Hz\[\?25h�Ez\[Kz\[2Kz \[\d+;\d+rz\[(\d+)Lz\[1Mz\[\?7lz\[\?\d+lz\[00mz\[2Jz\[Jz \[\d\d;\d\dmz\[\d\d;\d\d;\d\dmz \[(3|4)\dmz\[(9|10)[0-7]mz\[6nz\[mz\[0mz\[7mz\[\d+Dr r )r� r� r. r, r� r1 �group) rc Z string_bufferZcode_position_cursorZcode_show_cursorZcode_next_lineZcode_erase_line_endZcode_erase_lineZcode_erase_start_lineZcode_enable_scrollZcode_insert_lineZcode_carriage_returnZcode_disable_line_wrappingZ code_reset_mode_screen_optionsZcode_reset_graphics_modeZcode_erase_displayZcode_erase_display_0Zcode_graphics_modeZcode_graphics_mode2Zcode_graphics_mode3Zcode_graphics_mode4Zcode_get_cursor_positionZcode_cursor_positionZcode_attrs_offZ code_reverseZcode_cursor_leftZcode_setr� Z ansi_esc_codeZinsert_line_matchr re re rf r� � sn � z&BaseConnection.strip_ansi_escape_codesc C s dS )zHLogout of the session on the network device plus any additional cleanup.Nre rC re re rf �cleanup� s zBaseConnection.cleanupc C s | j �� | ` dS )z@Cleanup Paramiko to try to gracefully handle SSH session ending.N)r� r� rk re re rf r� � s z BaseConnection.paramiko_cleanupc C s� zvzJ| � � | jdkr | �� n*| jdkr6| j�� n| jdkrJ| j�� W n ty^ Y n0 W d| _d| _| �� nd| _d| _| �� 0 dS )z$Try to gracefully close the session.r) r r" N)rV rT r� r* r� r� r� �close_session_logrk re re rf rm � s �zBaseConnection.disconnectc C s t d��dS )z.Commit method for platforms that support this.z1Network device does not support 'commit()' methodN)r� rk re re rf �commit s zBaseConnection.commitc O s t �dS )zNot ImplementedN)�NotImplementedErrorr� re re rf � save_config s zBaseConnection.save_configc C s8 |dkr t |d| jd�| _nt |d| jd�| _d| _dS )zOpen the session_log file.r6 �a)r& r@ �wTN)r� r@ rB rD )rc r% r& re re rf rH s z BaseConnection.open_session_logc C s$ | j dur | jr | j �� d| _ dS )z<Close the session_log file (if it is a file that we opened).N)rB rD r� rk re re rf rW s z BaseConnection.close_session_logc K s t f | ||d�|��S )a� Run TTP template parsing by using input parameters to collect devices output. :param template: template content, OS path to template or reference to template within TTP templates collection in ttp://path/to/template.txt format :type template: str :param res_kwargs: ``**res_kwargs`` arguments to pass to TTP result method :type res_kwargs: dict :param kwargs: any other ``**kwargs`` to use for TTP object instantiation :type kwargs: dict TTP template must have inputs defined together with below parameters. :param method: name of Netmiko connection object method to call, default ``send_command`` :type method: str :param kwargs: Netmiko connection object method arguments :type kwargs: dict :param commands: list of commands to collect :type commands: list Inputs' load could be of one of the supported formats and controlled by input's ``load`` attribute, supported values - python, yaml or json. For each input output collected from device and parsed accordingly. )� connectionr � res_kwargs)r )rc r r^ r� re re rf �run_ttp! s ��zBaseConnection.run_ttp)'r r r Nr Nr Fr NFNNNFFFFr Nr Nr r r r r NNNFTNFr Fr NT)rr )N)r r r� )r r� )r r )r� r� r� r� r r )r� r� r� r� r r )FNF)r� r� )r� r )r )r r TN)r r FN)r r r )r )T) r r� TTTFNFNFFN) Nr r4 TTTTFNFNFT)r )r )r r )r r r )r r )N) NTr r� FFNTTr )r )r )I�__name__� __module__� __qualname__�__doc__rg rb rl rq rh rv ry r| r� r� r� r� r� r� r� r� r� r� r� r� r� rj r� r� r� r� ri r� r� r� r� r� r� r r r r� r r� r r) r� r3 r8 r9 � staticmethodr< r� r� r rE r� � IGNORECASErH rI rJ rK rL rO rM r� rV r� rm rX rZ rH rW r_ re re re rf r ) sL � 2 C 2 � � [ / � \ * � � � � ( � � 2 � 6 � |a r c @ s e Zd ZdS )�TelnetConnectionN)r` ra rb re re re rf rf E s rf )'rc rI r� r� r� rs � collectionsr �osr � threadingr rU r" Ztenacityr r r Znetmikor Znetmiko.netmiko_globalsr r Znetmiko.ssh_exceptionr r r Znetmiko.utilitiesr r r r r r r r �objectr rf re re re rf �<module> sD $ ,
| ver. 1.1 | |
.
| PHP 8.3.30 | Ð“ÐµÐ½ÐµÑ€Ð°Ñ†Ð¸Ñ Ñтраницы: 0 |
proxy
|
phpinfo
|
ÐаÑтройка