Current File : //lib/python2.7/site-packages/salt/modules/textfsm_mod.pyo
�
���^c @@ s6 d Z d d l m Z d d l Z d d l Z y d d l Z e Z Wn e k
r] e Z n Xy d d l
Z
e Z Wn e k
r� e Z n Xy d d l m
Z
Wn! e k
r� d d l m
Z
n Xe j e � Z d Z d g Z d � Z d � Z d d d d
� Z d d d d d d d d e d d d � Z d S( s�
TextFSM
=======
.. versionadded:: 2018.3.0
Execution module that processes plain text and extracts data
using TextFSM templates. The output is presented in JSON serializable
data, and can be easily re-used in other modules, or directly
inside the renderer (Jinja, Mako, Genshi, etc.).
:depends: - textfsm Python library
.. note::
For Python 2/3 compatibility, it is more recommended to
install the ``jtextfsm`` library: ``pip install jtextfsm``.
i ( t absolute_importN( t fopent textfsmt *c C@ s t r
t St d f S( sB
Only load this execution module if TextFSM is installed.
sJ The textfsm execution module failed to load: requires the textfsm library.( t HAS_TEXTFSMt __virtualname__t False( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/textfsm_mod.pyt __virtual__2 s c C@ s� g } t j d � t j | � t j d � t j | � xU | D]M } i } x1 t | � D]# \ } } | | | j | j � <qZ W| j | � qA Wt j d � t j | � | S( sD
Converts TextFSM cli_table object to list of dictionaries.
s
Cli Table:s FSM handler:s Extraction result:( t logt debugt enumeratet headert lowert append( t objectst fsm_handlert objst rowt temp_dictt indext element( ( s< /usr/lib/python2.7/site-packages/salt/modules/textfsm_mod.pyt _clitable_to_dict; s
t basec
C@ s i t d 6d d 6d d 6} t j d j | � � t j d j | � � t d | d | �} | t k r� d j | � | d <t j | d � | SyX t j d
j | � � t | d � } t j | j � � | j d � t
j | � } Wn@ t
j k
r+} t j d
d t
�d j | | � | d <| SX| r�| r�t j d j | � � t d | d | �} | t k r�d j | � | d <t j | d � | Sn | s�d | d <t j | d � | St j d � t j | � | j | � } t | | � | d <t
| d <| S( s�
Extracts the data entities from the unstructured
raw text sent as input and returns the data
mapping, processing using the TextFSM template.
template_path
The path to the TextFSM template.
This can be specified using the absolute path
to the file, or using one of the following URL schemes:
- ``salt://``, to fetch the template from the Salt fileserver.
- ``http://`` or ``https://``
- ``ftp://``
- ``s3://``
- ``swift://``
raw_text: ``None``
The unstructured text to be parsed.
raw_text_file: ``None``
Text file to read, having the raw text to be parsed using the TextFSM template.
Supports the same URL schemes as the ``template_path`` argument.
saltenv: ``base``
Salt fileserver envrionment from which to retrieve the file.
Ignored if ``template_path`` is not a ``salt://`` URL.
CLI Example:
.. code-block:: bash
salt '*' textfsm.extract salt://textfsm/juniper_version_template raw_text_file=s3://junos_ver.txt
salt '*' textfsm.extract http://some-server/textfsm/juniper_version_template raw_text='Hostname: router.abc ... snip ...'
Jinja template example:
.. code-block:: jinja
{%- set raw_text = 'Hostname: router.abc ... snip ...' -%}
{%- set textfsm_extract = salt.textfsm.extract('https://some-server/textfsm/juniper_version_template', raw_text) -%}
Raw text example:
.. code-block:: text
Hostname: router.abc
Model: mx960
JUNOS Base OS boot [9.1S3.5]
JUNOS Base OS Software Suite [9.1S3.5]
JUNOS Kernel Software Suite [9.1S3.5]
JUNOS Crypto Software Suite [9.1S3.5]
JUNOS Packet Forwarding Engine Support (M/T Common) [9.1S3.5]
JUNOS Packet Forwarding Engine Support (MX Common) [9.1S3.5]
JUNOS Online Documentation [9.1S3.5]
JUNOS Routing Software Suite [9.1S3.5]
TextFSM Example:
.. code-block:: text
Value Chassis (\S+)
Value Required Model (\S+)
Value Boot (.*)
Value Base (.*)
Value Kernel (.*)
Value Crypto (.*)
Value Documentation (.*)
Value Routing (.*)
Start
# Support multiple chassis systems.
^\S+:$$ -> Continue.Record
^${Chassis}:$$
^Model: ${Model}
^JUNOS Base OS boot \[${Boot}\]
^JUNOS Software Release \[${Base}\]
^JUNOS Base OS Software Suite \[${Base}\]
^JUNOS Kernel Software Suite \[${Kernel}\]
^JUNOS Crypto Software Suite \[${Crypto}\]
^JUNOS Online Documentation \[${Documentation}\]
^JUNOS Routing Software Suite \[${Routing}\]
Output example:
.. code-block:: json
{
"comment": "",
"result": true,
"out": [
{
"kernel": "9.1S3.5",
"documentation": "9.1S3.5",
"boot": "9.1S3.5",
"crypto": "9.1S3.5",
"chassis": "",
"routing": "9.1S3.5",
"base": "9.1S3.5",
"model": "mx960"
}
]
}
t resultt t commentt outs Using the saltenv: {}s$ Caching {} using the Salt fileservers
cp.cache_filet saltenvs+ Unable to read the TextFSM template from {}s, Reading TextFSM template from cache path: {}t ri s$ Unable to parse the TextFSM templatet exc_infosH Unable to parse the TextFSM template from {}: {}. Please check the logs.s$ Trying to read the raw input from {}s cp.get_file_strsB Unable to read from {}. Please specify a valid input file or text.s* Please specify a valid input file or text.s Processing the raw text:N( R t NoneR R t formatt __salt__t errorR t readt seekR t TextFSMt TextFSMTemplateErrort Truet ParseTextR (
t
template_patht raw_textt
raw_text_fileR t rett tpl_cached_patht tpl_file_handleR t tfteR ( ( s< /usr/lib/python2.7/site-packages/salt/modules/textfsm_mod.pyt extractN sN h
c C@ s� i d) d 6t d 6d d 6} t s@ d | d <t j | d � | S| s� t j d � pd t j d | � } | r� t j d j | � � t
j | � } | s� d j | � | d <| St j d j | � � q� d
| d <t j | d � | Sn | sCt j d � t j d � pt j d � } | sCd
| d <t j | d � | Sn t j d j | � � t j d j | � � t d | d | d | d |
d | �}
t j d � t j |
� |
s�d j | � | d <t j | d � | St
j j |
d � } t j d � pt j d d � } t
j j | | � } t j d j | � � t j d j | � � t j | | � } i | d 6} t j d � p�t j d d � } t j d j | � � | | | <t j d j | � � | r=| r=t j d! j | � � t d" | d | �} | t k r=d# j | � | d <t j | d � | Sn | sbd$ | d <t j | d � | St j d% � t j | � y1 | j | | � t | | � | d <t | d <Wn< t j k
r�} t j d& d' t �d( j | � | d <n X| S(* s�
Dynamically identify the template required to extract the
information from the unstructured raw text.
The output has the same structure as the ``extract`` execution
function, the difference being that ``index`` is capable
to identify what template to use, based on the platform
details and the ``command``.
command
The command executed on the device, to get the output.
platform
The platform name, as defined in the TextFSM index file.
.. note::
For ease of use, it is recommended to define the TextFSM
indexfile with values that can be matches using the grains.
platform_grain_name
The name of the grain used to identify the platform name
in the TextFSM index file.
.. note::
This option can be also specified in the minion configuration
file or pillar as ``textfsm_platform_grain``.
.. note::
This option is ignored when ``platform`` is specified.
platform_column_name: ``Platform``
The column name used to identify the platform,
exactly as specified in the TextFSM index file.
Default: ``Platform``.
.. note::
This is field is case sensitive, make sure
to assign the correct value to this option,
exactly as defined in the index file.
.. note::
This option can be also specified in the minion configuration
file or pillar as ``textfsm_platform_column_name``.
output
The raw output from the device, to be parsed
and extract the structured data.
output_file
The path to a file that contains the raw output from the device,
used to extract the structured data.
This option supports the usual Salt-specific schemes: ``file://``,
``salt://``, ``http://``, ``https://``, ``ftp://``, ``s3://``, ``swift://``.
textfsm_path
The path where the TextFSM templates can be found. This can be either
absolute path on the server, either specified using the following URL
schemes: ``file://``, ``salt://``, ``http://``, ``https://``, ``ftp://``,
``s3://``, ``swift://``.
.. note::
This needs to be a directory with a flat structure, having an
index file (whose name can be specified using the ``index_file`` option)
and a number of TextFSM templates.
.. note::
This option can be also specified in the minion configuration
file or pillar as ``textfsm_path``.
index_file: ``index``
The name of the TextFSM index file, under the ``textfsm_path``. Default: ``index``.
.. note::
This option can be also specified in the minion configuration
file or pillar as ``textfsm_index_file``.
saltenv: ``base``
Salt fileserver envrionment from which to retrieve the file.
Ignored if ``textfsm_path`` is not a ``salt://`` URL.
include_empty: ``False``
Include empty files under the ``textfsm_path``.
include_pat
Glob or regex to narrow down the files cached from the given path.
If matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
exclude_pat
Glob or regex to exclude certain files from being cached from the given path.
If matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
.. note::
If used with ``include_pat``, files matching this pattern will be
excluded from the subset of files defined by ``include_pat``.
CLI Example:
.. code-block:: bash
salt '*' textfsm.index 'sh ver' platform=Juniper output_file=salt://textfsm/juniper_version_example textfsm_path=salt://textfsm/
salt '*' textfsm.index 'sh ver' output_file=salt://textfsm/juniper_version_example textfsm_path=ftp://textfsm/ platform_column_name=Vendor
salt '*' textfsm.index 'sh ver' output_file=salt://textfsm/juniper_version_example textfsm_path=https://some-server/textfsm/ platform_column_name=Vendor platform_grain_name=vendor
TextFSM index file example:
``salt://textfsm/index``
.. code-block:: text
Template, Hostname, Vendor, Command
juniper_version_template, .*, Juniper, sh[[ow]] ve[[rsion]]
The usage can be simplified,
by defining (some of) the following options: ``textfsm_platform_grain``,
``textfsm_path``, ``textfsm_platform_column_name``, or ``textfsm_index_file``,
in the (proxy) minion configuration file or pillar.
Configuration example:
.. code-block:: yaml
textfsm_platform_grain: vendor
textfsm_path: salt://textfsm/
textfsm_platform_column_name: Vendor
And the CLI usage becomes as simple as:
.. code-block:: bash
salt '*' textfsm.index 'sh ver' output_file=salt://textfsm/juniper_version_example
Usgae inside a Jinja template:
.. code-block:: jinja
{%- set command = 'sh ver' -%}
{%- set output = salt.net.cli(command) -%}
{%- set textfsm_extract = salt.textfsm.index(command, output=output) -%}
R R R R s/ TextFSM doesnt seem that has clitable embedded.t textfsm_platform_grains0 Using the {} grain to identify the platform names8 Unable to identify the platform name using the {} grain.s Using platform: {}s? No platform specified, no platform grain identifier configured.sL No TextFSM templates path specified, trying to look into the opts and pillart textfsm_pathsS No TextFSM templates path specified. Please configure in opts/pillar/function args.s Using the saltenv: {}s$ Caching {} using the Salt fileservers cp.cache_dirR t
include_emptyt include_patt exclude_pats Cache fun return:sA Unable to fetch from {}. Is the TextFSM path correctly specified?i t textfsm_index_fileR s Using the cached index file: {}s" TextFSM templates cached under: {}t Commandt textfsm_platform_column_namet Platforms, Using the TextFSM platform idenfiticator: {}s: Processing the TextFSM index file using the attributes: {}s Processing the output from {}s cp.get_file_strs< Unable to read from {}. Please specify a valid file or text.s* Please specify a valid output text or files Processing the raw text:s Unable to proces the CliTableR s Unable to process the output: {}N( R R t HAS_CLITABLER R! t __opts__t gett
__pillar__R R t
__grains__t infoR t ost patht dirnamet joint clitablet CliTablet ParseCmdR R& t
CliTableError( t commandt platformt platform_grain_namet platform_column_namet outputt output_fileR1 t
index_fileR R2 R3 R4 R+ t textfsm_cachedir_rett textfsm_cachedirt index_file_patht textfsm_objt attrst cterr( ( s< /usr/lib/python2.7/site-packages/salt/modules/textfsm_mod.pyR � s� �
!
( t __doc__t
__future__R R? t loggingR R& R t ImportErrorR RC R9 t salt.utils.filesR t
salt.utilst getLoggert __name__R R t __proxyenabled__R R R R/ R ( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/textfsm_mod.pyt <module> sD
�
Mini Shell