Current File : //lib/python2.7/site-packages/salt/runners/bgp.pyo
�
���^c @@ sX d Z d d l m Z m Z m Z y: d d l m Z d d l m Z d d l m Z
e Z Wn e
k
ru e Z n Xd d l Z d d l m Z d d l m Z d Z d
Z d Z e Z d Z d
d d g Z d d d g Z i d d
6d d 6d d 6d d 6d d 6d d 6d d 6Z d � Z d � Z d d � Z d � Z! e e d � Z" d � Z# d S(! u�
BGP Finder
==========
.. versionadded:: 2017.7.0
Runner to search BGP neighbors details.
Configuration
-------------
- Minion (proxy) config
The ``bgp.neighbors`` function must be appened in the list of ``mine_functions``:
.. code-block:: yaml
mine_functions:
bgp.neighbors: []
Which instructs Salt to cache the data returned by the ``neighbors`` function
from the :mod:`NAPALM BGP module <salt.modules.napalm_bgp.neighbors>`.
How often the mines are refreshed, can be specified using:
.. code-block:: yaml
mine_interval: <X minutes>
- Master config
By default the following options can be configured on the master.
They are not mandatory, but available in case the user has different requirements.
tgt: ``*``
From what minions will collect the mine data.
Default: ``*`` (collect mine data from all minions)
tgt_type: ``glob``
Minion matching expression form. Default: ``glob``.
return_fields
What fields to return in the output.
It can display all the fields from the ``neighbors`` function
from the :mod:`NAPALM BGP module <salt.modules.napalm_bgp.neighbors>`.
Some fields cannot be removed:
- ``as_number``: the AS number of the neighbor
- ``device``: the minion ID
- ``neighbor_address``: the neighbor remote IP address
By default, the following extra fields are returned (displayed):
- ``connection_stats``: connection stats, as described below
- ``import_policy``: the name of the import policy
- ``export_policy``: the name of the export policy
Special fields:
- ``vrf``: return the name of the VRF.
- ``connection_stats``: returning an output of the form ``<State>
<Active>/<Received>/<Accepted>/<Damped>``, e.g. ``Established
398/399/399/0`` similar to the usual output from network devices.
- ``interface_description``: matches the neighbor details with the
corresponding interface and returns its description. This will reuse
functionality from the :mod:`net runner
<salt.runners.net.interfaces>`, so the user needs to enable the mines
as specified in the documentation.
- ``interface_name``: matches the neighbor details with the
corresponding interface and returns the name. Similar to
``interface_description``, this will reuse functionality from the
:mod:`net runner <salt.runners.net.interfaces>`, so the user needs to
enable the mines as specified in the documentation.
display: ``True``
Display on the screen or return structured object? Default: ``True`` (return on the CLI).
outputter: ``table``
Specify the outputter name when displaying on the CLI. Default: :mod:`table <salt.output.table_out>`.
Configuration example:
.. code-block:: yaml
runners:
bgp:
tgt: 'edge*'
tgt_type: 'glob'
return_fields:
- up
- connection_state
- previous_connection_state
- suppress_4byte_as
- holdtime
- flap_count
outputter: yaml
i ( t absolute_importt print_functiont unicode_literals( t IPNetwork( t IPAddress( t helpersN( t six( t mapu bgpu *u globu tableu deviceu as_numberu neighbor_addressu connection_statsu
import_policyu
export_policyu Deviceu AS Numberu Neighbor IPu& State|#Active/Received/Accepted/Dampedu Policy INu
Policy OUTu VRFu vrfc C@ s t r
t St d f S( Nu, The napalm-base module could not be imported( t HAS_NAPALM_BASEt __virtualname__t False( ( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt __virtual__� s c C@ s� t j d i � j d i � } i | j d t � d 6| j d t � d 6| j d t � d 6t | j d t � d 6| j d t � d 6S( u(
Return the bgp runner options.
u runnersu bgpu tgtu tgt_typeu displayu
return_fieldsu outputter( t __opts__t gett _DEFAULT_TARGETt _DEFAULT_EXPR_FORMt _DEFAULT_DISPLAYt _DEFAULT_INCLUDED_FIELDSt _DEFAULT_RETURN_FIELDSt _DEFAULT_OUTPUTTER( t runner_opts( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt _get_bgp_runner_opts� s c C@ s1 | s t � } n t d | d d d | d �S( u\
Helper to return the mine data from the minions, as configured on the runner opts.
u mine.getu tgtu
bgp.neighborst tgt_typeu tgt_type( R t __salt__( t opts( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt _get_mine� s
c C@ sD x= t j | � D], \ } } | | k r | | | k r t Sq Wt S( uT
Compare two dictionaries and return a boolean value if their values match.
( R t iteritemsR
t True( t dict1t dict2t kargt warg( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt _compare_match� s c
C@ sz | rr | d k rM t j j i | d 6| d 6d t d | d d d d �} n t j j | | t � } t | � n | Sd S( u%
Display or return the rows.
u tableu rowsu labelst titlet rows_keyt
labels_keyN( t saltt outputt
out_formatR t print( t rowst labelsR! t displayt outputtert ret( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt _display_runner� s
c @ s� t � } � j d d5 � } � j d | d � } � j d | d � } i } | j � � x< t j | � D]+ \ } } | j d � rj � j | � qj qj W| r� � r� | r� t d � n g S� j d d5 � } � j d d5 � }
� j d d5 � } | rt | � n d5 } g }
i } xW | d D]K } | t k rFt | | | <q#d
j
t d � | j d � � � | | <q#Wt
t | d � t t � � } t d
| � } | s�g } | r�| j d j d d j
g | D] } t j | � ^ q�� � � n |
r| j d j d |
� � n | r8| j d j d | � � n � ru| j d j d d j
t � f d � � � � � � n d j
| � } n x�t j | � D]�\ } } | j d � s�q�n | r�| | k r�q�n | j d i � } x�t j | � D]�\ } } xyt j | � D]h\ } } | r2| | k r2qn xA| D]9} � r[t � | � r[q9n |
r||
| j d � k r|q9n | r�| j d � r�t | j d � � } | | k r�q9q�n i | d 6| j d � d 6| d 6} d | k r�| | d <n d | k rwd j d! | j d" d# � d$ | j d% d# � d& | j d' d# � d( | j d) d# � d* | j d+ d# � � } | | d <n d, | k s�d- | k r7t d. d/ | d | j d � d0 t � } | rd, | k r�| d1 d, | d, <n d- | k r4| d1 d2 | d- <q4q7d, | k rd3 | d, <n d- | k r7d3 | d- <q7n x+ | D]# } | | k r>| | | | <q>q>W|
j | � q9WqWq�Wq�Wt |
| | d0 | d4 | �S(6 u�
Search for BGP neighbors details in the mines of the ``bgp.neighbors`` function.
Arguments:
asns
A list of AS numbers to search for.
The runner will return only the neighbors of these AS numbers.
device
Filter by device name (minion ID).
ip
Search BGP neighbor using the IP address.
In multi-VRF environments, the same IP address could be used by
more than one neighbors, in different routing tables.
network
Search neighbors within a certain IP network.
title
Custom title.
display: ``True``
Display on the screen or return structured object? Default: ``True`` (return on the CLI).
outputter: ``table``
Specify the outputter name when displaying on the CLI. Default: :mod:`table <salt.output.table_out>`.
In addition, any field from the output of the ``neighbors`` function
from the :mod:`NAPALM BGP module <salt.modules.napalm_bgp.neighbors>` can be used as a filter.
CLI Example:
.. code-block:: bash
salt-run bgp.neighbors 13335 15169
salt-run bgp.neighbors 13335 ip=172.17.19.1
salt-run bgp.neighbors multipath=True
salt-run bgp.neighbors up=False export_policy=my-export-policy multihop=False
salt-run bgp.neighbors network=192.168.0.0/16
Output example:
.. code-block:: text
BGP Neighbors for 13335, 15169
________________________________________________________________________________________________________________________________________________________________
| Device | AS Number | Neighbor Address | State|#Active/Received/Accepted/Damped | Policy IN | Policy OUT |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 | 13335 | 172.17.109.11 | Established 0/398/398/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 | 13335 | 172.17.109.12 | Established 397/398/398/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.flw01 | 13335 | 192.168.172.11 | Established 1/398/398/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.oua01 | 13335 | 172.17.109.17 | Established 0/0/0/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 | 15169 | 2001::1 | Established 102/102/102/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.bjm01 | 15169 | 2001::2 | Established 102/102/102/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
| edge01.tbg01 | 13335 | 192.168.172.17 | Established 0/1/1/0 | import-policy | export-policy |
________________________________________________________________________________________________________________________________________________________________
u titleu displayu outputteru __pubu8 Please specify at least an AS Number or an output filteru deviceu ipu networku
return_fieldsu c S@ s
| j � S( N( R! ( t word( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt <lambda>H s u _R u BGP Neighbors for {asns}t asnsu , u: Selecting neighbors having the remote IP address: {ipaddr}t ipaddru2 Selecting neighbors within the IP network: {ipnet}t ipnetu< Searching for BGP neighbors having the attributes: {attrmap}t attrmapc @ s d j d | d � | � S( Nu
{key}={value}t keyt value( t format( R4 ( t kwargs( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyR/ X s u
u resultu outu remote_addressu neighbor_addressu as_numberu vrfu connection_statsu/ {state} {active}/{received}/{accepted}/{damped}t stateu connection_statei����t activeu active_prefix_countt receivedu received_prefix_countt acceptedu accepted_prefix_countt dampedu suppressed_prefix_countu interface_descriptionu interface_nameu net.interfacest deviceR* i u interfaceu R+ N( R t popt Nonet updateR R t
startswithR' R t _DEFAULT_LABELS_MAPPINGt joinR t splitt listt setR R t appendR6 t text_typeR
R R R R
R- ( R0 R7 R R! R* R+ t kwargs_copyR t _R= t neighbor_ipR2 t ipnet_objR( R) t fieldt display_fieldst get_bgp_neighbors_allt title_partst asnt miniont get_bgp_neighbors_miniont get_bgp_neighbors_minion_outt vrft vrf_bgp_neighborst get_bgp_neighbors_minion_asnt neighbort neighbor_ip_objt rowt connection_statst net_find( ( R7 s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt neighbors� s� B
, 2 (
($ t __doc__t
__future__R R R t netaddrR R t napalm_baseR t napalm_helpersR R t ImportErrorR
t salt.outputR$ t salt.extR t salt.ext.six.movesR R R R R R R R RB R R R? R R R- R] ( ( ( s4 /usr/lib/python2.7/site-packages/salt/runners/bgp.pyt <module>c sJ
Mini Shell