File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/runners/__pycache__/bgp.cpython-310.pyc
Back
o ;j�E � @ s� d Z ddlZzddlmZ ddlmZmZ dZ W n e y# dZ Y nw dZ dZ d Z dZd Zg d �Zg d �Zd ddddddd�Zdd� Zdd� Zd!dd�Zdd � Zeefd d �Zd d � ZdS )"a� 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 � N)�helpers)� IPAddress� IPNetworkTF�bgp�*�glob�table)�device� as_number�neighbor_address)�connection_stats� import_policy� export_policyZDevicez AS Numberz Neighbor IPz&State|#Active/Received/Accepted/Dampedz Policy INz Policy OUTZVRF)r r r r r r �vrfc C s t rtS dS )N)Fz'The napalm module could not be imported)� HAS_NAPALM�__virtualname__� r r �D/opt/saltstack/salt/lib/python3.10/site-packages/salt/runners/bgp.py� __virtual__� s r c C sP t �di ��di �} | �dt�| �dt�| �dt�t| �dt� | �dt�d�S ) z( Return the bgp runner options. Zrunnersr �tgt�tgt_type�display� return_fields� outputter)r r r r r )�__opts__�get�_DEFAULT_TARGET�_DEFAULT_EXPR_FORM�_DEFAULT_DISPLAY�_DEFAULT_INCLUDED_FIELDS�_DEFAULT_RETURN_FIELDS�_DEFAULT_OUTPUTTER)Z runner_optsr r r �_get_bgp_runner_opts� s � �r" c C s$ | st � } td | d d| d d�S )z\ Helper to return the mine data from the minions, as configured on the runner opts. zmine.getr z bgp.neighborsr )r )r" �__salt__��optsr r r � _get_mine� s r& c C s0 | � � D ]\}}||v r|| |kr dS qdS )zT Compare two dictionaries and return a boolean value if their values match. FT)�items)Zdict1Zdict2�kargZwargr r r �_compare_match� s �r) c C sL |r$|dkrt jj| |d�dt|ddd�}nt j�| |t�}t|� dS | S )z% Display or return the rows. r )�rows�labelsr* r+ )�titleZrows_keyZ labels_keyN)�salt�outputZ out_formatr �print)r* r+ r, r r �retr r r �_display_runner� s � r1 c s� t � }� �dd�}� �d|d �}� �d|d �}i }|�� � |�� D ]\}}|�d�r2� �|� q$| s?� s?|r=td� g S � �dd�} � �dd�} � �d d�} | rWt| �nd} g } i }|d D ] }|tv rnt| ||< qad �t d d � |� d���||< qat t |d �t t � �}t|d�}|s�g }| r�|�djd�dd� | D ��d�� | r�|�dj| d�� | r�|�d| � �� � r�|�djd�t � fdd �� ��d�� d�|�}|�� D ]�\}}|�d �s�q�| r�|| kr�q�|�d i �}|�� D ]�\}}|�� D ]�\}}| �r || v�r q�|D ]�}� �rt� |��s�q | �r%| |�d �k�r%�q | �r<|�d ��r<t|�d ��}|| v�r<�q ||�d �|d �} d |v �rN|| d < d!|v �rud"j|�d#d$�|�d%d$�|�d&d$�|�d'd$�|�d(d$�d)�} | | d!< d*|v �sd+|v �r�td, ||�d �d-d.�} | �r�d*|v �r�| d/ d* | d*< d+|v �r�| d/ d0 | d+< nd*|v �r�d1| d*< d+|v �r�d1| d+< |D ]}||v �r�|| | |< �q�| �| � �q q�q�q�t| ||||d2�S )3a� 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 | ________________________________________________________________________________________________________________________________________________________________ r, Nr r Z__pubz8Please specify at least an AS Number or an output filterr �ip�networkr � c S s | � � S �N)r, )�wordr r r �<lambda>; s zneighbors.<locals>.<lambda>�_r$ zBGP Neighbors for {asns}z, c S s g | ]}t |��qS r )�str)�.0�asnr r r � <listcomp>D s z neighbors.<locals>.<listcomp>)�asnsz:Selecting neighbors having the remote IP address: {ipaddr})Zipaddrz+Selecting neighbors within the IP network: z<Searching for BGP neighbors having the attributes: {attrmap}c s dj | � | d�S )Nz {key}={value})�key�value)�format)r> ��kwargsr r r7 T s �)Zattrmap� �result�outZremote_address)r r r r r z/{state} {active}/{received}/{accepted}/{damped}Zconnection_state���Zactive_prefix_countZreceived_prefix_countZaccepted_prefix_countZsuppressed_prefix_count)�stateZactiveZreceivedZacceptedZdampedZinterface_descriptionZinterface_nameznet.interfacesF)r �ipnetr r Z interface� )r r )r" �pop�updater' � startswithr/ r �_DEFAULT_LABELS_MAPPING�join�map�split�list�setr r& �appendr@ r r) r r# r1 ) r= rB r% r, r r Z kwargs_copyr( r8 r Z neighbor_iprH Z ipnet_objr* r+ �fieldZdisplay_fieldsZget_bgp_neighbors_allZ title_partsZminionZget_bgp_neighbors_minionZ get_bgp_neighbors_minion_outr Zvrf_bgp_neighborsr; Z get_bgp_neighbors_minion_asnZneighborZneighbor_ip_obj�rowr Znet_findr rA r � neighbors� s� B � ���� ���� � � � �� � � � ����CrV r5 )�__doc__Z salt.outputr- Z napalm.baser Znapalm_helpersZnetaddrr r r � ImportErrorr r r r r! r r rM r r" r& r) r1 rV r r r r �<module> s> c �� �
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings