File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/napalm.cpython-310.pyc
o
�N�g�\ � @ s8 d Z ddlZddlZddlZddlZddlmZ ddlZddl Zddl
Zz ddl Z dZ z e
e j�d�d �ZW n eyB dZY nw W n eyO dZ Y nw z
ddlmZ dZW n eye dZY nw e�e�Zdd � Zd
d � Zd d
� Zdd� Z dd� Z dd� Z d dd�Z d dd�Z dd� Z!dd� Z"d d d �Z#dS ) a�
Utils for the NAPALM modules and proxy.
.. seealso::
- :mod:`NAPALM grains: select network devices based on their characteristics <salt.grains.napalm>`
- :mod:`NET module: network basic features <salt.modules.napalm_network>`
- :mod:`NTP operational and configuration management module <salt.modules.napalm_ntp>`
- :mod:`BGP operational and configuration management module <salt.modules.napalm_bgp>`
- :mod:`Routes details <salt.modules.napalm_route>`
- :mod:`SNMP configuration module <salt.modules.napalm_snmp>`
- :mod:`Users configuration management <salt.modules.napalm_users>`
.. versionadded:: 2017.7.0
� N��wrapsT�.F)�ConnectionClosedExceptionc C s" t jj�� o| �di ��d�dkS )z!
Is this a NAPALM proxy?
�proxyZ proxytype�napalm)�salt�utils�platform�is_proxy�get��opts� r �E/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/napalm.pyr : s �r c C s | � di �� dd�S )z#
Is always alive required?
r � always_aliveT)r r
r r r �is_always_aliveD s r c C s t | �r t| � p t| �S )z,
Should this proxy be always alive?
)r r � is_minionr
r r r �not_always_aliveK s r c C s t jj�� o
d| v S )z+
Is this a NAPALM straight minion?
r )r r r
r r
r r r r R s r c C s6 t rtdkrt| �st| �r|S dd|� d|� d�fS )z"
Returns the __virtual__.
� F�"z" (zC) cannot be loaded: NAPALM is not installed: ``pip install napalm``)�
HAS_NAPALM� NAPALM_MAJORr r )r Z virtualname�filenamer r r �virtualY s
�r c
O sB d}d}| � di �}|�dd�}|� dd�}|rCt�d� t�d� t�|d � |d jd'i |�� t�d
� t�|d � t|�} �z=z4| � d d�sPtd ��i } | �|� | �� D ]
\}
} | du rh|�|
� q[t| � d
�|�|i |��}d}W n� t�yj } z�| � dd�}
t �
� }t | t �r�dj
|| � d�d�}n�|�r
t�r
t | t��r
d|d< dj
|
d�}t�|� t�|� t�d|
� t| ddd� t�d|
� t| ddd� t�d|
� t�d|� t| |g|�R i |��W Y d} ~ W |�r
t|��r | � d d��r | d
�� S S S S d j
| � dd�| � d i �� d ��r+d j
| � d i �� d �d!�nd"| � d#d"�|| d$�}t�|� t�|� i d||d%�W Y d} ~ W |�rct|��rd| � d d��re| d
�� S S S S d} ~ ww W |�r�t|��r�| � d d��r�| d
�� n|�r�t|��r�| � d d��r�| d
�� w w w w ||d"d&�S )(a�
Calls arbitrary methods from the network driver instance.
Please check the readthedocs_ page for the updated list of getters.
.. _readthedocs: http://napalm.readthedocs.org/en/latest/support/index.html#getters-support-matrix
method
Specifies the name of the method to be called.
*args
Arguments.
**kwargs
More arguments.
:return: A dictionary with three keys:
* result (True/False): if the operation succeeded
* out (object): returns the object as-is from the call
* comment (string): provides more details in case the call failed
* traceback (string): complete traceback in case of exception. Please submit an issue including this traceback on the `correct driver repo`_ and make sure to read the FAQ_
.. _`correct driver repo`: https://github.com/napalm-automation/napalm/issues/new
.. FAQ_: https://github.com/napalm-automation/napalm#faq
Example:
.. code-block:: python
salt.utils.napalm.call(
napalm_object,
'cli',
[
'show version',
'show chassis fan'
]
)
FN�__opts__�__retryT�force_reconnectz Forced reconnection initiatedz'The current opts (under the proxy key):r z Updated to:�UPz
not connected�DRIVER�HOSTNAME�[unspecified hostname]z;{method} is not implemented for the NAPALM {driver} driver!� DRIVER_NAME)�method�driverz0Disconnected from {device}. Trying to reconnect.)�devicez Clearing the connection with %s�close�r z!Re-opening the connection with %s�openz Connection re-opened with %szRe-executing %sZCLOSEzGCannot execute "{method}" on {device}{port} as {user}. Reason: {error}!�
OPTIONAL_ARGS�port�:{port}�r* � �USERNAME)r% r* �userr# �error)�out�result�comment� traceback)r1 r2 r3 r )r �pop�log�debug�update�
get_device� Exception�items�getattrr4 �
format_exc�
isinstance�NotImplementedError�format�HAS_CONN_CLOSED_EXC_CLASSr r0 �callr r& )�
napalm_devicer# �args�kwargsr2 r1 r Zretryr Z kwargs_copyZkargZwargr0 �hostnameZerr_tbr3 r r r rB g s� )
� �
����� �
$ )��
��
��
���� P � �� rB c C sZ i }t | �r | �di �n| �di �}| �d�s | �d�r$|�dd�| d< |s+t�d� |�d�p>|�d�p>|�d�p>|�d �|d
< |�d �pJ|�d �|d
< |�d�pV|�d�|d< |�d�pi|�d�pi|�d�pid|d< |�dd�|d< |�di �|d< |�dd �|d < |�d �|d < d|d < d!|d vr�d|d d!< |d r�d"|d vr�d#|d d"< |S )$zh
Returns the options of the napalm device.
:pram: opts
:return: the network device opts
r r �multiprocessingFzHIncorrect minion config. Please specify at least the napalm driver name!�hostrF �fqdn�ipr �usernamer/ r. r$ �osr" �passwd�password�passr- �PASSWORD�timeout�< �TIMEOUT�
optional_argsr) r TZ ALWAYS_ALIVEZprovider�PROVIDERr Z config_lockZ keepalive� )r r r6 r0 )r �salt_obj�network_deviceZ device_dictr r r �get_device_opts sH �
���
��� � rY c
C sh t �d� t| |d�}tj}|�d�r;z
t�|�d��}W n ty: } zt j d|�d�dd� W Y d}~nd}~ww |�
|�d��}z)||�d d
�|�d d
�|�d d
�|d
|d d�|d< |�d�� � d|d< W |S tjj j
y� } z8dj|�d d�|�di ��d�r�dj|�di ��d�d�nd
|�d d
�d�}t � |� t � d|� tjj �
|��d}~ww )z�
Initialise the connection with the network device through NAPALM.
:param: opts
:return: the network device object
z Setting up NAPALM connection�rW rU zUnable to import %sT)�exc_infoNr" r r- r. rP rS r) )rQ rT r r z1Cannot connect to {hostname}{port} as {username}.r! r* r+ r, )rF r* rK zPlease check error: %s)r6 r7 rY r �baser � importlib�
import_module� ImportErrorr0 Zget_network_driverr( �
exceptions�ConnectionExceptionr@ )r rW rX Z provider_libZierrZ_driver_r0 Z base_err_msgr r r r9 5 sN
���
�
�
��
�
��r9 c s t � �� fdd��}|S )ae
This decorator is used to make the execution module functions
available outside a proxy minion, or when running inside a proxy
minion. If we are running in a proxy, retrieve the connection details
from the __proxy__ injected variable. If we are not, then
use the connection information from the opts.
:param func:
:return:
c
s4 � j }|�d�}t�|�d��}|�di ��dd�}|�dd�}|rIt�d� t�d � t�|d � |d jd!i |�� t�d
� t�|d � t|�rb|rb|rYt|�|d < �n|d � |d < �nt|�r�|s�d
|vstd
|v r�|d
s�zt|�|d < W n� t j
j j y� } zt�
|� djt|j�d�W Y d }~S d }~ww |d
|d < n�t�d� |�d�}|d di �} |d di �}
t�d� t�| � tjjjd!i |��} | �| � t�d� t�| � | �d�p�| �d�p�| �d�p�| �d�} | �r&|
�r&t|
t��r&| |
v �r&|
| }
t�d| � t�|
� | �|
� t�d | � t�| � t�|�}| |d< d
|v�s>d
|v �rm|d
�smz
t||d �|d < W n* t j
j j �yl } zt�
|� djt|j�d�W Y d }~S d }~ww |d
|d < t|��r~||d d< � | i |��}|�r�t�d � |d }t|d dd �}|S )"NZ __proxy__r r r Tr Fz!Usage of reconnect force detectedzOpts before mergingzOpts after mergingrC znapalm.get_deviceZinherit_napalm_devicez {base_msg}. See log for details.)Zbase_msgz$Not running in a NAPALM Proxy MinionZ__salt__z
config.getr �napalm_inventoryz&NAPALM opts found in the Minion configz(Merging the found opts with the CLI argsrH rF rI rJ z!Found %s in the NAPALM inventory:zIMerging the config for %s with the details found in the napalm inventory:rZ z3That was a forced reconnect, gracefully clearing upr& r' r )� __globals__r �copy�deepcopyr6 r7 r8 r r9 r r\ r` ra r0 r@ �str�msgr r rD � clean_kwargsr> �dictr rB )rD rE Zwrapped_global_namespacer r r r ZnceZ _salt_objZ napalm_optsrb rh rH Zinventory_opts�retr% �closing��funcr r � func_wrapperp s�
�
���
�
������
�
��
��� �
z'proxy_napalm_wrap.<locals>.func_wrapperr )rm rn r rl r �proxy_napalm_wrape s
ro c C s | i ddd�}|S )z6
Return the default dict of the state output.
Fr- )�name�changesr2 r3 r )rp rj r r r � default_ret s rr c C sB i }|d | d< d|v r|d |d< d|v r |d |d< d|v r(|r(|d |d< |r4d|v r4|d |d< |� d�rFdj| d |d d�| d< |� d�rXdj| d |d d �| d< |� d�rqd
j| d tjj|d d |d �d
�| d< |� dd�sy| S |� dd�s�|r�d| d< | S | �d|d�|d �d�� | S | �di d�� | S )z�
Return the final state output.
ret
The initial state output structure.
loaded
The loaded dictionary.
r3 �diffZ commit_id�compliance_reportZ
loaded_configz+{comment_base}
Configuration diff:
{diff})� comment_basers z,{comment_base}
Loaded config:
{loaded_cfg})ru Z
loaded_cfgz0{comment_base}
Compliance report:
{compliance}�nestedr
)ru Z
compliancer2 FZalready_configuredTNzConfiguration changed!
{})r2 rq r3 )r2 rq )r r@ r �outputZ
string_formatr8 )rj Zloaded�testr7 rt r rq r r r �
loaded_ret sR
�
�
�
� ��ry )N)FN)$�__doc__rd r] �loggingr4 � functoolsr Z salt.outputr Zsalt.utils.argsZsalt.utils.platformr r �int� __version__�splitr �AttributeErrorr_ Znapalm.base.exceptionsr rA � getLogger�__file__r6 r r r r r rB rY r9 ro rr ry r r r r �<module> sR �� � �
20