File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/napalm_mod.cpython-310.pyc
Back
o ;jh� � @ sz d Z ddlZddlZddlmZ ddlmZ ddlmZ z ddl m Z dZ W n e y1 dZ Y nw zddl ZdZW n e yE dZY nw zddlZdZW n e yY dZY nw zddlZdZW n e ym dZY nw zddlZdZW n e y� dZY nw d Zd gZe�e�Zd d � Zd d� Z dd� Z dd� Z edd� �Z edd� �Z edd� �Z!edldd��Z"edd � �Z#edmd d ��Z$ed d!� �Z%ed"d#� �Z&ed$d%� �Z'ed&d'� �Z(ed(d)� �Z)ed*d+� �Z*ed,d-� �Z+ednd.d/��Z,ed0d1� �Z-edod2d3��Z.ed4d5� �Z/ednd6d7��Z0ed8d9� �Z1ed:d;� �Z2d<d=� Z3ed>d?� �Z4ed@dA� �Z5edBdC� �Z6e D EdpdFdG��Z7edqdIdJ��Z8e D EdpdKdL��Z9edrdMdN��Z:edOdP� �Z;ee�dsdRdS��Z<ee�dsdTdU��Z=ee�dsdVdW��Z>ee�dsdXdY��Z?dtdZd[�Z@ Edud\d]�ZA Edud^d_�ZB Edud`da�ZC dvdcdd�ZD dvdedf�ZEee� dwdhdi��ZFee� Edxdjdk��ZGdS )yz\ NAPALM helpers ============== Helpers for the NAPALM modules. .. versionadded:: 2017.7.0 � N)�CommandExecutionError)�depends)�proxy_napalm_wrap)�BaseConnectionTF�napalm�*c C s t jj�ttt�S )z_ NAPALM library must be installed for this module to work and run in a (proxy) minion. )�salt�utilsr Zvirtual�__opts__�__virtualname__�__file__� r r �K/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/napalm_mod.py� __virtual__C s r c C s� t r tjj�| �S td tj�\}}}}|�d�}|dkr!t d��t t ||��}g d�}|D ]}|�|� q.i }|� � D ]\}} z| | ||< W q< t yQ Y q<w |S )a� Check for Netmiko arguments that were passed in as NAPALM optional arguments. Return a dictionary of these optional args that will be passed into the Netmiko ConnectHandler call. .. note:: This is a port of the NAPALM helper for backwards compatibility with older versions of NAPALM, and stability across Salt features. If the netmiko helpers module is available however, it will prefer that implementation nevertheless. zargs.get_function_argspecr �selfz"Error processing Netmiko arguments)�ip�host�username�password� device_type�timeout)�HAS_NETMIKO_HELPERSr �baseZnetmiko_helpers� netmiko_argsZ __utils__r �__init__�pop� ValueError�dict�zip�items�KeyError) � optional_argsr �_Znetmiko_defaultsZ check_selfZnetmiko_argument_mapZnetmiko_filter�kZnetmiko_optional_args�vr r r �_get_netmiko_argsO s( � �r% c s � fdd�}|t d< dS )zw Inject the junos.conn key into the __proxy__, reusing the existing NAPALM connection to the Junos device. c s � d j S )N�DRIVER)�devicer �� napalm_devicer r � _ret_device s z(_inject_junos_proxy.<locals>._ret_devicez junos.connN)Z __proxy__)r) r* r r( r �_inject_junos_proxyy s r+ c C s8 t d dkr dddd�S tsdddd�S t| � dd iS ) z% Prepare the Junos function. �os�junosNFz(This function is only available on Junos��out�result�commentzSPlease install jxmlease (``pip install jxmlease``) to be able to use this function.r0 T)� __grains__� HAS_JXMLEASEr+ r( r r r �_junos_prep_fun� s ��r4 c K s" t � }| �|� td di | ��S )�� .. versionadded:: 2019.2.0 Return the connection object with the network device, over Netmiko, passing the authentication details from the existing NAPALM connection. .. warning:: This function is not suitable for CLI usage, more rather to be used in various Salt modules. USAGE Example: .. code-block:: python conn = __salt__['napalm.netmiko_conn']() res = conn.send_command('show interfaces') conn.disconnect() znetmiko.get_connectionNr �r �update�__salt__)�kwargs�netmiko_kwargsr r r � _netmiko_conn� � r; c K s t di | ��}td di |��S )�d .. versionadded:: 2019.2.0 Return the connection object with the Arista switch, over ``pyeapi``, passing the authentication details from the existing NAPALM connection. .. warning:: This function is not suitable for CLI usage, more rather to be used in various Salt modules, to reusing the established connection, as in opposite to opening a new connection for each task. Usage example: .. code-block:: python conn = __salt__['napalm.pyeapi_conn']() res1 = conn.run_commands('show version') res2 = conn.get_config(as_string=True) zpyeapi.get_connectionNr ��pyeapi_nxos_api_argsr8 )r9 � pyeapi_kwargsr r r � _pyeapi_conn� s rA c K s t jjjtdfi i ��S )ad Returns the alive status of the connection layer. The output is a dictionary under the usual dictionary output of the NAPALM modules. CLI Example: .. code-block:: bash salt '*' napalm.alive Output Example: .. code-block:: yaml result: True out: is_alive: False comment: '' �is_alive)r r r �callr) �r9 r r r �alive� s ��rE c K s� dddd�}t jj�t�s|S t� }t�d� t�|� |�dd�r4|�dd�r4|�di ��d d�r4| rkt�d �p=t�d �}t� d |� t jjj t d fi i �� t� d|� t jjj t dfi i �� |� ddi� |S |S )a� Reconnect the NAPALM proxy when the connection is dropped by the network device. The connection can be forced to be restarted using the ``force`` argument. .. note:: This function can be used only when running proxy minions. CLI Example: .. code-block:: bash salt '*' napalm.reconnect salt '*' napalm.reconnect force=True NTzAlready alive.r. zIs alive fetch:r0 Fr/ rB �proxyid�idz+Closing the NAPALM proxy connection with %s�closez.Re-opening the NAPALM proxy connection with %s�openr1 zConnection restarted!) r r r Zis_proxyr rE �log�debug�get�inforC r) r7 )�forcer9 Z default_retrB rF r r r � reconnect� s< � ��� �� ��rO c O sF i }|� � D ] \}}|�d�s|||< qtjjjt| g|�R i |��S )a� Execute arbitrary methods from the NAPALM library. To see the expected output, please consult the NAPALM documentation. .. note:: This feature is not recommended to be used in production. It should be used for testing only! CLI Example: .. code-block:: bash salt '*' napalm.call get_lldp_neighbors salt '*' napalm.call get_firewall_policies salt '*' napalm.call get_bgp_config group='my-group' Z__pub_)r � startswithr r r rC r) )�method�argsr9 Z clean_kwargsZkargZwargr r r rC ) s ����rC � jinja|yamlc K s. t d d| ||d�|��}tjjjtd|d�S )a Return the compliance report. filepath The absolute path to the validation file. .. versionchanged:: 2019.2.0 Beginning with release codename ``2019.2.0``, this function has been enhanced, to be able to leverage the multi-engine template rendering of Salt, besides the possibility to retrieve the file source from remote systems, the URL schemes supported being: - ``salt://`` - ``http://`` and ``https://`` - ``ftp://`` - ``s3://`` - ``swift:/`` Or on the local file system (on the Minion). .. note:: The rendering result does not necessarily need to be YAML, instead it can be any format interpreted by Salt's rendering pipeline (including pure Python). string .. versionadded:: 2019.2.0 The compliance report send as inline string, to be used as the file to send through the renderer system. Note, not all renderer modules can work with strings; the 'py' renderer requires a file, for example. renderer: ``jinja|yaml`` .. versionadded:: 2019.2.0 The renderer pipe to send the file through; this is overridden by a "she-bang" at the top of the file. kwargs .. versionchanged:: 2019.2.0 Keyword args to pass to Salt's compile_template() function. CLI Example: .. code-block:: bash salt '*' napalm.compliance_report ~/validate.yml salt '*' napalm.compliance_report salt://path/to/validator.sls Validation File Example (pure YAML): .. code-block:: yaml - get_facts: os_version: 4.17 - get_interfaces_ip: Management1: ipv4: 10.0.2.14: prefix_length: 24 _mode: strict Validation File Example (as Jinja + YAML): .. code-block:: yaml - get_facts: os_version: {{ grains.version }} - get_interfaces_ip: Loopback0: ipv4: {{ grains.lo0.ipv4 }}: prefix_length: 24 _mode: strict - get_bgp_neighbors: {{ pillar.bgp.neighbors }} Output Example: .. code-block:: yaml device1: ---------- comment: out: ---------- complies: False get_facts: ---------- complies: False extra: missing: present: ---------- os_version: ---------- actual_value: 15.1F6-S1.4 complies: False nested: False get_interfaces_ip: ---------- complies: False extra: missing: - Management1 present: ---------- skipped: result: True zslsutil.renderer)�path�stringZdefault_renderer�compliance_report)Zvalidation_sourceNr )r8 r r r rC r) )�filepathrU Zrendererr9 Zvalidation_stringr r r rV I s z���rV c K s� t std��i } tjjjttd�}|d }t|�}|d | d< |d | d< |d | d < |d | d < | � |� d d dddddddddddd� }|� td di �� |t d | d < | S ) a� .. versionadded:: 2019.2.0 Return the key-value arguments used for the authentication arguments for the netmiko module. When running in a non-native NAPALM driver (e.g., ``panos``, `f5``, ``mos`` - either from https://github.com/napalm-automation-community or defined in user's own environment, one can specify the Netmiko device type (the ``device_type`` argument) via the ``netmiko_device_type_map`` configuration option / Pillar key, e.g., .. code-block:: yaml netmiko_device_type_map: f5: f5_ltm dellos10: dell_os10 The configuration above defines the mapping between the NAPALM ``os`` Grain and the Netmiko ``device_type``, e.g., when the NAPALM Grain is ``f5``, it would use the ``f5_ltm`` SSH Netmiko driver to execute commands over SSH on the remote network device. CLI Example: .. code-block:: bash salt '*' napalm.netmiko_args z6Please install netmiko to be able to use this feature.�Zsalt_obj� OPTIONAL_ARGS�HOSTNAMEr �USERNAMEr �PASSWORDr �TIMEOUTr Z juniper_junosZ cisco_iosZcisco_xrZ arista_eosZ cisco_nxosZ cisco_asaZfortinetZpaloalto_panosZ alcatel_aos�vyosZf5_ltmZhuaweiZ cisco_s300) r- ZiosZiosxr�eosZnxos_sshZasaZfortiosZpanosZaosr^ Zf5ZceZs350� config.get�netmiko_device_type_mapr, r ) � HAS_NETMIKOr r r r �get_device_optsr r8 r% r7 r2 )r9 � napalm_optsr! r ra r r r r � s@ � � �r c O s4 d| vr d| � �} t � }|�|� t| |i |��S )av .. versionadded:: 2019.2.0 Call an arbitrary function from the :mod:`Netmiko<salt.modules.netmiko_mod>` module, passing the authentication details from the existing NAPALM connection. fun The name of the function from the :mod:`Netmiko<salt.modules.netmiko_mod>` to invoke. args List of arguments to send to the execution function specified in ``fun``. kwargs Key-value arguments to send to the execution function specified in ``fun``. CLI Example: .. code-block:: bash salt '*' napalm.netmiko_fun send_command 'show version' znetmiko.r6 )�funrR r9 r: r r r � netmiko_fun s rf c O s* t � }|�|� td | g|�R i |��S )a .. versionadded:: 2019.2.0 Execute an arbitrary Netmiko method, passing the authentication details from the existing NAPALM connection. method The name of the Netmiko method to execute. args List of arguments to send to the Netmiko method specified in ``method``. kwargs Key-value arguments to send to the execution function specified in ``method``. CLI Example: .. code-block:: bash salt '*' napalm.netmiko_call send_command 'show version' z netmiko.callr6 )rQ rR r9 r: r r r � netmiko_call: s rg c O s" t � }|�|� td | i |��S )a{ .. versionadded:: 2019.2.0 Execute a list of arbitrary Netmiko methods, passing the authentication details from the existing NAPALM connection. methods List of dictionaries with the following keys: - ``name``: the name of the Netmiko function to invoke. - ``args``: list of arguments to send to the ``name`` method. - ``kwargs``: key-value arguments to send to the ``name`` method. CLI Example: .. code-block:: bash salt '*' napalm.netmiko_multi_call "{'name': 'send_command', 'args': ['show version']}" "{'name': 'send_command', 'args': ['show interfaces']}" znetmiko.multi_callr6 )�methodsr9 r: r r r �netmiko_multi_callW r< ri c O s0 t di |��}g }| D ] }|�|�|�� q |S )a .. versionadded:: 2019.2.0 Invoke one or more commands to be executed on the remote device, via Netmiko. Returns a list of strings, with the output from each command. commands A list of commands to be executed. expect_string Regular expression pattern to use for determining end of output. If left blank will default to being based on router prompt. delay_factor: ``1`` Multiplying factor used to adjust delays (default: ``1``). max_loops: ``500`` Controls wait time in conjunction with delay_factor. Will default to be based upon self.timeout. auto_find_prompt: ``True`` Whether it should try to auto-detect the prompt (default: ``True``). strip_prompt: ``True`` Remove the trailing router prompt from the output (default: ``True``). strip_command: ``True`` Remove the echo of the command from the output (default: ``True``). normalize: ``True`` Ensure the proper enter is sent at end of command (default: ``True``). use_textfsm: ``False`` Process command output through TextFSM template (default: ``False``). CLI Example: .. code-block:: bash salt '*' napalm.netmiko_commands 'show version' 'show interfaces' Nr )r; �appendZ send_command)�commandsr9 �conn�ret�cmdr r r �netmiko_commandsq s +ro c O s& t � }|�|� td dd| i|��S )a� .. versionadded:: 2019.2.0 Load a list of configuration commands on the remote device, via Netmiko. .. warning:: Please remember that ``netmiko`` does not have any rollback safeguards and any configuration change will be directly loaded into the running config if the platform doesn't have the concept of ``candidate`` config. On Junos, or other platforms that have this capability, the changes will not be loaded into the running config, and the user must set the ``commit`` argument to ``True`` to transfer the changes from the candidate into the running config before exiting. config_commands A list of configuration commands to be loaded on the remote device. config_file Read the configuration commands from a file. The file can equally be a template that can be rendered using the engine of choice (see ``template_engine``). This can be specified using the absolute path to the file, or using one of the following URL schemes: - ``salt://``, to fetch the file from the Salt fileserver. - ``http://`` or ``https://`` - ``ftp://`` - ``s3://`` - ``swift://`` exit_config_mode: ``True`` Determines whether or not to exit config mode after complete. delay_factor: ``1`` Factor to adjust delays. max_loops: ``150`` Controls wait time in conjunction with delay_factor (default: ``150``). strip_prompt: ``False`` Determines whether or not to strip the prompt (default: ``False``). strip_command: ``False`` Determines whether or not to strip the command (default: ``False``). config_mode_command The command to enter into config mode. commit: ``False`` Commit the configuration changes before exiting the config mode. This option is by default disabled, as many platforms don't have this capability natively. CLI Example: .. code-block:: bash salt '*' napalm.netmiko_config 'set system ntp peer 1.2.3.4' commit=True salt '*' napalm.netmiko_config https://bit.ly/2sgljCB znetmiko.send_config�config_commandsNr r6 )rp r9 r: r r r �netmiko_config� s A rq c K � t jj�dd� tdi | ��S )r5 �Chlorinez�This 'napalm_mod.netmiko_conn' function as been deprecated and will be removed in the {version} release, as such, it has been made an internal function since it is not suitable for CLI usageNr )r r �versions� warn_untilr; rD r r r � netmiko_conn� � �rv c K sj t t�}|d s |S |sd}td d | ||d�|��}|�dd�|d< |�dd �|d< |�d d �|d< |S ) a� .. versionadded:: 2019.2.0 Execute an RPC request on the remote Junos device. cmd The RPC request to the executed. To determine the RPC request, you can check the from the command line of the device, by executing the usual command followed by ``| display xml rpc``, e.g., ``show lldp neighbors | display xml rpc``. dest Destination file where the RPC output is stored. Note that the file will be stored on the Proxy Minion. To push the files to the Master, use :mod:`cp.push <salt.modules.cp.push>` Execution function. format: ``xml`` The format in which the RPC reply is received from the device. dev_timeout: ``30`` The NETCONF RPC timeout. filter Used with the ``get-config`` RPC request to filter out the config tree. terse: ``False`` Whether to return terse output. .. note:: Some RPC requests may not support this argument. interface_name Name of the interface to query. CLI Example: .. code-block:: bash salt '*' napalm.junos_rpc get-lldp-neighbors-information salt '*' napalm.junos_rpc get-config <configuration><system><ntp/></system></configuration> r0 Zxmlz junos.rpc)rn �dest�format�message� r1 r/ FZ rpc_replyNr )r4 r) r8 r )rn rx ry r9 �prepZrpc_retr r r � junos_rpc s ,r} c K s& t t�}|d s |S td di | ��S )a� .. versionadded:: 2019.2.0 Commit the changes loaded in the candidate configuration. dev_timeout: ``30`` The NETCONF RPC timeout (in seconds). comment Provide a comment for the commit. confirm Provide time in minutes for commit confirmation. If this option is specified, the commit will be rolled back in the specified amount of time unless the commit is confirmed. sync: ``False`` When ``True``, on dual control plane systems, requests that the candidate configuration on one control plane be copied to the other control plane, checked for correct syntax, and committed on both Routing Engines. force_sync: ``False`` When ``True``, on dual control plane systems, force the candidate configuration on one control plane to be copied to the other control plane. full When ``True``, requires all the daemons to check and evaluate the new configuration. detail When ``True``, return commit detail. CLI Examples: .. code-block:: bash salt '*' napalm.junos_commit comment='Commitiing via Salt' detail=True salt '*' napalm.junos_commit dev_timeout=60 confirm=10 salt '*' napalm.junos_commit sync=True dev_timeout=90 r0 z junos.commitNr �r4 r) r8 )r9 r| r r r � junos_commit@ s +r c K s* t t�}|d s |S td dd| i|��S )a .. versionadded:: 2019.2.0 Installs the given image on the device. path The image file source. This argument supports the following URIs: - Absolute path on the Minion. - ``salt://`` to fetch from the Salt fileserver. - ``http://`` and ``https://`` - ``ftp://`` - ``swift:/`` - ``s3://`` dev_timeout: ``30`` The NETCONF RPC timeout (in seconds) reboot: ``False`` Whether to reboot the device after the installation is complete. no_copy: ``False`` If ``True`` the software package will not be copied to the remote device. CLI Example: .. code-block:: bash salt '*' napalm.junos_install_os salt://images/junos_16_1.tgz reboot=True r0 zjunos.install_osrT Nr r~ )rT r9 r| r r r �junos_install_osq s !r� c K sv t t�}|d s |S ttd jj�}d|v r t|d �|d< d|v r9|d D ]}t|d | d �|d | d< q&|S )z� .. versionadded:: 2019.2.0 The complete list of Junos facts collected by ``junos-eznc``. CLI Example: .. code-block:: bash salt '*' napalm.junos_facts r0 r& � version_infoZ junos_info�object)r4 r) r r' �facts)r9 r| r� �rer r r � junos_facts� s "r� c K s0 t t�}|d s |S td | f|||d�|��S )a� .. versionadded:: 2019.2.0 Execute a CLI command and return the output in the specified format. command The command to execute on the Junos CLI. format: ``text`` Format in which to get the CLI output (either ``text`` or ``xml``). dev_timeout: ``30`` The NETCONF RPC timeout (in seconds). dest Destination file where the RPC output is stored. Note that the file will be stored on the Proxy Minion. To push the files to the Master, use :mod:`cp.push <salt.modules.cp.push>`. CLI Example: .. code-block:: bash salt '*' napalm.junos_cli 'show lldp neighbors' r0 z junos.cli)ry � dev_timeoutrx r~ )�commandry r� rx r9 r| r r r � junos_cli� s ���r� c K s. t t�}|d s |S td | �}td ||�S )a� .. versionadded:: 2019.2.0 Copies the file on the remote Junos device. src The source file path. This argument accepts the usual Salt URIs (e.g., ``salt://``, ``http://``, ``https://``, ``s3://``, ``ftp://``, etc.). dst The destination path on the device where to copy the file. CLI Example: .. code-block:: bash salt '*' napalm.junos_copy_file https://example.com/junos.cfg /var/tmp/myjunos.cfg r0 z cp.cache_filezjunos.file_copyr~ )�src�dstr9 r| Z cached_srcr r r �junos_copy_file� s r� c O sX t t�}|d s |S d| vrd| � �}n| }|tvr#dd| � d�d�S t| |i |��S )ad .. versionadded:: 2019.2.0 Execute an arbitrary function from the :mod:`junos execution module <salt.module.junos>`. To check what ``args`` and ``kwargs`` you must send to the function, please consult the appropriate documentation. fun The name of the function. E.g., ``set_hostname``. args List of arguments to send to the ``junos`` function invoked. kwargs Dictionary of key-value arguments to send to the ``juno`` function invoked. CLI Example: .. code-block:: bash salt '*' napalm.junos_fun cli 'show system commit' r0 zjunos.NFz is not a valid functionr. r~ )re rR r9 r| Zmod_funr r r � junos_call� s �r� c K s� i }t jjjttd�}|d }|d |d< |d |d< |d |d< |d |d < d |v r6|d r6|d |d < nd |d < d |v rI|d rI|d |d < n |d dkrQdnd|d < |�d�|d< | �|� | S )a .. versionadded:: 2019.2.0 Return the key-value arguments used for the authentication arguments for the :mod:`pyeapi execution module <salt.module.arista_pyeapi>`. CLI Example: .. code-block:: bash salt '*' napalm.pyeapi_nxos_api_args rX rY rZ r r[ r r\ r r] r Z transport�https�port�http�P i� Zverify)r r r rc r r8 rL r7 )Z prev_kwargsr9 rd r! r r r r? s r? c O s t di |��}td | i |��S )a{ Execute a list of commands on the Arista switch, via the ``pyeapi`` library. This function forwards the existing connection details to the :mod:`pyeapi.run_commands <salt.module.arista_pyeapi.run_commands>` execution function. commands A list of commands to execute. encoding: ``json`` The requested encoding of the command output. Valid values for encoding are ``json`` (default) or ``text``. CLI Example: .. code-block:: bash salt '*' napalm.pyeapi_run_commands 'show version' encoding=text salt '*' napalm.pyeapi_run_commands 'show ip bgp neighbors' zpyeapi.run_commandsNr r> )rk r9 r@ r r r �pyeapi_run_commandsA s r� c O s( t di |��}td | g|�R i |��S )aG .. versionadded:: 2019.2.0 Invoke an arbitrary method from the ``pyeapi`` library. This function forwards the existing connection details to the :mod:`pyeapi.run_commands <salt.module.arista_pyeapi.run_commands>` execution function. method The name of the ``pyeapi`` method to invoke. kwargs Key-value arguments to send to the ``pyeapi`` method. CLI Example: .. code-block:: bash salt '*' napalm.pyeapi_call run_commands 'show version' encoding=text salt '*' napalm.pyeapi_call get_config as_string=True z pyeapi.callNr r> )rQ rR r9 r@ r r r � pyeapi_call[ s r� c K rr )r= rs z�This 'napalm_mod.pyeapi_conn' function as been deprecated and will be removed in the {version} release, as such, it has been made an internal function since it is not suitable for CLI usageNr )r r rt ru rA rD r r r � pyeapi_connv rw r� �jinjar c K �. t di |��}td d| |||||d�|��S )a� .. versionadded:: 2019.2.0 Configures the Arista switch with the specified commands, via the ``pyeapi`` library. This function forwards the existing connection details to the :mod:`pyeapi.run_commands <salt.module.arista_pyeapi.run_commands>` execution function. commands The list of configuration commands to load on the Arista switch. .. note:: This argument is ignored when ``config_file`` is specified. config_file The source file with the configuration commands to be sent to the device. The file can also be a template that can be rendered using the template engine of choice. This can be specified using the absolute path to the file, or using one of the following URL schemes: - ``salt://`` - ``https://`` - ``ftp:/`` - ``s3:/`` - ``swift://`` template_engine: ``jinja`` The template engine to use when rendering the source file. Default: ``jinja``. To simply fetch the file without attempting to render, set this argument to ``None``. context: ``None`` Variables to add to the template context. defaults: ``None`` Default values of the ``context`` dict. saltenv: ``base`` Salt fileserver environment from which to retrieve the file. Ignored if ``config_file`` is not a ``salt://`` URL. CLI Example: .. code-block:: bash salt '*' napalm.pyeapi_config 'ntp server 1.2.3.4' z pyeapi.config�rk � config_file�template_engine�context�defaults�saltenvNr r> )rk r� r� r� r� r� r9 r@ r r r � pyeapi_config� s :��r� �clic K �& t di |��}td | fd|i|��S )a� .. versionadded:: 2019.2.0 Execute an arbitrary RPC request via the Nexus API. commands The RPC commands to be executed. method: ``cli`` The type of the response, i.e., raw text (``cli_ascii``) or structured document (``cli``). Defaults to ``cli`` (structured data). CLI Example: .. code-block:: bash salt '*' napalm.nxos_api_rpc 'show version' z nxos_api.rpcrQ Nr r> )rk rQ r9 �nxos_api_kwargsr r r � nxos_api_rpc� � r� c K r� )a� .. versionadded:: 2019.2.0 Configures the Nexus switch with the specified commands, via the NX-API. commands The list of configuration commands to load on the Nexus switch. .. note:: This argument is ignored when ``config_file`` is specified. config_file The source file with the configuration commands to be sent to the device. The file can also be a template that can be rendered using the template engine of choice. This can be specified using the absolute path to the file, or using one of the following URL schemes: - ``salt://`` - ``https://`` - ``ftp:/`` - ``s3:/`` - ``swift://`` template_engine: ``jinja`` The template engine to use when rendering the source file. Default: ``jinja``. To simply fetch the file without attempting to render, set this argument to ``None``. context: ``None`` Variables to add to the template context. defaults: ``None`` Default values of the ``context`` dict. saltenv: ``base`` Salt fileserver environment from which to retrieve the file. Ignored if ``config_file`` is not a ``salt://`` URL. CLI Example: .. code-block:: bash salt '*' napalm.nxos_api_config 'spanning-tree mode mstp' salt '*' napalm.nxos_api_config config_file=https://bit.ly/2LGLcDy context="{'servers': ['1.2.3.4']}" znxos_api.configr� Nr r> )rk r� r� r� r� r� r9 r� r r r �nxos_api_config� s 8��r� c K r� )a� .. versionadded:: 2019.2.0 Execute one or more show (non-configuration) commands. commands The commands to be executed. raw_text: ``True`` Whether to return raw text or structured data. CLI Example: .. code-block:: bash salt '*' napalm.nxos_api_show 'show version' salt '*' napalm.nxos_api_show 'show bgp sessions' 'show processes' raw_text=False z nxos_api.show�raw_textNr r> )rk r� r9 r� r r r � nxos_api_show6 r� r� c K sH dddd�}t d di �}|�|� |�td d�}t | | fi |��S ) a� .. versionadded:: 2019.2.0 This is a wrapper to execute RPC requests on various network operating systems supported by NAPALM, invoking the following functions for the NAPALM native drivers: - :py:func:`napalm.junos_rpc <salt.modules.napalm_mod.junos_rpc>` for ``junos`` - :py:func:`napalm.pyeapi_run_commands <salt.modules.napalm_mod.pyeapi_run_commands>` for ``eos`` - :py:func:`napalm.nxos_api_rpc <salt.modules.napalm_mod.nxos_api_rpc>` for ``nxos`` - :py:func:`napalm.netmiko_commands <salt.modules.napalm_mod.netmiko_commands>` for ``ios``, ``iosxr``, and ``nxos_ssh`` command The RPC command to execute. This depends on the nature of the operating system. kwargs Key-value arguments to be sent to the underlying Execution function. The function capabilities are extensible in the user environment via the ``napalm_rpc_map`` configuration option / Pillar, e.g., .. code-block:: yaml napalm_rpc_map: f5: napalm.netmiko_commands panos: panos.call The mapping above reads: when the NAPALM ``os`` Grain is ``f5``, then call ``napalm.netmiko_commands`` for RPC requests. By default, if the user does not specify any map, non-native NAPALM drivers will invoke the ``napalm.netmiko_commands`` Execution function. CLI Example: .. code-block:: bash salt '*' napalm.rpc 'show version' salt '*' napalm.rpc get-interfaces znapalm.junos_rpcznapalm.pyeapi_run_commandsznapalm.nxos_api_rpc)r- r_ Znxosr` Znapalm_rpc_mapr, znapalm.netmiko_commands)r8 r7 rL r2 )r� r9 Z default_mapZ napalm_mapre r r r �rpcN s /� r� �runningc C s& t d |d�d | }t d || d�S )aK .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``regex`` argument. The configuration is read from the network device interrogated. regex The regular expression to match the configuration lines against. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. CLI Example: .. code-block:: bash salt '*' napalm.config_find_lines '^interface Ethernet1\d' � net.config��sourcer/ zciscoconfparse.find_lines)�config�regex�r8 )r� r� � config_txtr r r �config_find_lines� s r� c C �( t d |d�d | }t d || |d�S )ar .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``parent_regex`` argument, having child lines matching ``child_regex``. The configuration is read from the network device interrogated. .. note:: This function is only available only when the underlying library `ciscoconfparse <http://www.pennington.net/py/ciscoconfparse/index.html>`_ is installed. See :py:func:`ciscoconfparse module <salt.modules.ciscoconfparse_mod>` for more details. parent_regex The regular expression to match the parent configuration lines against. child_regex The regular expression to match the child configuration lines against. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. CLI Example: .. code-block:: bash salt '*' napalm.config_lines_w_child '^interface' 'ip address' salt '*' napalm.config_lines_w_child '^interface' 'shutdown' source=candidate r� r� r/ z!ciscoconfparse.find_lines_w_child�r� � parent_regex� child_regexr� �r� r� r� r� r r r �config_lines_w_child� s !�r� c C r� )a� .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``parent_regex`` argument, having the child lines *not* matching ``child_regex``. The configuration is read from the network device interrogated. .. note:: This function is only available only when the underlying library `ciscoconfparse <http://www.pennington.net/py/ciscoconfparse/index.html>`_ is installed. See :py:func:`ciscoconfparse module <salt.modules.ciscoconfparse_mod>` for more details. parent_regex The regular expression to match the parent configuration lines against. child_regex The regular expression to match the child configuration lines against. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. CLI Example: .. code-block:: bash salt '*' napalm.config_lines_wo_child '^interface' 'ip address' salt '*' napalm.config_lines_wo_child '^interface' 'shutdown' source=candidate r� r� r/ z"ciscoconfparse.find_lines_wo_childr� r� r� r r r �config_lines_wo_child� s "�r� c C r� )a� .. versionadded:: 2019.2.0 Return a list of detailed matches, for the configuration blocks (parent-child relationship) whose parent respects the regular expressions configured via the ``parent_regex`` argument, and the child matches the ``child_regex`` regular expression. The result is a list of dictionaries with the following keys: - ``match``: a boolean value that tells whether ``child_regex`` matched any children lines. - ``parent``: the parent line (as text). - ``child``: the child line (as text). If no child line matched, this field will be ``None``. .. note:: This function is only available only when the underlying library `ciscoconfparse <http://www.pennington.net/py/ciscoconfparse/index.html>`_ is installed. See :py:func:`ciscoconfparse module <salt.modules.ciscoconfparse_mod>` for more details. parent_regex The regular expression to match the parent configuration lines against. child_regex The regular expression to match the child configuration lines against. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. CLI Example: .. code-block:: bash salt '*' napalm.config_filter_lines '^interface' 'ip address' salt '*' napalm.config_filter_lines '^interface' 'shutdown' source=candidate r� r� r/ zciscoconfparse.filter_linesr� r� r� r r r �config_filter_lines� s )�r� c C s$ t d | d�d | }t d |d�S )ag .. versionadded:: 2019.2.0 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. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. with_tags: ``False`` Whether this function should return a detailed view, with tags. CLI Example: .. code-block:: bash salt '*' napalm.config_tree r� r� r/ ziosconfig.tree)r� r� )r� Z with_tagsr� r r r � config_tree s r� c C �* t d | d�d | }t d ||||d�S )a .. versionadded:: 2019.2.0 Return the merge tree of the ``initial_config`` with the ``merge_config``, as a Python dictionary. source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. 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 ``merge_path`` is not a ``salt://`` URL. CLI Example: .. code-block:: bash salt '*' napalm.config_merge_tree merge_path=salt://path/to/merge.cfg r� r� r/ ziosconfig.merge_tree�Zinitial_config� merge_config� merge_pathr� r� �r� r� r� r� r� r r r �config_merge_tree8 � !�r� c C r� )a7 .. versionadded:: 2019.2.0 Return the merge result of the configuration from ``source`` with the merge configuration, as plain text (without loading the config on the device). source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. 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 ``merge_path`` is not a ``salt://`` URL. CLI Example: .. code-block:: bash salt '*' napalm.config_merge_text merge_path=salt://path/to/merge.cfg r� r� r/ ziosconfig.merge_textr� r� r� r r r �config_merge_textb s "�r� c C r� )a1 .. versionadded:: 2019.2.0 Return the merge diff, as text, after merging the merge config into the configuration source requested (without loading the config on the device). source: ``running`` The configuration type to retrieve from the network device. Default: ``running``. Available options: ``running``, ``startup``, ``candidate``. 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 ``merge_path`` is not a ``salt://`` URL. CLI Example: .. code-block:: bash salt '*' napalm.config_merge_diff merge_path=salt://path/to/merge.cfg r� r� r/ ziosconfig.merge_diffr� r� r� r r r �config_merge_diff� r� r� � candidatec C �2 t d � d }|| }|| }t d ||||d�S )a .. versionadded:: 2019.2.0 Return the diff, as Python dictionary, between two different sources. The sources can be either specified using the ``source1`` and ``source2`` arguments when retrieving from the managed network device. source1: ``candidate`` The source from where to retrieve the configuration to be compared with. Available options: ``candidate``, ``running``, ``startup``. Default: ``candidate``. 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. source2: ``running`` The source from where to retrieve the configuration to compare with. Available options: ``candidate``, ``running``, ``startup``. Default: ``running``. running_path Absolute or remote path from where to load the running 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 '*' napalm.config_diff_text salt '*' napalm.config_diff_text candidate_path=https://bit.ly/2mAdq7z # Would compare the running config with the configuration available at # https://bit.ly/2mAdq7z CLI Example: .. code-block:: bash salt '*' napalm.config_diff_tree salt '*' napalm.config_diff_tree running startup r� r/ ziosconfig.diff_tree�Zcandidate_config�candidate_pathZrunning_config� running_pathr� �Zsource1r� Zsource2r� Z get_configZ candidate_cfgZ running_cfgr r r �config_diff_tree� s 5�r� c C r� )a� .. versionadded:: 2019.2.0 Return the diff, as text, between the two different configuration sources. The sources can be either specified using the ``source1`` and ``source2`` arguments when retrieving from the managed network device. source1: ``candidate`` The source from where to retrieve the configuration to be compared with. Available options: ``candidate``, ``running``, ``startup``. Default: ``candidate``. 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. source2: ``running`` The source from where to retrieve the configuration to compare with. Available options: ``candidate``, ``running``, ``startup``. Default: ``running``. running_path Absolute or remote path from where to load the running 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 '*' napalm.config_diff_text salt '*' napalm.config_diff_text candidate_path=https://bit.ly/2mAdq7z # Would compare the running config with the configuration available at # https://bit.ly/2mAdq7z r� r/ ziosconfig.diff_textr� r� r� r r r �config_diff_text� s .�r� r{ c K s@ t di |��}|d |d< |�|� td | f|||d�|��S )a[ .. versionadded:: 2019.2.0 Transfer files and directories from remote network device to the localhost of the Minion. .. note:: This function is only available only when the underlying library `scp <https://github.com/jbardin/scp.py>`_ is installed. See :mod:`scp module <salt.modules.scp_mod>` for more details. remote_path Path to retrieve from remote host. Since this is evaluated by scp on the remote host, shell wildcards and environment variables may be used. recursive: ``False`` Transfer files and directories recursively. preserve_times: ``False`` Preserve ``mtime`` and ``atime`` of transferred files and directories. passphrase Used for decrypting private keys. pkey An optional private key to use for authentication. key_filename The filename, or list of filenames, of optional private key(s) and/or certificates to try for authentication. timeout An optional timeout (in seconds) for the TCP connect. socket_timeout: ``10`` The channel socket timeout in seconds. buff_size: ``16384`` The size of the SCP send buffer. allow_agent: ``True`` Set to ``False`` to disable connecting to the SSH agent. look_for_keys: ``True`` Set to ``False`` to disable searching for discoverable private key files in ``~/.ssh/`` banner_timeout An optional timeout (in seconds) to wait for the SSH banner to be presented. auth_timeout An optional timeout (in seconds) to wait for an authentication response. auto_add_policy: ``False`` Automatically add the host to the ``known_hosts``. CLI Example: .. code-block:: bash salt '*' napalm.scp_get /var/tmp/file /tmp/file auto_add_policy=True r �hostnamezscp.get)� local_path� recursive�preserve_timesNr r6 )� remote_pathr� r� r� r9 � conn_argsr r r �scp_get0 s F ���r� c K sB t di |��}|d |d< |�|� td | f||||d�|��S )a� .. versionadded:: 2019.2.0 Transfer files and directories to remote network device. .. note:: This function is only available only when the underlying library `scp <https://github.com/jbardin/scp.py>`_ is installed. See :mod:`scp module <salt.modules.scp_mod>` for more details. files A single path or a list of paths to be transferred. remote_path The path on the remote device where to store the files. recursive: ``True`` Transfer files and directories recursively. preserve_times: ``False`` Preserve ``mtime`` and ``atime`` of transferred files and directories. saltenv: ``base`` The name of the Salt environment. Ignored when ``files`` is not a ``salt://`` URL. hostname The hostname of the remote device. port: ``22`` The port of the remote device. username The username required for SSH authentication on the device. password Used for password authentication. It is also used for private key decryption if ``passphrase`` is not given. passphrase Used for decrypting private keys. pkey An optional private key to use for authentication. key_filename The filename, or list of filenames, of optional private key(s) and/or certificates to try for authentication. timeout An optional timeout (in seconds) for the TCP connect. socket_timeout: ``10`` The channel socket timeout in seconds. buff_size: ``16384`` The size of the SCP send buffer. allow_agent: ``True`` Set to ``False`` to disable connecting to the SSH agent. look_for_keys: ``True`` Set to ``False`` to disable searching for discoverable private key files in ``~/.ssh/`` banner_timeout An optional timeout (in seconds) to wait for the SSH banner to be presented. auth_timeout An optional timeout (in seconds) to wait for an authentication response. auto_add_policy: ``False`` Automatically add the host to the ``known_hosts``. CLI Example: .. code-block:: bash salt '*' napalm.scp_put /path/to/file /var/tmp/file auto_add_policy=True r r� zscp.put)r� r� r� r� Nr r6 )�filesr� r� r� r� r9 r� r r r �scp_put� s ] ���r� )F)NNrS )NNN)N)NNr� NNr )r� )T)r� )r� F)r� NNr )r� Nr� N)r{ FF)NFFr )H�__doc__�loggingZsalt.utils.napalmr Zsalt.exceptionsr Zsalt.utils.decoratorsr r Znetmikor rb � ImportErrorZnapalm.base.netmiko_helpersr r Zjxmleaser3 ZciscoconfparseZHAS_CISCOCONFPARSEZscpZHAS_SCPr Z__proxyenabled__� getLoggerr rJ r r% r+ r4 r; rA rE rO rC rV r rf rg ri ro rq rv r} r r� r� r� r� r� r? r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r �<module> s � � � � � * 1 J ! 1 E 8 0 & " )$ �E �C 8 & ' . �+ �, �+ �A �9 �Q�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings