Current File : //usr/lib/python2.7/site-packages/salt/proxy/nxos.pyo
�
���^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 m Z m
Z
d d l m Z d d l
m Z e j e � Z d g Z d Z i i d 6Z d � Z d
� Z d d � Z d � Z d
� Z d � Z d � Z d � Z d � Z d � Z d � Z e! d � Z" d � Z# e! d d d d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d � Z* d � Z+ d � Z, e! d � Z- d! � Z. d" � Z/ d# � Z0 d$ � Z1 d% � Z2 d S(& u4
Proxy Minion for Cisco NX OS Switches
.. versionadded: 2016.11.0
The Cisco NX OS Proxy Minion uses the built in SSHConnection module in :mod:`salt.utils.vt_helper <salt.utils.vt_helper>`
To configure the proxy minion:
.. code-block:: yaml
proxy:
proxytype: nxos
host: 192.168.187.100
username: admin
password: admin
prompt_name: switch
ssh_args: '-o PubkeyAuthentication=no'
key_accept: True
proxytype
(REQUIRED) Use this proxy minion `nxos`
host
(REQUIRED) ip address or hostname to connect to
username
(REQUIRED) username to login with
password
(REQUIRED) password to use to login with
prompt_name
(REQUIRED, this or `prompt_regex` below, but not both)
The name in the prompt on the switch. Recommended to use your
device's hostname.
prompt_regex
(REQUIRED, this or `prompt_name` above, but not both)
A regular expression that matches the prompt on the switch
and any other possible prompt at which you need the proxy minion
to continue sending input. This feature was specifically developed
for situations where the switch may ask for confirmation. `prompt_name`
above would not match these, and so the session would timeout.
Example:
.. code-block:: yaml
dc01-switch-01#.*|\(y\/n\)\?.*
This should match
.. code-block:: shell
dc01-switch-01#
or
.. code-block:: shell
Flash complete. Reboot this switch (y/n)? [n]
If neither `prompt_name` nor `prompt_regex` is specified the prompt will be
defaulted to
.. code-block:: shell
.+#$
which should match any number of characters followed by a `#` at the end
of the line. This may be far too liberal for most installations.
ssh_args
Any extra args to use to connect to the switch.
key_accept
Whether or not to accept a the host key of the switch on initial login.
Defaults to False.
The functions from the proxy minion can be run from the salt commandline using
the :mod:`salt.modules.nxos<salt.modules.nxos>` execution module.
.. note:
If `multiprocessing: True` is set for the proxy minion config, each forked
worker will open up a new connection to the Cisco NX OS Switch. If you
only want one consistent connection used for everything, use
`multiprocessing: False`
i ( t absolute_importt print_functiont unicode_literalsN( t gen_hasht secure_password( t
SSHConnection( t TerminalExceptionu nxosu grains_cachec C@ s t j d � t S( u6
Only return if all the modules are available
u" nxos proxy __virtual__() called...( t logt infot __virtualname__( ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt __virtual__q s
c C@ s
t j � j S( N( t multiprocessingt current_processt name( ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt _worker_namez s c
C@ s7 | d k r t } n y� d } d | d k r? | d d } n= d | d k ri d j | d d � } n t j d � d } t d | d d d | d d
d | d d d
| d j d t � d | d j d d � d | � t t � <t t � j
d � \ } } Wn! t k
r(} t j | � t SXt
t d <d S( uH
Required.
Can be used to initialize the server connection.
u prompt_regexu proxyu prompt_nameu {0}.*#u9 nxos proxy configuration does not specify a prompt match.u .+#$t hostu hostt usernameu usernamet passwordu passwordt
key_acceptu
key_acceptt ssh_argsu ssh_argsu t promptu terminal length 0u initializedN( t Nonet __opts__t formatR t warningR t gett Falset DETAILSR t sendlineR t errort True( t optst this_promptt outt errt e( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt init~ s,
c C@ s t j d t � S( Nu initialized( R R R ( ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt initialized� s c C@ sY t � t k r t � n y t t � j j � SWn! t k
rT } t j | � t SXd S( uu
Ping the device on the other end of the connection
.. code-block: bash
salt '*' nxos.cmd ping
N( R R R$ t connt isaliveR R R R ( R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt ping� s
c C@ s t t � j � d S( u
Disconnect
N( R R t close_connection( R ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt shutdown� s c C@ si t � t k r t � n t t � j | � \ } } | j d d � \ } } | j d � \ } } } | S( u�
Run command through switch's cli
.. code-block: bash
salt '*' nxos.cmd sendline 'show run | include "^username admin password"'
u
i ( R( R R$ R R R t splitt
rpartition( t commandR! R" t _( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyR � s
c C@ sC t d s4 t � } t j | � t d j | � n i t d d 6S( u`
Get grains for proxy minion
.. code-block: bash
salt '*' nxos.cmd grains
u grains_cacheu nxos( R t system_infoR t debugt update( t ret( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt grains� s
c C@ s i t d <t � S( uv
Refresh the grains from the proxy device.
.. code-block: bash
salt '*' nxos.cmd grains_refresh
u grains_cache( R R3 ( ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt grains_refresh� s
c C@ s t d j | � � S( us
Get username line from switch
.. code-block: bash
salt '*' nxos.cmd get_user username=admin
u. show run | include "^username {0} password 5 "( R R ( R ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt get_user� s c C@ s^ t d j | � � } t j d | t j � } | rT | j d � j � j d � } n g } | S( u�
Get roles that the username is assigned from switch
.. code-block: bash
salt '*' nxos.cmd get_roles username=admin
u show user-account {0}u ^\s*roles:(.*)$i u ( R R t ret searcht MULTILINEt groupt stripR+ ( R R t roles( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt get_roles� s !c
C@ s� i d d 6d d 6d d 6d d 6} t | � } | s8 d Sd | k rH t St j d
| � j d � } | t k r� t j d | � j � \ } } } t d
| d | d | | � } n | } | | k r� t St S( uE
Check if passed password is the one assigned to user
.. code-block: bash
salt '*' nxos.cmd check_password username=admin password=admin
salt '*' nxos.cmd check_password username=admin \
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \
encrypted=True
u md5u 1u blowfishu 2au sha256u 5u sha512u 6u !!u (\$[0-6](?:\$[^$ ]+)+)i u ^\$([0-6])\$([^$]+)\$(.*)$t
crypt_saltR t algorithmN( R5 R R R6 R7 R9 t groupsR R (
R R t encryptedt hash_algorithmst
password_linet cur_hasht hash_typet cur_saltt hashed_passt new_hash( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt check_password s"
!" c C@ s | t | � k S( u�
Check if user is assigned a specific role on switch
.. code-block:: bash
salt '*' nxos.cmd check_role username=admin role=network-admin
( R< ( R t role( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt
check_role s u sha256c
C@ s� t | � } | t k rW | d
k r9 t d d t �} n t d | d | d | � } n | } d j | | � } | d
k r� | d j | � 7} n yA t d � t | � } t d � t d
� d j | | g � SWn! t k
r� } t j
| � d SXd
S( u
Set users password on switch
.. code-block:: bash
salt '*' nxos.cmd set_password admin TestPass
salt '*' nxos.cmd set_password admin \
password='$5$2fWwO2vK$s7.Hr3YltMNHuhywQQ3nfOd.gAPHgs3SOBYYdGT3E.A' \
encrypted=True
i t
use_randomR= R R> u username {0} password 5 {1}u role {0}u config terminalu endu" copy running-config startup-configu
u Failed to set passwordN( R5 R R R R R R t joinR R R (
R R R@ RI R= R> RB RF R2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt set_password+ s$
c C@ sx yP t d � d j | � } t | � } t d � t d � d j | | g � SWn! t k
rs } t j | � d SXd S( ur
Remove user from switch
.. code-block:: bash
salt '*' nxos.cmd remove_user username=daniel
u config terminalu no username {0}u endu" copy running-config startup-configu
u Failed to set passwordN( R R RL R R R ( R t user_lineR2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt remove_userM s
c C@ s{ yS t d � d j | | � } t | � } t d � t d � d j | | g � SWn! t k
rv } t j | � d SXd S( u~
Assign role to username
.. code-block:: bash
salt '*' nxos.cmd set_role username=daniel role=vdc-admin
u config terminalu username {0} role {1}u endu" copy running-config startup-configu
u Failed to set passwordN( R R RL R R R ( R RI t role_lineR2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt set_rolea s
c C@ s{ yS t d � d j | | � } t | � } t d � t d � d j | | g � SWn! t k
rv } t j | � d SXd S( u�
Remove role from username
.. code-block:: bash
salt '*' nxos.cmd unset_role username=daniel role=vdc-admin
u config terminalu no username {0} role {1}u endu" copy running-config startup-configu
u Failed to set passwordN( R R RL R R R ( R RI RP R2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt
unset_roleu s
c C@ s8 y t d � } Wn! t k
r3 } t j | � d SX| S( ul
Shortcut to run `show run` on switch
.. code-block:: bash
salt '*' nxos.cmd show_run
u show runu Failed to "show run"( R R R R ( R2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt show_run� s
c C@ s8 y t d � } Wn! t k
r3 } t j | � d SX| S( ul
Shortcut to run `show ver` on switch
.. code-block:: bash
salt '*' nxos.cmd show_ver
u show veru Failed to "show ver"( R R R R ( R2 R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt show_ver� s
c C@ s� t | t � s | g } n y= t d � x | D] } t | � q/ Wt d � t d � Wn! t k
r{ } t j | � t SXt S( u
Add one or more config lines to the switch running config
.. code-block:: bash
salt '*' nxos.cmd add_config 'snmp-server community TESTSTRINGHERE group network-operator'
.. note::
For more than one config added per command, lines should be a list.
u config terminalu endu" copy running-config startup-config( t
isinstancet listR R R R R R ( t linest lineR# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt
add_config� s
c C@ s� t | t � s | g } n yL t d � x' | D] } t d j d | g � � q/ Wt d � t d � Wn! t k
r� } t j | � t SXt S( u$
Delete one or more config lines to the switch running config
.. code-block:: bash
salt '*' nxos.cmd delete_config 'snmp-server community TESTSTRINGHERE group network-operator'
.. note::
For more than one config deleted per command, lines should be a list.
u config terminalu u nou endu" copy running-config startup-config( RU RV R RL R R R R R ( RW RX R# ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt
delete_config� s
c C@ s% t j | t j � } | j t � � S( u
Find all instances where the pattern is in the running command
.. code-block:: bash
salt '*' nxos.cmd find '^snmp-server.*$'
.. note::
This uses the `re.MULTILINE` regex format for python, and runs the
regex against the whole show_run output.
( R6 t compileR8 t findallRS ( t patternt matcher( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt find� s c C@ s | t k rN t j d j t j | � � t j � } t j t j | � � } n$ t j | t j � } t j | � } i g d 6g d 6} xZ | j t � � D]F } | d j | j d � � | d j | j
| | j d � � � q� Wt | d � t | d � | S( u
Replace string or full line matches in switch's running config
If full_match is set to True, then the whole line will need to be matched
as part of the old value.
.. code-block:: bash
salt '*' nxos.cmd replace 'TESTSTRINGHERE' 'NEWTESTSTRINGHERE'
u ^.*{0}.*$u oldu newi (
R R6 R[ R t escapeR8 t finditerRS t appendR9 t subRZ RY ( t old_valuet new_valuet
full_matchR^ t replRW RX ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt replace� s '*c C@ s t j d j d | � t j � S( Nu ^{block}
(?:^[
].*$
?)+t block( R6 R[ R R8 ( Ri ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt _parser
s c C@ s� i i d 6} t d � j | � j d � } t j d t j � } x7 | j | � D]& } | j � \ } } | | d | <qP W| d S( Nu softwareu Softwarei u ^ ([^:]+): *([^
]+)( Rj R7 R9 R6 R[ R8 Ra R? ( t dataR2 t softwareR^ RX t keyt val( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt _parse_software s
c C@ s� i i d 6} t d � j | � j d � } t j d t j � } x7 | j | � D]& } | j � \ } } | | d | <qP W| d S( Nu hardwareu Hardwarei u ^ ([^:
]+): *([^
]+)( Rj R7 R9 R6 R[ R8 Ra R? ( Rk R2 t hardwareR^ RX Rm Rn ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt _parse_hardware s
c C@ sy i g d 6} t d � j | � j d � } t j d t j � } x. | j | � D] } | d j | j � � qP W| d S( Nu pluginsu plugini u ^ (?:([^,]+), )+([^
]+)( Rj R7 R9 R6 R[ R8 Ra t extendR? ( Rk R2 t pluginsR^ RX ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt _parse_plugins" s
c C@ s: t � } i t | � d 6t | � d 6t | � d 6} | S( u�
Return system information for grains of the NX OS proxy minion
.. code-block:: bash
salt '*' nxos.system_info
u softwareu hardwareu plugins( RT Ro Rq Rt ( Rk R ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyR/ + s
(3 t __doc__t
__future__R R R t loggingR R6 t salt.utils.pycryptoR R t salt.utils.vt_helperR t
salt.utils.vtR t getLoggert __file__R t __proxyenabled__R R R
R R R$ R% R( R* R R3 R4 R5 R< R RH RJ RM RO RQ RR RS RT RY RZ R_ Rh Rj Ro Rq Rt R/ ( ( ( s3 /usr/lib/python2.7/site-packages/salt/proxy/nxos.pyt <module>] sN
"
Mini Shell