Current File : //usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyc
�
���^c @@ sd d Z d d l m Z m Z m Z d d l Z d d l m Z d d l Z d d l
Z d d l m Z d d l
m Z d Z d g Z d � Z e d
� Z e d e d � Z d � Z d d
� Z d d e d d � Z d d d d � Z d d d d d d � Z d d d d d d � Z d d d d d d � Z d d d d d d � Z d d d d d d � Z d S( u
Cisco IOS configuration manipulation helpers
.. versionadded:: 2019.2.0
This module provides a collection of helper functions for Cisco IOS style
configuration manipulation. This module does not have external dependencies
and can be used from any Proxy or regular Minion.
i ( t absolute_importt unicode_literalst print_functionN( t six( t OrderedDict( t
SaltExceptionu iosconfigu *c C@ s; | | k r& t � | | <| | | <n | | j | � d S( N( R t update( t objt elet data( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt _attach_data_to_path$ s
c C@ s� d | k r g | d <n | g } | } t } x� t r� d j | � | d <| j d � } | sc Pq1 | | k r t � | | <n | | } | r1 | r1 | d j i | | 6� t } q1 q1 W| | k r� | | j | � n
| | | <t | | d <d S( Nu #listu u #texti u #standalone( t Truet joint popR t appendt FalseR ( R t pathR t list_t obj_tmpt firstt path_item( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt _attach_data_to_path_tags, s(
c C@ sP t � } x@| rK| j d � } | j � s | j � j d � rI q n | j � } t | � t | � } | | k r� t | d | d | d t �} | r� t | | | | � qHt | | | � q | | k r� | j
d | � Pq | s7t | d | d | d t �} | r$t | | | | � qHt | | | � q | j
d | � Pq W| S( Ni u !t current_indentt with_tagst nested( R R
t stript lstript
startswitht lent _parse_text_configR R R
t insert( t config_linesR R R t
struct_cfgt linet current_linet leading_spacest
current_block( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyR F sF "
c C@ sP t j | j d � | j d � � } d j g | D] } | j d d � ^ q1 � S( u-
Returns the diff of two text blobs.
i u u
( t difflibt unified_difft
splitlinesR t replace( t oldt newt difft x( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt _get_diff_textt s c C@ sm d } x` t j | � D]O \ } } | d j d d | d | � 7} | r | t | d | d �7} q q W| S( u7
Return the config as text from a config tree.
u u {indent}{line}
t indentu R! t indentationi ( R t iteritemst formatt _print_config_text( t treeR/ t configt keyt value( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyR2 } s !u basec C@ s_ | rC t d | d | �} | t k rC t d j | � � � qC n | j � } t | d | �S( u�
Transform Cisco IOS style configuration to structured Python dictionary.
Depending on the value of the ``with_tags`` argument, this function may
provide different views, valuable in different situations.
config
The configuration sent as text. This argument is ignored when ``path``
is configured.
path
Absolute or remote path from where to load the configuration text. This
argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
with_tags: ``False``
Whether this function should return a detailed view, with tags.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.tree path=salt://path/to/my/config.txt
salt '*' iosconfig.tree path=https://bit.ly/2mAdq7z
u cp.get_file_strt saltenvu {} is not availableR ( t __salt__R R R1 R' R ( R4 R R R7 R ( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyR3 � s ! c C@ s% t d | d | d | � } t | � S( u�
Return a clean version of the config, without any special signs (such as
``!`` as an individual line) or empty lines, but just lines with significant
value in the configuration of the network device.
config
The configuration sent as text. This argument is ignored when ``path``
is configured.
path
Absolute or remote path from where to load the configuration text. This
argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.clean path=salt://path/to/my/config.txt
salt '*' iosconfig.clean path=https://bit.ly/2mAdq7z
R4 R R7 ( R3 R2 ( R4 R R7 t config_tree( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt clean� s c C@ sL t d | d | d | � } t d | d | d | � } t j j j | | � S( u�
Return the merge tree of the ``initial_config`` with the ``merge_config``,
as a Python dictionary.
initial_config
The initial configuration sent as text. This argument is ignored when
``initial_path`` is set.
initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when ``merge_path`` is set.
merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``initial_path`` or ``merge_path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.merge_tree initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
R4 R R7 ( R3 t saltt utilst
dictupdatet merge( t initial_configt initial_patht merge_configt
merge_pathR7 t
merge_treet initial_tree( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyRC � s ' c C@ s1 t d | d | d | d | d | � } t | � S( u�
Return the merge result of the ``initial_config`` with the ``merge_config``,
as plain text.
initial_config
The initial configuration sent as text. This argument is ignored when
``initial_path`` is set.
initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when ``merge_path`` is set.
merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``initial_path`` or ``merge_path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.merge_text initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
R? R@ RA RB R7 ( RC R2 ( R? R@ RA RB R7 t candidate_tree( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt
merge_text s ' c C@ sh | r t d | d | �} n t d | d | d | d | � } t d | � } t | � } t | | � S( u�
Return the merge diff, as text, after merging the merge config into the
initial config.
initial_config
The initial configuration sent as text. This argument is ignored when
``initial_path`` is set.
initial_path
Absolute or remote path from where to load the initial configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
merge_config
The config to be merged into the initial config, sent as text. This
argument is ignored when ``merge_path`` is set.
merge_path
Absolute or remote path from where to load the merge configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``initial_path`` or ``merge_path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.merge_diff initial_path=salt://path/to/running.cfg merge_path=salt://path/to/merge.cfg
u cp.get_file_strR7 R? RA RB R4 ( R8 RF R3 R2 R- ( R? R@ RA RB R7 t candidate_configt clean_running_dictt
clean_running( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt
merge_diff4 s ' c C@ sL t d | d | d | � } t d | d | d | � } t j j j | | � S( u
Return the diff, as Python dictionary, between the candidate and the running
configuration.
candidate_config
The candidate configuration sent as text. This argument is ignored when
``candidate_path`` is set.
candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
running_config
The running configuration sent as text. This argument is ignored when
``running_path`` is set.
running_path
Absolute or remote path from where to load the runing configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``candidate_path`` or ``running_path`` is not a
``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.diff_tree candidate_path=salt://path/to/candidate.cfg running_path=salt://path/to/running.cfg
R4 R R7 ( R3 R; R< t
dictdiffert deep_diff( RG t candidate_patht running_configt running_pathR7 RE t running_tree( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt diff_treef s ( c C@ sC t d | d | d | � } t d | d | d | � } t | | � S( u�
Return the diff, as text, between the candidate and the running config.
candidate_config
The candidate configuration sent as text. This argument is ignored when
``candidate_path`` is set.
candidate_path
Absolute or remote path from where to load the candidate configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
running_config
The running configuration sent as text. This argument is ignored when
``running_path`` is set.
running_path
Absolute or remote path from where to load the runing configuration
text. This argument allows any URI supported by
:py:func:`cp.get_url <salt.modules.cp.get_url>`), e.g., ``salt://``,
``https://``, ``s3://``, ``ftp:/``, etc.
saltenv: ``base``
Salt fileserver environment from which to retrieve the file.
Ignored if ``candidate_path`` or ``running_path`` is not a
``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' iosconfig.diff_text candidate_path=salt://path/to/candidate.cfg running_path=salt://path/to/running.cfg
R4 R R7 ( R: R- ( RG RM RN RO R7 t candidate_textt running_text( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt diff_text� s ' ( t __doc__t
__future__R R R R% t salt.extR t salt.utils.dictupdateR; t salt.utils.dictdiffert salt.utils.odictR t salt.exceptionsR t __virtualname__t __proxyenabled__R
R R R R- R2 t NoneR3 R: RC RF RJ RQ RT ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/iosconfig.pyt <module>
s\ + & , + . -
Mini Shell