File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/textfsm_mod.cpython-310.pyc
Back
o ;jsA � @ s� d Z ddlZddlZddlZzddlZdZW n ey! dZY nw z ddlmZ dZ W n ey7 dZ Y nw e� e �Z dZ dgZdd � Zd d � Zdd d�Z ddd�ZdS )a� 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:: Install ``textfsm`` library: ``pip install textfsm``. � NTF)�clitable�textfsm�*c C s t rtS dS )zB Only load this execution module if TextFSM is installed. )FzJThe textfsm execution module failed to load: requires the textfsm library.)� HAS_TEXTFSM�__virtualname__� r r �L/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/textfsm_mod.py� __virtual__, s r c C s^ g }t �d| |� | D ]}i }t|�D ] \}}|||j| �� < q|�|� q t �d|� |S )zD Converts TextFSM cli_table object to list of dictionaries. z Cli Table: %s; FSM handler: %szExtraction result: %s)�log�debug� enumerate�header�lower�append)�objects� fsm_handlerZobjs�rowZ temp_dict�index�elementr r r �_clitable_to_dict8 s r �basec C s� dddd�}t �d| |� td | |d�}|du r)d�| �|d < t �|d � |S z3t �d |� tjj�|d ��}|� � }t �|� |� d � t � |�}W d � n1 sVw Y W n$ t j y� } zt jd dd� d�| | �|d < |W Y d} ~ S d} ~ ww |s�|r�t �d|� td ||d�}|du r�d�|�|d < t �|d � |S |s�d|d < t �|d � |S t �d|� |�|�} t| |�|d< d|d< |S )a� 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 environment 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" } ] } F� N)�result�comment�out�1Caching %s(saltenv: %s) using the Salt fileserverz cp.cache_file��saltenvz+Unable to read the TextFSM template from {}r z,Reading TextFSM template from cache path: %s�rr z$Unable to parse the TextFSM templateT��exc_infozHUnable to parse the TextFSM template from {}: {}. Please check the logs.z$Trying to read the raw input from %s�cp.get_file_strzBUnable to read from {}. Please specify a valid input file or text.z*Please specify a valid input file or text.�Processing the raw text: %sr r )r r �__salt__�format�error�salt�utils�filesZfopen�read�seekr ZTextFSMZTextFSMTemplateErrorZ ParseTextr ) Z template_pathZraw_textZ raw_text_filer �retZtpl_cached_pathZtpl_file_handleZ tpl_file_datar Ztfter r r r �extractG sd h�� � ������ �� r, c C s� dddd�} t sd| d< t�| d � | S |sNt�d�p!t�d|�}|rAt�d|� t�|�}|s:d �|�| d< | S t� d |� n d | d< t�| d � | S |snt�d � t�d �p^t�d �}|snd| d< t�| d � | S t�d||� t d ||| | | d�} t�d| � | s�d�|�| d< t�| d � | S t j � | d �}t�d�p�t�dd�}t j �||�}t�d|� t�d|� t�||�}d| i}t�d�p�t�dd�}t� d |� |||< t�d |� |�s |�r t�d |� t d ||d �}|du �r d!�|�| d< t�| d � | S |�s d"| d< t�| d � | S t�d#|� z|�||� t||�| d$< d%| d&< W | S tj�yY } ztjd'd%d(� d)|� �| d< W Y d}~| S d}~ww )*a� 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 environment 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) -%} NFr )r r r z1TextFSM does not seem that has clitable embedded.r Ztextfsm_platform_grainz0Using the %s grain to identify the platform namez8Unable to identify the platform name using the {} grain.zUsing platform: %sz?No platform specified, no platform grain identifier configured.zLNo TextFSM templates path specified, trying to look into the opts and pillar� textfsm_pathzSNo TextFSM templates path specified. Please configure in opts/pillar/function args.r z cp.cache_dir)r � include_empty� include_pat� exclude_patzCache fun return: %szAUnable to fetch from {}. Is the TextFSM path correctly specified?r Ztextfsm_index_filer z Using the cached index file: %sz"TextFSM templates cached under: %sZCommandZ textfsm_platform_column_nameZPlatformz,Using the TextFSM platform idenfiticator: %sz:Processing the TextFSM index file using the attributes: %sz Processing the output from %sr! r z<Unable to read from {}. Please specify a valid file or text.z*Please specify a valid output text or filer" r Tr z Unable to proces the CliTabler z Unable to process the output: )� HAS_CLITABLEr r% Z__opts__�getZ __pillar__r Z __grains__r$ �infor# �os�path�dirname�joinr ZCliTableZParseCmdr Z CliTableError)Zcommand�platformZplatform_grain_nameZplatform_column_name�outputZ output_filer- Z index_filer r. r/ r0 r+ Ztextfsm_cachedir_retZtextfsm_cachedirZindex_file_pathZ textfsm_obj�attrsZcterrr r r r � s� �� ������� ��� � � �� ���r )NNr ) NNNNNNNr FNN)�__doc__�loggingr4 Zsalt.utils.filesr& r r � ImportErrorr r1 � getLogger�__name__r r Z__proxyenabled__r r r, r r r r r �<module> sF � � !�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings