Current File : //lib/python2.7/site-packages/salt/states/probes.pyo
�
���^c @@ s� d Z d d l m Z d d l Z e j e � Z d d l m Z d d l m
Z
m Z d d l m
Z
d d l Z d Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z d d � Z d S( sw
Network Probes
===============
Configure RPM (JunOS)/SLA (Cisco) probes on the device via NAPALM proxy.
:codeauthor: Mircea Ulinic <mircea@cloudflare.com> & Jerome Fleury <jf@cloudflare.com>
:maturity: new
:depends: napalm
:platform: unix
Dependencies
------------
- :mod:`napalm probes management module <salt.modules.napalm_probes>`
.. versionadded: 2016.11.0
i ( t absolute_importN( t deepcopy( t loadst dumps( t sixt probesc C@ s t j j j t t t � S( s_
NAPALM library must be installed for this module to work and run in a (proxy) minion.
( t saltt utilst napalmt virtualt __opts__t __virtualname__t __file__( ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt __virtual__2 s c C@ s i | d 6t d 6i d 6d d 6S( sh
Returns a default structure of the dictionary to be returned as output of the state functions.
t namet resultt changest t comment( t False( R ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _default_ret= s
c C@ s t d � S( sl
Will retrieve the probes from the network device using salt module "probes" throught NAPALM proxy.
s
probes.config( t __salt__( ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _retrieve_rpm_probesK s c
C@ s� i } x� t j | � D]� \ } } | | j � k rA i | | <n | j d i � } x� t j | � D]x \ } } | j d i � } t | � } | j | � | j | � | j | � | | | j � k rc | | | | <qc qc Wq W| S( sP
Updates the probes dictionary with different levels of default values.
t defaults( R t iteritemst keyst popR t update(
R R t expected_probest
probe_namet
probe_testt probe_defaultst test_namet test_detailst
test_defaultst expected_test_details( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _expand_probesT s
c C@ s� t | � } t | � } x� t j | � D]~ \ } } | sM | j | � q( n xV t j | � D]E \ } } | s� | | j | � n | j | � s] | j | � q] q] Wq( Wt S( sJ
Will remove empty and useless values from the probes dictionary.
( t _ordered_dict_to_dictR R R R t gett True( R t probes_copyR t probe_testsR t test_params( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt
_clean_probesl s
c C@ sQ i } i } i } | s# i | d 6S| s4 i | d 6St | j � � } t | j � � } | | } | | } x! | D] } | j | � | | <qs Wx! | D] } | j | � | | <q� Wx�t j | � D]p\ } }
| j | i � } t | j � � } t |
j � � }
|
| } | |
} xN | D]F } | | j � k rFi | | <n | | j i |
j | � | 6� q!WxN | D]F } | | j � k r�i | | <n | | j i | j | � | 6� qrWxu t j |
� D]d \ } } | j | i � } | | k r�| | j � k ri | | <n | | j i | | 6� q�q�Wq� Wi | d 6| d 6| d 6S( so
Compares configured probes on the device with the expected configuration and returns the differences.
t addt removeR ( t setR R R R R& R ( t configured_probesR t
new_probest
update_probest
remove_probest configured_probes_keys_sett expected_probes_keys_sett new_probes_keys_sett remove_probes_keys_setR R) t configured_probe_testst configured_tests_keys_sett expected_tests_keys_sett new_tests_keys_sett remove_tests_keys_setR R* t configured_test_params( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _compare_probes� sX
c C@ s t t | � � S( sK Mandatory to be dict type in order to be used in the NAPALM Jinja template.( R R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyR% � s c C@ s t d t | � d t �S( sO
Calls the Salt module "probes" to configure the probes on the device.
s probes.set_probest commit( R R% R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _set_rpm_probes� s c C@ s t d t | � d t �S( sY
Calls the Salt module "probes" to schedule the configured probes on the device.
s probes.schedule_probesR> ( R R% R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _schedule_probes� s c C@ s t d t | � d t �S( sJ
Calls the Salt module "probes" to delete probes from the device.
s probes.delete_probesR> ( R R% R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt _delete_rpm_probes� s c C@ s� t | � } t } d } t � } | j d � sd | j i t d 6d j d | j d � � d 6� | S| j d i � } t | t � s� i } n t | | � } t
| � t
| � t | | � } | j d � }
| j d � } | j d � } i t |
� d
6t | � d 6t | � d 6}
| j i |
d
6� t
d t k r]| j i d d 6d d 6� | St } |
r�t |
� } | j d � r�t } q�t } | d j d | j d � � 7} n | rt | � } | j d � r�t } qt } | d j d | j d � � 7} n | rYt | � } | j d � r1t } qYt } | d j d | j d � � 7} n | rut d � \ } } n t |
� } | j d � r�t d � \ } } n | r�| r�| d k r�d } q�n | j i | d 6| d 6� | S( s�
Ensure the networks device is configured as specified in the state SLS file.
Probes not specified will be removed, while probes not confiured as expected will trigger config updates.
:param probes: Defines the probes as expected to be configured on the
device. In order to ease the configuration and avoid repeating the
same parameters for each probe, the next parameter (defaults) can be
used, providing common characteristics.
:param defaults: Specifies common parameters for the probes.
SLS Example:
.. code-block:: yaml
rpmprobes:
probes.managed:
- probes:
probe_name1:
probe1_test1:
source: 192.168.0.2
target: 192.168.0.1
probe1_test2:
target: 172.17.17.1
probe1_test3:
target: 8.8.8.8
probe_type: http-ping
probe_name2:
probe2_test1:
test_interval: 100
- defaults:
target: 10.10.10.10
probe_count: 15
test_interval: 3
probe_type: icmp-ping
In the probes configuration, the only mandatory attribute is *target*
(specified either in probes configuration, either in the defaults
dictionary). All the other parameters will use the operating system
defaults, if not provided:
- ``source`` - Specifies the source IP Address to be used during the tests. If
not specified will use the IP Address of the logical interface loopback0.
- ``target`` - Destination IP Address.
- ``probe_count`` - Total number of probes per test (1..15). System
defaults: 1 on both JunOS & Cisco.
- ``probe_interval`` - Delay between tests (0..86400 seconds). System
defaults: 3 on JunOS, 5 on Cisco.
- ``probe_type`` - Probe request type. Available options:
- icmp-ping
- tcp-ping
- udp-ping
Using the example configuration above, after running the state, on the device will be configured 4 probes,
with the following properties:
.. code-block:: yaml
probe_name1:
probe1_test1:
source: 192.168.0.2
target: 192.168.0.1
probe_count: 15
test_interval: 3
probe_type: icmp-ping
probe1_test2:
target: 172.17.17.1
probe_count: 15
test_interval: 3
probe_type: icmp-ping
probe1_test3:
target: 8.8.8.8
probe_count: 15
test_interval: 3
probe_type: http-ping
probe_name2:
probe2_test1:
target: 10.10.10.10
probe_count: 15
test_interval: 3
probe_type: icmp-ping
R R sD Cannot retrieve configurtion of the probes from the device: {reason}t reasonR t outR, R R- t addedt updatedt removedR t tests, Testing mode: configuration was not changed!s# Cannot define new probes: {reason}
s Cannot update probes: {reason}
s Cannot remove probes! {reason}
s net.config_controls Probes updated successfully!N( R R' R R& R R t formatt
isinstancet dictR$ R+ R= R% R
t NoneR? RA R R@ ( R R R t retR R t rpm_probes_configR/ R t difft
add_probesR1 R2 R t config_change_expectedRD RE RF t
add_scheduled( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt managed� s� W
( t __doc__t
__future__R t loggingt getLoggert __name__t logt copyR t jsonR R t salt.extR t salt.utils.napalmR R R
R R R$ R+ R= R% R? R@ RA RK RR ( ( ( s6 /usr/lib/python2.7/site-packages/salt/states/probes.pyt <module> s& K
Mini Shell