Current File : //lib/python2.7/site-packages/salt/utils/napalm.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l m
Z
d d l m Z d d l
Z d d l Z d d l Z ye d d l Z d d l j Z e Z e Z y e e j j d � d � Z Wn e k
r� d Z n XWnG e k
rDe Z y d d l Z e Z WqEe k
r@e Z qEXn Xy d d l m Z e Z! Wn e k
rxe Z! n Xe j" e# � Z$ d � Z% d � Z& d
� Z' d � Z( d � Z) d
� Z* d d � Z, d d � Z- d � Z. d � Z/ e d d � Z0 d S( u�
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
i ( t absolute_importt unicode_literalst print_functionN( t wraps( t sixu .( t ConnectionClosedExceptionc C@ s1 t j j j � o0 | j d i � j d � d k S( u!
Is this a NAPALM proxy?
u proxyu proxytypeu napalm( t saltt utilst platformt is_proxyt get( t opts( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyR B s c C@ s | j d i � j d t � S( u#
Is always alive required?
u proxyu always_alive( R
t True( R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt is_always_aliveI s c C@ s# t | � r t | � p" t | � S( u,
Should this proxy be always alive?
( R R
t is_minion( R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt not_always_aliveP s c C@ s t j j j � o d | k S( u+
Is this a NAPALM straight minion?
u napalm( R R R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyR W s c C@ s` t r t d k s t r4 t | � s0 t | � r4 | St d j d | d d j d | � � f Sd S( u"
Returns the __virtual__.
i uW "{vname}"" {filename} cannot be loaded: NAPALM is not installed: ``pip install napalm``t vnamet filenameu ({filename})N( t
HAS_NAPALMt NAPALM_MAJORt HAS_NAPALM_BASER R t Falset format( R t virtualnameR ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt virtual^ s 0 c
O@ s� t } d' } | j d i � } | j d t � } | j d t � } | r� t j d � t j d � t j | d � | d j | � t j d � t j | d � t | � } n z�y� | j d t � s� t d � � n i } | j | � x9 t
j | � D]( \ }
} | d' k r� | j |
� q� q� Wt | j d
� | � | | � } t } Wn�t k
r:} | j d d � }
t
j � } t | t � r�d
j d | d | j d � � } nN| r|t r|t | t � r|t | d <d j d |
� } t j | � t j | � t j d |
� t | d d t �t j d |
� t | d d t �t j d |
� t j d | � t | | | | � Sd j d | j d d � d | j d i � j d � r�d j d | j d i � j d � � n d d | j d! d � d | d" | � } t j | � t j | � i i d# 6t d$ 6| d% 6| d& 6SXWd' | rtt | � rt| j d( t � rt| d
j � n Xi | d# 6| d$ 6d d% 6S() u�
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'
]
)
u __opts__u __retryu force_reconnectu Forced reconnection initiatedu' The current opts (under the proxy key):u proxyu Updated to:u UPu
not connectedu DRIVERu HOSTNAMEu [unspecified hostname]u; {method} is not implemented for the NAPALM {driver} driver!t methodt driveru DRIVER_NAMEu0 Disconnected from {device}. Trying to reconnect.t deviceu Clearing the connection with %su closet __retryu! Re-opening the connection with %su openu Connection re-opened with %su Re-executing %suG Cannot execute "{method}" on {device}{port} as {user}. Reason: {error}!t portu
OPTIONAL_ARGSu portu :{port}u t useru USERNAMEt erroru outu resultu commentu tracebackNu CLOSE( R t NoneR
t popR t logt debugt updatet
get_devicet ExceptionR t iteritemst getattrt tracebackt
format_exct
isinstancet NotImplementedErrorR t HAS_CONN_CLOSED_EXC_CLASSR R t callR t close( t
napalm_deviceR t argst kwargst resultt outR t retryt force_reconnectt kwargs_copyt kargt wargR t hostnamet err_tbt comment( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyR. q s| )
!
H
$c
C@ s� i } t | � r$ | j d i � n | j d i � } | j d � sT | j d � rm | j d t � | d <n | s� t j d � n | j d � p� | j d � p� | j d � p� | j d � | d <| j d
� p� | j d � | d <| j d
� p | j d � | d <| j d � p7| j d � p7| j d � p7d | d <| j d d � | d <| j d i � | d <| j d t � | d <| j d � | d <t | d <d | d k r�t | d d <n | d r�d | d k r�d! | d d <n | S(" uh
Returns the options of the napalm device.
:pram: opts
:return: the network device opts
u proxyu napalmu multiprocessinguH Incorrect minion config. Please specify at least the napalm driver name!u hostu hostnameu fqdnu ipu HOSTNAMEu usernameu useru USERNAMEu driveru osu DRIVER_NAMEu passwdu passwordu passu u PASSWORDu timeouti< u TIMEOUTu
optional_argsu
OPTIONAL_ARGSu always_aliveu ALWAYS_ALIVEu provideru PROVIDERu UPu config_locku keepalivei ( R R
R R" R R ( R t salt_objt network_devicet device_dict( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt get_device_opts s8 0
c C@ s� t j d � t | d | �} t } | j d � r� y t j | j d � � } Wq� t k
r� } t j d | j d � d t �t j d � q� Xn | j
| j d � � } yo | | j d d � | j d
d � | j d d � d | d
d | d �| d <| j d � j � t | d <Wn� t j j
k
r�} d j d | j d d � d | j d i � j d � r�d j d | j d i � j d � � n d d | j d
d � � } t j | � t j d | � t j j
| � � n X| S( u�
Initialise the connection with the network device through NAPALM.
:param: opts
:return: the network device object
u Setting up NAPALM connectionR= u PROVIDERu Unable to import %st exc_infou Falling back to napalm-baseu DRIVER_NAMEu HOSTNAMEu u USERNAMEu PASSWORDt timeoutu TIMEOUTt
optional_argsu
OPTIONAL_ARGSu DRIVERu UPu1 Cannot connect to {hostname}{port} as {username}.R: u [unspecified hostname]R u portu :{port}t usernameu Please check error: %s( R" R# R@ t napalm_baseR
t importlibt
import_modulet ImportErrorR R t get_network_drivert opent
exceptionst ConnectionExceptionR ( R R= R> t provider_libt ierrt _driver_R t base_err_msg( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyR% 0 s>
H
c @ s t � � � f d � � } | S( ue
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 @ s� � j } | j d � } t j | j d � � } | j d i � j d t � } | j d t � } | r� t j d � t j d � t j | d � | d j | � t j d � t j | d � n t | � r| r| r� t
| � | d <q�| d
� | d <n�t | � r�| r�d | k s8d | k r�| d r�y t
| � | d <Wq�t j j
k
r�} t j | � d j d
t j | j � � SXq�| d | d <n�t j d � | j d � } | d d i � } | d d i � }
t j d � t j | � t j j j | � } | j | � t j d � t j | � | j d � ps| j d � ps| j d � ps| j d � } | r�|
r�t |
t � r�| |
k r�|
| }
t j d | � t j |
� | j |
� t j d | � t j | � n t j | � } | | d <d | k s-d | k r�| d r�y t
| d | �| d <Wq�t j j
k
r�} t j | � d j d
t j | j � � SXn | d | d <t | � r�| | d d <n � | | � } | r�t j d � | d } t | d d t �} n | S( Nu __proxy__u __opts__u proxyu always_aliveu force_reconnectu! Usage of reconnect force detectedu Opts before mergingu Opts after mergingu
napalm_deviceu napalm.get_deviceu inherit_napalm_deviceu {base_msg}. See log for details.t base_msgu$ Not running in a NAPALM Proxy Minionu __salt__u
config.getu napalmu napalm_inventoryu& NAPALM opts found in the Minion configu( Merging the found opts with the CLI argsu hostu hostnameu fqdnu ipu! Found %s in the NAPALM inventory:uI Merging the config for %s with the details found in the napalm inventory:R= u3 That was a forced reconnect, gracefully clearing upu closeR ( t __globals__R
t copyt deepcopyR R R" R# R$ R R% RE RK RL R R R t text_typet msgR R R1 t clean_kwargsR+ t dictR R. ( R1 R2 t wrapped_global_namespacet proxyR t always_aliveR6 t ncet _salt_objt napalm_optst napalm_inventoryRW t hostt inventory_optst retR t closing( t func( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt func_wrapperp s�
( R ( Rd Re ( ( Rd s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt proxy_napalm_wrapf s
vc C@ s& i | d 6i d 6t d 6d d 6} | S( u6
Return the default dict of the state output.
u nameu changesu resultu u comment( R ( t nameRb ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt default_ret� s
c
C@ s� i } | d | d <d | k r1 | d | d <n d | k rN | d | d <n d | k rt | rt | d | d <qt n | r� d | k r� | d | d <n | j d � r� d j d | d d | d � | d <n | j d � rd j d | d d
| d � | d <n | j d � rNd j d | d d t j j | d d
d | �� | d <n | j d t � sd| S| j d t � s�| r�d | d <| S| j i t d 6| d 6d j | d � d 6� | S| j i t d 6i d 6� | S( u�
Return the final state output.
ret
The initial state output structure.
loaded
The loaded dictionary.
u commentu diffu commit_idu compliance_reportu
loaded_configu+ {comment_base}
Configuration diff:
{diff}t comment_baset diffu, {comment_base}
Loaded config:
{loaded_cfg}t
loaded_cfgu0 {comment_base}
Compliance report:
{compliance}t
complianceu nestedR u resultu already_configuredu changesu Configuration changed!
{}N( R
R R t outputt
string_formatR R R R$ ( Rb t loadedt testR# t compliance_reportR t changes( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt
loaded_ret� sJ
)
(1 t __doc__t
__future__R R R RS R) t loggingRF t functoolsR t salt.extR t salt.outputR t salt.utils.platformt salt.utils.argst napalmt napalm.baset baseRE R R R R t intt __version__t splitR t AttributeErrorRH t napalm_base.exceptionsR R- t getLoggert __file__R" R R
R R R R. R R@ R% Rf Rh Rs ( ( ( s5 /usr/lib/python2.7/site-packages/salt/utils/napalm.pyt <module> sV
� + 6 �
Mini Shell