File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/napalm_network.cpython-310.pyc
Back
o ;jv � @ s@ d Z ddlZddlZddlZddlZddlZddlZddlZe� e �Z zddl Z dZ W n ey6 dZ Y nw dZdgZdZdd � Zd d � Zd d � Zdd� Zdd� Zdd� Z dSdd�Zejjjdd� �Z ejjjdd� �Z ejjjdd� �Z ejjjdd �d d ��Z ejjj dTd d ��Z ejjj dUd!d"��Z!ejjj #dVd$d%��Z"ejjjd&d'� �Z#ejjjd(d)� �Z$ejjjdWd*d+��Z%ejjjdXd,d-��Z&ejjjdYd.d/��Z'ejjjd0d1� �Z(ejjj 2dZd3d4��Z)ejjj 5 2 d[d6d7��Z*ejjjdYd8d9��Z+ejjj dYd:d;��Z,ejjj dYd<d=��Z-ejjjdYd>d?��Z.ejjj dYd@dA��Z/ejjj dYdBdC��Z0dDdE� Z1dFdG� Z2d\dHdI�Z3 J K d]dLdM�Z4 # N d^dOdP�Z5 # 2 N d_dQdR�Z6dS )`a� NAPALM Network ============== Basic methods for interaction with the network device through the virtual proxy 'napalm'. :codeauthor: Mircea Ulinic <ping@mirceaulinic.net> & Jerome Fleury <jf@cloudflare.com> :maturity: new :depends: napalm :platform: unix Dependencies ------------ - :mod:`napalm proxy minion <salt.proxy.napalm>` .. versionadded:: 2016.11.0 .. versionchanged:: 2017.7.0 � NTF�net�*)Z napalm_netc C s t jj�ttt�S )z_ NAPALM library must be installed for this module to work and run in a (proxy) minion. )�salt�utils�napalmZvirtual�__opts__�__virtualname__�__file__� r r �O/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/napalm_network.py� __virtual__6 s r c C s, t � }| D ]}|�|�|kr|�|� q|S )a< Filters a list of dictionary by a set of key-value pair. :param input_list: is a list of dictionaries :param search_key: is the key we are looking for :param search_value: is the value we are looking for the key specified in search_key :return: filered list of dictionaries )�list�get�append)Z input_list� search_key� search_valueZ output_listZ dictionaryr r r � _filter_listB s �r c C s4 t � }| �� D ]\}}t|||�}|r|||< q|S )aA Filters a dictionary of dictionaries by a key-value pair. :param input_dict: is a dictionary whose values are lists of dictionaries :param search_key: is the key in the leaf dictionaries :param search_values: is the value in the leaf dictionaries :return: filtered dictionary )�dict�itemsr )Z input_dictr r Z output_dict�keyZkey_listZkey_list_filteredr r r � _filter_dictU s �r c C sZ t |d�}|�dd�s+| d |�d�r|d nd7 < d| d< t| |�}|d s+| S |S )N��inherit_napalm_device�resultF�commentzUnable to commit.)�commitr �_safe_dicard_config)� loaded_result� napalm_deviceZ_commit� discardedr r r �_safe_commit_configi s � � r c C sl t �d� t �| � t|d�}|�dd�s4| d |�d�r"|d nd7 < d| d< t|� dtd< | S |S ) NzDiscarding the configr r Fr zUnable to discard config.� �retcode)�log�debug�discard_configr �_explicit_close� __context__)r r Z _discardedr r r r z s ��r c C sj t jj�t�r3z | d �� W dS ty2 } zt�d� t�|� t�d� W Y d}~dS d}~ww dS )a Will explicily close the config session with the network device, when running in a now-always-alive proxy minion or regular minion. This helper must be used in configuration-related functions, as the session is preserved and not closed before making any changes. ZDRIVERz4Unable to close the temp connection with the device:zPlease report.N) r r r �not_always_aliver �close� Exceptionr# �error)r �errr r r r& � s ���r& c K sf | � d�} | stj�� d�} d|d< d|d< |r ||d< t| d�}|� dd�r5|� d �|d < |�d d� nd |d < d|d< |� d �|d < d td< |S |� dd�}|rT|r�|d r`|d d7 < |� d d�sjd|d< t|| �}|d su|S |d d7 < t| � |d s�d td< |S |�s$|�r$| r�t� dt | �� t | �}t� d� t� |d � |� d d��r|s�|�r.t d ||d�}d| � �}tjj�� }tjj�|d�� }|�|� W d � n1 s�w Y td |d|| |d�|d�}t� d � t� |� td � }t|| �}|d �s |d d j|d �7 < |S d j|td! | d"�|d < | |d#< |S t� d$� t� |d � | �s@| �rt d | | d�}td% d&k�r�t�s\d'|d < d|d< |S t d( | | d�}t|t�� d) �}td* |d+�}|d �s�d,�|d- �|d < d|d< t|| �}|d �s�|S n]tjj�� }td. d/d0�d d/ } tjj�|d�� }|�| � W d � n 1 �s�w Y t|| �} | d �s�|S d| � �}td |d|| dd�|d�}t� d1� t� |� td � }d2j|td! | d"�|d < | |d#< |S t|| �} | d �s|S nt|| �}|d �s |S d|d< d3|d < t| � |d �s1d td< |S )4zR Builds the config logic for `load_config` and `load_template` functions. Z __pub_jidz%Y%m%d%H%M%S%fFZalready_configured� � loaded_configr r �out�diffNr r! r" � TzConfiguration discarded.zCommitting the JID: %sz'Cleaned up the commit from the scheduleztimeutil.get_time_at)Ztime_inZtime_at�__napalm_commit_�wz schedule.add�net.load_config)�filename� commit_jid�replace)�functionZ job_kwargs�oncezScheduling job� schedule.savezZScheduled the job to be executed at {schedule_ts}, but was unable to discard the config: )� schedule_tsz�Changes discarded for now, and scheduled commit at: {schedule_ts}. The commit ID is: {current_jid}. To discard this commit, you can execute: salt {min_id} net.cancel_commit {current_jid}�id)r; Zmin_id� current_jidZ commit_idzAbout to commit:�os�junoszqThis feature requires the library jxmlease to be installed. To install, please execute: ``pip install jxmlease``.ztimeutil.get_timestamp_at�< �napalm.junos_commit)Zconfirmz Unable to commit confirm: {}�message� net.config�running��sourcezScheduling commit confirmedz�The commit ID is: {current_jid}. This commit will be reverted at: {schedule_ts}, unless confirmed. To confirm the commit and avoid reverting, you can execute: salt {min_id} net.confirm_commit {current_jid}zAlready configured.) r �datetime�now�compare_config�popr' r r& r# �info�str� cancel_commitr$ Z __utils__r r �files�mkstemp�fopen�write�__salt__�formatr � __grains__� HAS_JXMLEASE�int�timer ) r r �testr$ r7 � commit_configr. � commit_in� commit_at� revert_in� revert_atr6 �kwargsr= Z_compareZ _loaded_resr �removedZ commit_timeZscheduled_job_nameZ temp_fileZfp_Z scheduled�savedZ revert_timeZ timestamp_at�minutesZ_comm�running_configZ committedr r r � _config_logic� s$ � ��� ���� ��� � � � � �� �� � rc c K s dt �dd�iS )z� Specifies if the connection to the device succeeded. CLI Example: .. code-block:: bash salt '*' net.connected r/ ZUPF)r r �r^ r r r � connected| s re c K � t jjjtdfi i ��S )a� Returns characteristics of the network device. :return: a dictionary with the following keys: * uptime - Uptime of the device in seconds. * vendor - Manufacturer of the device. * model - Device model. * hostname - Hostname of the device * fqdn - Fqdn of the device * os_version - String with the OS version running on the device. * serial_number - Serial number of the device * interface_list - List of the interfaces of the device CLI Example: .. code-block:: bash salt '*' net.facts Example output: .. code-block:: python { 'os_version': '13.3R6.5', 'uptime': 10117140, 'interface_list': [ 'lc-0/0/0', 'pfe-0/0/0', 'pfh-0/0/0', 'xe-0/0/0', 'xe-0/0/1', 'xe-0/0/2', 'xe-0/0/3', 'gr-0/0/10', 'ip-0/0/10' ], 'vendor': 'Juniper', 'serial_number': 'JN131356FBFA', 'model': 'MX480', 'hostname': 're0.edge05.syd01', 'fqdn': 're0.edge05.syd01' } Z get_facts�r r r �callr rd r r r �facts� s /��ri c K rf )a Returns the environment of the device. CLI Example: .. code-block:: bash salt '*' net.environment Example output: .. code-block:: python { 'fans': { 'Bottom Rear Fan': { 'status': True }, 'Bottom Middle Fan': { 'status': True }, 'Top Middle Fan': { 'status': True }, 'Bottom Front Fan': { 'status': True }, 'Top Front Fan': { 'status': True }, 'Top Rear Fan': { 'status': True } }, 'memory': { 'available_ram': 16349, 'used_ram': 4934 }, 'temperature': { 'FPC 0 Exhaust A': { 'is_alert': False, 'temperature': 35.0, 'is_critical': False } }, 'cpu': { '1': { '%usage': 19.0 }, '0': { '%usage': 35.0 } } } Zget_environmentrg rd r r r � environment� s ;��rj )� cli_kwargsc O s� dt |�i}| r |�| � tjjjtdfi |��}|d s |S |�d�p.t�d�p.t �dd�}|s8t � d� |S dt vs@d t vrQ|d d 7 < t � |d � |S |�d �}t � d |� |�d�pjt�d�pjt �d�}t � d|� |�d�p�t�d�p�t �di �}t � d|� |�d�p�t�d�p�t �d�} t � d| � |�d�p�t�d�p�t �dd�} t � d| � |�d�p�t�d�p�t �dd �} t � d | � |�d d �} |�d d�} |�d!�}|�d"�}|�d d#�|d i d$�}t � d%� t |�D ]�}|d& | }t � d'|� t � |� d(}|�rst � d)|� t d || | |�� || | ||d*� }t � d+� t � |� |d �sNt � d,� |}|d d-�||d �7 < t � |d � n�|d& �r^t � d.|� |d& }n�d/�|�}|d |7 < t � |� |}ny|�s{||v �r�||v �r�|| }t � d0||� t d ||| d1�}t � d+� t � |� |d �s�t � d,� |}|d d2�||d �7 < t � |d � n,|d& �r�t � d.|� |d& }n t � d3|� |}nt � d4� |}|d d5|� d6�7 < ||d& |< q�|d �� |d < |S )7a� Returns a dictionary with the raw output of all commands passed as arguments. commands List of commands to be executed on the device. cli_kwargs Dictionary of keyword arguments to pass directly to the NAPALM driver's ``cli`` method. Use this for driver-specific options like ``encoding``. .. versionadded:: 3006.19 Example:: salt '*' net.cli "show version" cli_kwargs='{"encoding": "json"}' textfsm_parse: ``False`` Try parsing the outputs using the TextFSM templates. .. versionadded:: 2018.3.0 .. note:: This option can be also specified in the minion configuration file or pillar as ``napalm_cli_textfsm_parse``. textfsm_path The path where the TextFSM templates can be found. This option implies the usage of the TextFSM index file. ``textfsm_path`` can be either absolute path on the server, either specified using the following URL mschemes: ``file://``, ``salt://``, ``http://``, ``https://``, ``ftp://``, ``s3://``, ``swift://``. .. versionadded:: 2018.3.0 .. 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``. textfsm_template The path to a certain 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://`` .. versionadded:: 2018.3.0 textfsm_template_dict A dictionary with the mapping between a command and the corresponding TextFSM path to use to extract the data. The TextFSM paths can be specified as in ``textfsm_template``. .. versionadded:: 2018.3.0 .. note:: This option can be also specified in the minion configuration file or pillar as ``napalm_cli_textfsm_template_dict``. platform_grain_name: ``os`` The name of the grain used to identify the platform name in the TextFSM index file. Default: ``os``. .. versionadded:: 2018.3.0 .. note:: This option can be also specified in the minion configuration file or pillar as ``textfsm_platform_grain``. platform_column_name: ``Platform`` The column name used to identify the platform, exactly as specified in the TextFSM index file. Default: ``Platform``. .. versionadded:: 2018.3.0 .. 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``. index_file: ``index`` The name of the TextFSM index file, under the ``textfsm_path``. Default: ``index``. .. versionadded:: 2018.3.0 .. 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. .. versionadded:: 2018.3.0 include_empty: ``False`` Include empty files under the ``textfsm_path``. .. versionadded:: 2018.3.0 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. .. versionadded:: 2018.3.0 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. .. versionadded:: 2018.3.0 .. 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 '*' net.cli "show version" "show chassis fan" CLI Example with TextFSM template: .. code-block:: bash salt '*' net.cli textfsm_parse=True textfsm_path=salt://textfsm/ Example output: .. code-block:: python { 'show version and haiku': 'Hostname: re0.edge01.arn01 Model: mx480 Junos: 13.3R6.5 Help me, Obi-Wan I just saw Episode Two You're my only hope ', 'show chassis fan' : 'Item Status RPM Measurement Top Rear Fan OK 3840 Spinning at intermediate-speed Bottom Rear Fan OK 3840 Spinning at intermediate-speed Top Middle Fan OK 3900 Spinning at intermediate-speed Bottom Middle Fan OK 3840 Spinning at intermediate-speed Top Front Fan OK 3810 Spinning at intermediate-speed Bottom Front Fan OK 3840 Spinning at intermediate-speed ' } Example output with TextFSM parsing: .. code-block:: json { "comment": "", "result": true, "out": { "sh ver": [ { "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" } ] } } �commands�clir � textfsm_parseZnapalm_cli_textfsm_parseFz No TextFSM parsing requested.ztextfsm.extractz textfsm.indexr z(Unable to process: is TextFSM installed?�textfsm_templateztextfsm_template: %s� textfsm_pathztextfsm_path: %s�textfsm_template_dictZ napalm_cli_textfsm_template_dictz$TextFSM command-template mapping: %s� index_fileZtextfsm_index_filezindex_file: %s�platform_grain_nameZtextfsm_platform_grainr> zplatform_grain_name: %s�platform_column_nameZ textfsm_platform_column_nameZPlatformzplatform_column_name: %s�saltenv�base� include_empty� include_pat� exclude_patr- )r r r/ z#Starting to analyse the raw outputsr/ zOutput from command: %sNz Using the templates under %s)rs rt �outputrp ru rw rx ry zProcessed CLI output:z6Apparently this did not work, returning the raw outputz* Unable to process the output from {}: {}.z All good, %s has a nice output!zM Processing "{}" didn't fail, but didn't return anything either. Dumping raw.z#Using %s to process the command: %s)Zraw_textru z) Unable to process the output from {}: {}zLProcessing %s did not fail, but did not return anything either. Dumping raw.z9No TextFSM template specified, or no TextFSM path definedz# Unable to process the output from �.)r �updater r r rh r r r Z __pillar__r# r$ rR r+ �striprS )rk rl r^ Z napalm_kwargsZraw_cli_outputsrn ro rp rq rr rs rt ru rw rx ry Zprocessed_cli_outputsZcommandZcommand_outputZprocessed_command_outputZprocessed_cli_outputr r r r rm � s @ �� � � �� � � �� � � � � � � ��� � � ��� � � �rm c K s$ t jjjtdfi | ||||d���S )a� Calls the method traceroute from the NAPALM driver object and returns a dictionary with the result of the traceroute command executed on the device. destination Hostname or address of remote host source Source address to use in outgoing traceroute packets ttl IP maximum time-to-live value (or IPv6 maximum hop-limit value) timeout Number of seconds to wait for response (seconds) vrf VRF (routing instance) for traceroute attempt .. versionadded:: 2016.11.4 CLI Example: .. code-block:: bash salt '*' net.traceroute 8.8.8.8 salt '*' net.traceroute 8.8.8.8 source=127.0.0.1 ttl=5 timeout=1 � traceroute)� destinationrF �ttl�timeout�vrfrg )r rF r� r� r� r^ r r r r~ P s !���r~ c K s( t jjjtdfi | ||||||d���S )a Executes a ping on the network device and returns a dictionary as a result. destination Hostname or IP address of remote host source Source address of echo request ttl IP time-to-live value (IPv6 hop-limit value) (1..255 hops) timeout Maximum wait time after sending final packet (seconds) size Size of request packets (0..65468 bytes) count Number of ping requests to send (1..2000000000 packets) vrf VRF (routing instance) for ping attempt .. versionadded:: 2016.11.4 CLI Example: .. code-block:: bash salt '*' net.ping 8.8.8.8 salt '*' net.ping 8.8.8.8 ttl=3 size=65468 salt '*' net.ping 8.8.8.8 source=127.0.0.1 timeout=1 count=100 �ping)r rF r� r� �size�countr� rg )r rF r� r� r� r� r� r^ r r r r� ~ s .���r� r- c K sr t jjjtdfi i ��}|�d�s|S |�d�}| r t|d| �}|r(t|d|�}|r0t|d|�}|�d|i� |S )a� NAPALM returns a list of dictionaries with details of the ARP entries. :param interface: interface name to filter on :param ipaddr: IP address to filter on :param macaddr: MAC address to filter on :return: List of the entries in the ARP table CLI Example: .. code-block:: bash salt '*' net.arp salt '*' net.arp macaddr='5c:5e:ab:da:3c:f0' Example output: .. code-block:: python [ { 'interface' : 'MgmtEth0/RSP0/CPU0/0', 'mac' : '5c:5e:ab:da:3c:f0', 'ip' : '172.17.17.1', 'age' : 1454496274.84 }, { 'interface': 'MgmtEth0/RSP0/CPU0/0', 'mac' : '66:0e:94:96:e0:ff', 'ip' : '172.17.17.2', 'age' : 1435641582.49 } ] Z get_arp_tabler r/ � interface�ip�mac)r r r rh r r r r| )r� ZipaddrZmacaddrr^ � proxy_outputZ arp_tabler r r �arp� s '�� r� c K rf )au Returns IP addresses configured on the device. :return: A dictionary with the IPv4 and IPv6 addresses of the interfaces. Returns all configured IP addresses on all interfaces as a dictionary of dictionaries. Keys of the main dictionary represent the name of the interface. Values of the main dictionary represent are dictionaries that may consist of two keys 'ipv4' and 'ipv6' (one, both or none) which are themselvs dictionaries with the IP addresses as keys. CLI Example: .. code-block:: bash salt '*' net.ipaddrs Example output: .. code-block:: python { 'FastEthernet8': { 'ipv4': { '10.66.43.169': { 'prefix_length': 22 } } }, 'Loopback555': { 'ipv4': { '192.168.1.1': { 'prefix_length': 24 } }, 'ipv6': { '1::1': { 'prefix_length': 64 }, '2001:DB8:1::1': { 'prefix_length': 64 }, 'FE80::3': { 'prefix_length': 'N/A' } } } } Zget_interfaces_iprg rd r r r �ipaddrs� s 3��r� c K rf )ao Returns details of the interfaces on the device. :return: Returns a dictionary of dictionaries. The keys for the first dictionary will be the interfaces in the devices. CLI Example: .. code-block:: bash salt '*' net.interfaces Example output: .. code-block:: python { 'Management1': { 'is_up': False, 'is_enabled': False, 'description': '', 'last_flapped': -1, 'speed': 1000, 'mac_address': 'dead:beef:dead', }, 'Ethernet1':{ 'is_up': True, 'is_enabled': True, 'description': 'foo', 'last_flapped': 1429978575.1554043, 'speed': 1000, 'mac_address': 'beef:dead:beef', } } Zget_interfacesrg rd r r r � interfaces1 � &��r� c K sT t jjjtdfi i ��}|�d�s|S |�d�}| r!| |�| �i}|�d|i� |S )a� Returns a detailed view of the LLDP neighbors. :param interface: interface name to filter on :return: A dictionary with the LLDL neighbors. The keys are the interfaces with LLDP activated on. CLI Example: .. code-block:: bash salt '*' net.lldp salt '*' net.lldp interface='TenGigE0/0/0/8' Example output: .. code-block:: python { 'TenGigE0/0/0/8': [ { 'parent_interface': 'Bundle-Ether8', 'interface_description': 'TenGigE0/0/0/8', 'remote_chassis_id': '8c60.4f69.e96c', 'remote_system_name': 'switch', 'remote_port': 'Eth2/2/1', 'remote_port_description': 'Ethernet2/2/1', 'remote_system_description': 'Cisco Nexus Operating System (NX-OS) Software 7.1(0)N1(1a) TAC support: http://www.cisco.com/tac Copyright (c) 2002-2015, Cisco Systems, Inc. All rights reserved.', 'remote_system_capab': 'B, R', 'remote_system_enable_capab': 'B' } ] } Zget_lldp_neighbors_detailr r/ )r r r rh r r r| )r� r^ r� Zlldp_neighborsr r r �lldp\ s (�� r� c K s| t jjjtdfi i ��}|�d�s|S |�d�}|r%t|t�r%t|d|�}| r-t|d| �}|r5t|d|�}|� d|i� |S )a- Returns the MAC Address Table on the device. :param address: MAC address to filter on :param interface: Interface name to filter on :param vlan: VLAN identifier :return: A list of dictionaries representing the entries in the MAC Address Table CLI Example: .. code-block:: bash salt '*' net.mac salt '*' net.mac vlan=10 Example output: .. code-block:: python [ { 'mac' : '00:1c:58:29:4a:71', 'interface' : 'xe-3/0/2', 'static' : False, 'active' : True, 'moves' : 1, 'vlan' : 10, 'last_move' : 1454417742.58 }, { 'mac' : '8c:60:4f:58:e1:c1', 'interface' : 'xe-1/0/1', 'static' : False, 'active' : True, 'moves' : 2, 'vlan' : 42, 'last_move' : 1453191948.11 } ] Zget_mac_address_tabler r/ �vlanr� r� ) r r r rh r r � isinstancerV r r| )�addressr� r� r^ r� Zmac_address_tabler r r r� � s" +�� r� c K s t jjjtdfi d| i��S )a� .. versionadded:: 2017.7.0 Return the whole configuration of the network device. By default, it will return all possible configuration sources supported by the network device. At most, there will be: - running config - startup config - candidate config To return only one of the configurations, you can use the ``source`` argument. source Which configuration type you want to display, default is all of them. Options: - running - candidate - startup :return: The object returned is a dictionary with the following keys: - running (string): Representation of the native running configuration. - candidate (string): Representation of the native candidate configuration. If the device doesn't differentiate between running and startup configuration this will an empty string. - startup (string): Representation of the native startup configuration. If the device doesn't differentiate between running and startup configuration this will an empty string. CLI Example: .. code-block:: bash salt '*' net.config salt '*' net.config source=candidate Z get_configZretrieverg )rF r^ r r r �config� s +��r� c K rf )a� .. versionadded:: 2017.7.0 Fetches the power usage on the various transceivers installed on the network device (in dBm), and returns a view that conforms with the OpenConfig model openconfig-platform-transceiver.yang. :return: Returns a dictionary where the keys are as listed below: * intf_name (unicode) * physical_channels * channels (list of dicts) * index (int) * state * input_power * instant (float) * avg (float) * min (float) * max (float) * output_power * instant (float) * avg (float) * min (float) * max (float) * laser_bias_current * instant (float) * avg (float) * min (float) * max (float) CLI Example: .. code-block:: bash salt '*' net.optics Z get_opticsrg rd r r r �optics r� r� rv c K s� d}|rd}t jj�t�rdtd< | r=td | | d�}|du r4ddd�}d �| �|d < t� |d � |S | r=t jj � | � t jjj t|fi d |i��}t t|f||||||||| | d � | ��S ) a�! Applies configuration changes on the device. It can be loaded from a file or from inline string. If you send both a filename and a string containing the configuration, the file has higher precedence. By default this function will commit the changes. If there are no changes, it does not commit and the flag ``already_configured`` will be set as ``True`` to point this out. To avoid committing the configuration, set the argument ``test`` to ``True`` and will discard (dry run). To keep the changes but not commit, set ``commit`` to ``False``. To replace the config, set ``replace`` to ``True``. filename Path to the file containing the desired configuration. 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://`` .. versionchanged:: 2018.3.0 text String containing the desired configuration. This argument is ignored when ``filename`` is specified. test: False Dry run? If set as ``True``, will apply the config, discard and return the changes. Default: ``False`` and will commit the changes on the device. commit: True Commit? Default: ``True``. debug: False Debug mode. Will insert a new key under the output dictionary, as ``loaded_config`` containing the raw configuration loaded on the device. .. versionadded:: 2016.11.2 replace: False Load and replace the configuration. Default: ``False``. .. versionadded:: 2016.11.2 commit_in: ``None`` Commit the changes in a specific number of minutes / hours. Example of accepted formats: ``5`` (commit in 5 minutes), ``2m`` (commit in 2 minutes), ``1h`` (commit the changes in 1 hour)`, ``5h30m`` (commit the changes in 5 hours and 30 minutes). .. note:: This feature works on any platforms, as it does not rely on the native features of the network operating system. .. note:: After the command is executed and the ``diff`` is not satisfactory, or for any other reasons you have to discard the commit, you are able to do so using the :py:func:`net.cancel_commit <salt.modules.napalm_network.cancel_commit>` execution function, using the commit ID returned by this function. .. warning:: Using this feature, Salt will load the exact configuration you expect, however the diff may change in time (i.e., if an user applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). .. versionadded:: 2019.2.0 commit_at: ``None`` Commit the changes at a specific time. Example of accepted formats: ``1am`` (will commit the changes at the next 1AM), ``13:20`` (will commit at 13:20), ``1:20am``, etc. .. note:: This feature works on any platforms, as it does not rely on the native features of the network operating system. .. note:: After the command is executed and the ``diff`` is not satisfactory, or for any other reasons you have to discard the commit, you are able to do so using the :py:func:`net.cancel_commit <salt.modules.napalm_network.cancel_commit>` execution function, using the commit ID returned by this function. .. warning:: Using this feature, Salt will load the exact configuration you expect, however the diff may change in time (i.e., if an user applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). .. versionadded:: 2019.2.0 revert_in: ``None`` Commit and revert the changes in a specific number of minutes / hours. Example of accepted formats: ``5`` (revert in 5 minutes), ``2m`` (revert in 2 minutes), ``1h`` (revert the changes in 1 hour)`, ``5h30m`` (revert the changes in 5 hours and 30 minutes). .. note:: To confirm the commit, and prevent reverting the changes, you will have to execute the :mod:`net.confirm_commit <salt.modules.napalm_network.confirm_commit>` function, using the commit ID returned by this function. .. warning:: This works on any platform, regardless if they have or don't have native capabilities to confirming a commit. However, please be *very* cautious when using this feature: on Junos (as it is the only NAPALM core platform supporting this natively) it executes a commit confirmed as you would do from the command line. All the other platforms don't have this capability natively, therefore the revert is done via Salt. That means, your device needs to be reachable at the moment when Salt will attempt to revert your changes. Be cautious when pushing configuration changes that would prevent you reach the device. Similarly, if an user or a different process apply other configuration changes in the meanwhile (between the moment you commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. .. versionadded:: 2019.2.0 revert_at: ``None`` Commit and revert the changes at a specific time. Example of accepted formats: ``1am`` (will commit and revert the changes at the next 1AM), ``13:20`` (will commit and revert at 13:20), ``1:20am``, etc. .. note:: To confirm the commit, and prevent reverting the changes, you will have to execute the :mod:`net.confirm_commit <salt.modules.napalm_network.confirm_commit>` function, using the commit ID returned by this function. .. warning:: This works on any platform, regardless if they have or don't have native capabilities to confirming a commit. However, please be *very* cautious when using this feature: on Junos (as it is the only NAPALM core platform supporting this natively) it executes a commit confirmed as you would do from the command line. All the other platforms don't have this capability natively, therefore the revert is done via Salt. That means, your device needs to be reachable at the moment when Salt will attempt to revert your changes. Be cautious when pushing configuration changes that would prevent you reach the device. Similarly, if an user or a different process apply other configuration changes in the meanwhile (between the moment you commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. .. versionadded:: 2019.2.0 saltenv: ``base`` Specifies the Salt environment name. .. versionadded:: 2018.3.0 :return: a dictionary having the following keys: * result (bool): if the config was applied successfully. It is ``False`` only in case of failure. In case there are no changes to be applied and successfully performs all operations it is still ``True`` and so will be the ``already_configured`` flag (example below) * comment (str): a message for the user * already_configured (bool): flag to check if there were no changes applied * loaded_config (str): the configuration loaded on the device. Requires ``debug`` to be set as ``True`` * diff (str): returns the config changes applied CLI Example: .. code-block:: bash salt '*' net.load_config text='ntp peer 192.168.0.1' salt '*' net.load_config filename='/absolute/path/to/your/file' salt '*' net.load_config filename='/absolute/path/to/your/file' test=True salt '*' net.load_config filename='/absolute/path/to/your/file' commit=False Example output: .. code-block:: python { 'comment': 'Configuration discarded.', 'already_configured': False, 'result': True, 'diff': '[edit interfaces xe-0/0/5]+ description "Adding a description";' } �load_merge_candidate�load_replace_candidateF�CLOSEzcp.get_file_str)ru N)r r/ z<Unable to read from {}. Please specify a valid file or text.r r� ) rX r$ r7 rY r. r[ rZ r\ r] r6 )r r r r( r r rR rS r# r+ rN Zsafe_rmrh rc )r5 �textrX r r$ r7 rZ r[ r\ r] r6 r ru r^ �fun�ret�_loadedr r r � load_config> sP S ������ �r� �jinjac $ K s� d}dddd�}d}|t jjjvr)|�ddjd�tt jjj�� ��d�d �� |S d }d}d}t | t tf�sJ|D ] }|sC|pB| � |�}q8t d | �}|du rPi }|�|� |r�t d |||||d �}t |t �s�d|v rr|d |d< nd|d< d|v r�|d |d< |S d|d< |S �nt | tt f�s�| g} |r�t |tt f�s�|g}n |s�dgt| � }|r�t |t �r�|� d�s�|� d�s�|g}n"|r�t |t �r�|� d�s�|� d�r�|gt| � }n |s�dgt| � }t| �D ]�\}}|| } || } t d |d�} t d d| �} t d | || | dddd|||||d� } t | tt f��s-t | t ��r-|d | 7 < d|d< n;t | tt f��rIt| �dk�sId|d< |d d7 < n t | tt f��rht| d �dk�shd|d< |d | d 7 < |d �r�| d }!t d |!�}"|"�s�d|d< |d d7 < | S |t d |!�7 }t d |!� q�| S |}|d �r�d }#| �r�d }#t jj�t��r�dtd < t jjjt|#fi d |i��}tt|f| | | | ||| ||d!� |��S )"a�3 Renders a configuration template (default: Jinja) and loads the result on the device. By default this function will commit the changes. If there are no changes, it does not commit, discards he config and the flag ``already_configured`` will be set as ``True`` to point this out. To avoid committing the configuration, set the argument ``test`` to ``True`` and will discard (dry run). To preserve the changes, set ``commit`` to ``False``. However, this is recommended to be used only in exceptional cases when there are applied few consecutive states and/or configuration changes. Otherwise the user might forget that the config DB is locked and the candidate config buffer is not cleared/merged in the running config. To replace the config, set ``replace`` to ``True``. template_name Identifies path to the template source. The template can be either stored on the local machine, either remotely. The recommended location is under the ``file_roots`` as specified in the master config file. For example, let's suppose the ``file_roots`` is configured as: .. code-block:: yaml file_roots: base: - /etc/salt/states Placing the template under ``/etc/salt/states/templates/example.jinja``, it can be used as ``salt://templates/example.jinja``. Alternatively, for local files, the user can specify the absolute path. If remotely, the source can be retrieved via ``http``, ``https`` or ``ftp``. Examples: - ``salt://my_template.jinja`` - ``/absolute/path/to/my_template.jinja`` - ``http://example.com/template.cheetah`` - ``https:/example.com/template.mako`` - ``ftp://example.com/template.py`` .. versionchanged:: 2019.2.0 This argument can now support a list of templates to be rendered. The resulting configuration text is loaded at once, as a single configuration chunk. template_source: None Inline config template to be rendered and loaded on the device. template_hash: None Hash of the template file. Format: ``{hash_type: 'md5', 'hsum': <md5sum>}`` .. versionadded:: 2016.11.2 context: None Overrides default context variables passed to the template. .. versionadded:: 2019.2.0 template_hash_name: None When ``template_hash`` refers to a remote file, this specifies the filename to look for in that file. .. versionadded:: 2016.11.2 saltenv: ``base`` Specifies the template environment. This will influence the relative imports inside the templates. .. versionadded:: 2016.11.2 template_engine: jinja The following templates engines are supported: - :mod:`cheetah<salt.renderers.cheetah>` - :mod:`genshi<salt.renderers.genshi>` - :mod:`jinja<salt.renderers.jinja>` - :mod:`mako<salt.renderers.mako>` - :mod:`py<salt.renderers.py>` - :mod:`wempy<salt.renderers.wempy>` .. versionadded:: 2016.11.2 skip_verify: True If ``True``, hash verification of remote file sources (``http://``, ``https://``, ``ftp://``) will be skipped, and the ``source_hash`` argument will be ignored. .. versionadded:: 2016.11.2 test: False Dry run? If set to ``True``, will apply the config, discard and return the changes. Default: ``False`` and will commit the changes on the device. commit: True Commit? (default: ``True``) debug: False Debug mode. Will insert a new key under the output dictionary, as ``loaded_config`` containing the raw result after the template was rendered. .. versionadded:: 2016.11.2 replace: False Load and replace the configuration. .. versionadded:: 2016.11.2 commit_in: ``None`` Commit the changes in a specific number of minutes / hours. Example of accepted formats: ``5`` (commit in 5 minutes), ``2m`` (commit in 2 minutes), ``1h`` (commit the changes in 1 hour)`, ``5h30m`` (commit the changes in 5 hours and 30 minutes). .. note:: This feature works on any platforms, as it does not rely on the native features of the network operating system. .. note:: After the command is executed and the ``diff`` is not satisfactory, or for any other reasons you have to discard the commit, you are able to do so using the :py:func:`net.cancel_commit <salt.modules.napalm_network.cancel_commit>` execution function, using the commit ID returned by this function. .. warning:: Using this feature, Salt will load the exact configuration you expect, however the diff may change in time (i.e., if an user applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). .. versionadded:: 2019.2.0 commit_at: ``None`` Commit the changes at a specific time. Example of accepted formats: ``1am`` (will commit the changes at the next 1AM), ``13:20`` (will commit at 13:20), ``1:20am``, etc. .. note:: This feature works on any platforms, as it does not rely on the native features of the network operating system. .. note:: After the command is executed and the ``diff`` is not satisfactory, or for any other reasons you have to discard the commit, you are able to do so using the :py:func:`net.cancel_commit <salt.modules.napalm_network.cancel_commit>` execution function, using the commit ID returned by this function. .. warning:: Using this feature, Salt will load the exact configuration you expect, however the diff may change in time (i.e., if an user applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). .. versionadded:: 2019.2.0 revert_in: ``None`` Commit and revert the changes in a specific number of minutes / hours. Example of accepted formats: ``5`` (revert in 5 minutes), ``2m`` (revert in 2 minutes), ``1h`` (revert the changes in 1 hour)`, ``5h30m`` (revert the changes in 5 hours and 30 minutes). .. note:: To confirm the commit, and prevent reverting the changes, you will have to execute the :mod:`net.confirm_commit <salt.modules.napalm_network.confirm_commit>` function, using the commit ID returned by this function. .. warning:: This works on any platform, regardless if they have or don't have native capabilities to confirming a commit. However, please be *very* cautious when using this feature: on Junos (as it is the only NAPALM core platform supporting this natively) it executes a commit confirmed as you would do from the command line. All the other platforms don't have this capability natively, therefore the revert is done via Salt. That means, your device needs to be reachable at the moment when Salt will attempt to revert your changes. Be cautious when pushing configuration changes that would prevent you reach the device. Similarly, if an user or a different process apply other configuration changes in the meanwhile (between the moment you commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. .. versionadded:: 2019.2.0 revert_at: ``None`` Commit and revert the changes at a specific time. Example of accepted formats: ``1am`` (will commit and revert the changes at the next 1AM), ``13:20`` (will commit and revert at 13:20), ``1:20am``, etc. .. note:: To confirm the commit, and prevent reverting the changes, you will have to execute the :mod:`net.confirm_commit <salt.modules.napalm_network.confirm_commit>` function, using the commit ID returned by this function. .. warning:: This works on any platform, regardless if they have or don't have native capabilities to confirming a commit. However, please be *very* cautious when using this feature: on Junos (as it is the only NAPALM core platform supporting this natively) it executes a commit confirmed as you would do from the command line. All the other platforms don't have this capability natively, therefore the revert is done via Salt. That means, your device needs to be reachable at the moment when Salt will attempt to revert your changes. Be cautious when pushing configuration changes that would prevent you reach the device. Similarly, if an user or a different process apply other configuration changes in the meanwhile (between the moment you commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. .. versionadded:: 2019.2.0 defaults: None Default variables/context passed to the template. .. versionadded:: 2016.11.2 template_vars Dictionary with the arguments/context to be used when the template is rendered. .. note:: Do not explicitly specify this argument. This represents any other variable that will be sent to the template rendering system. Please see the examples below! .. note:: It is more recommended to use the ``context`` argument to avoid conflicts between CLI arguments and template variables. :return: a dictionary having the following keys: - result (bool): if the config was applied successfully. It is ``False`` only in case of failure. In case there are no changes to be applied and successfully performs all operations it is still ``True`` and so will be the ``already_configured`` flag (example below) - comment (str): a message for the user - already_configured (bool): flag to check if there were no changes applied - loaded_config (str): the configuration loaded on the device, after rendering the template. Requires ``debug`` to be set as ``True`` - diff (str): returns the config changes applied The template can use variables from the ``grains``, ``pillar`` or ``opts``, for example: .. code-block:: jinja {% set router_model = grains.get('model') -%} {% set router_vendor = grains.get('vendor') -%} {% set os_version = grains.get('version') -%} {% set hostname = pillar.get('proxy', {}).get('host') -%} {% if router_vendor|lower == 'juniper' %} system { host-name {{hostname}}; } {% elif router_vendor|lower == 'cisco' %} hostname {{hostname}} {% endif %} CLI Examples: .. code-block:: bash salt '*' net.load_template set_ntp_peers peers=[192.168.0.1] # uses NAPALM default templates # inline template: salt -G 'os:junos' net.load_template template_source='system { host-name {{host_name}}; }' host_name='MX480.lab' # inline template using grains info: salt -G 'os:junos' net.load_template template_source='system { host-name {{grains.model}}.lab; }' # if the device is a MX480, the command above will set the hostname as: MX480.lab # inline template using pillar data: salt -G 'os:junos' net.load_template template_source='system { host-name {{pillar.proxy.host}}; }' salt '*' net.load_template https://bit.ly/2OhSgqP hostname=example # will commit salt '*' net.load_template https://bit.ly/2OhSgqP hostname=example test=True # dry run salt '*' net.load_template salt://templates/example.jinja debug=True # Using the salt:// URI # render a mako template: salt '*' net.load_template salt://templates/example.mako template_engine=mako debug=True # render remote template salt -G 'os:junos' net.load_template http://bit.ly/2fReJg7 test=True debug=True peers=['192.168.0.1'] salt -G 'os:ios' net.load_template http://bit.ly/2gKOj20 test=True debug=True peers=['192.168.0.1'] # render multiple templates at once salt '*' net.load_template "['https://bit.ly/2OhSgqP', 'salt://templates/example.jinja']" context="{'hostname': 'example'}" Example output: .. code-block:: python { 'comment': '', 'already_configured': False, 'result': True, 'diff': '[edit system]+ host-name edge01.bjm01', 'loaded_config': 'system { host-name edge01.bjm01; }'' } r- TN)r r r/ Fz9Invalid templating engine! Choose between: {tpl_eng_opts}z, )Z tpl_eng_opts)r r )�salt://zhttp://zhttps://zftp://zfile.file_existsz file.apply_template_on_contents)�contents�template�context�defaultsru r r z#Error while rendering the template.r� zfile://z random.hash�md5z file.joinz/tmpzfile.get_managed) �namerF � source_hashZsource_hash_name�user�group�mode�attrsr� r� r� ru � skip_verifyr ���z file.readz file.remover� r� r� r� ) rX r$ r7 rY r. r[ rZ r\ r] )r r Z templatesZTEMPLATE_REGISTRYr| rS �joinr �keysr� �tuple� startswithrR rL �len� enumerater r( r r rh rc )$Z template_nameZtemplate_sourcer� r� Ztemplate_engineru Z template_hashZtemplate_hash_namer� rX r r$ r7 rZ r[ r\ r] r Z template_varsZ _renderedr� r. Zsalt_render_prefixesZ salt_renderZ file_existsZsalt_render_prefixZ tpl_indexZtpl_nameZtpl_hashZ tpl_hash_nameZ_rand_filenameZ _temp_fileZ_managedZ_temp_tpl_fileZ_temp_tpl_file_existsr� r r r � load_templateB s Q ���� �� � �� ���� ���� � " ���� �r� c K rf )z� Commits the configuration changes made on the network device. CLI Example: .. code-block:: bash salt '*' net.commit rY rg �r r^ r r r r 6 � ��r c K rf )zx Discards the changes applied. CLI Example: .. code-block:: bash salt '*' net.discard_config r% rg r� r r r r% G � ��r% c K rf )z� Returns the difference between the running config and the candidate config. CLI Example: .. code-block:: bash salt '*' net.compare_config rI rg r� r r r rI Z r� rI c K rf )zq Rollbacks the configuration. CLI Example: .. code-block:: bash salt '*' net.rollback �rollbackrg r� r r r r� m r� r� c K sP d}d}t td�}|�d�r |�d�rd}||fS d}||fS |�d�}||fS ) aJ Will prompt if the configuration has been changed. :return: A tuple with a boolean that specifies if the config was changed on the device. And a string that provides more details of the reason why the configuration was not changed. CLI Example: .. code-block:: bash salt '*' net.config_changed Fr- r r r/ Tz,Configuration was not changed on the device.r )rI r r )r r^ Zis_config_changed�reasonZ try_comparer r r �config_changed~ s � �r� c K sv d}d}t td�\}}|s||fS t� }|�d�s7d}dj|�d�d�}t� }|�d�s7|d j|�d�d�7 }||fS ) a� Will check if the configuration was changed. If differences found, will try to commit. In case commit unsuccessful, will try to rollback. :return: A tuple with a boolean that specifies if the config was changed/committed/rollbacked on the device. And a string that provides more details of the reason why the configuration was not committed properly. CLI Example: .. code-block:: bash salt '*' net.config_control Tr- r r FzAUnable to commit the changes: {reason}. Will try to rollback now!r )r� z Cannot rollback! {reason})r� r r r rS r� )r r^ r r �changedZnot_changed_rsnZ try_commitZ try_rollbackr r r �config_control� s$ �� �r� c C sP d| � �}t d |�}|d r t d � }d| � d�|d< |S d| � d �|d< |S ) a .. versionadded:: 2019.2.0 Cancel a commit scheduled to be executed via the ``commit_in`` and ``commit_at`` arguments from the :py:func:`net.load_template <salt.modules.napalm_network.load_template>` or :py:func:`net.load_config <salt.modules.napalm_network.load_config>` execution functions. The commit ID is displayed when the commit is scheduled via the functions named above. CLI Example: .. code-block:: bash salt '*' net.cancel_commit 20180726083540640360 r2 zschedule.deleter r: �Commit #z cancelled.r zUnable to find commit #r{ )rR )�jidZjob_namer_ r` r r r rM � s �rM c C sX t d dkrtd � }|�d�|d< |�d�|d< nt| �}|d r*d| � d �|d< |S ) a .. versionadded:: 2019.2.0 Confirm a commit scheduled to be reverted via the ``revert_in`` and ``revert_at`` arguments from the :mod:`net.load_template <salt.modules.napalm_network.load_template>` or :mod:`net.load_config <salt.modules.napalm_network.load_config>` execution functions. The commit ID is displayed when the commit confirmed is scheduled via the functions named above. CLI Example: .. code-block:: bash salt '*' net.confirm_commit 20180726083540640360 r> r? rA r/ r rB r r� z confirmed.)rT rR rJ rM )r� Z confirmedr r r �confirm_commit� s r� c C s� | sd} |s t jj�� }td | d�}|r|d s t�d� |S t jj�|d��}|�|d | � W d � n1 s<w Y d || � d |� �d �S ) a .. versionadded:: 2019.2.0 Save the configuration to a file on the local file system. source: ``running`` The configuration source. Choose from: ``running``, ``candidate``, ``startup``. Default: ``running``. path Absolute path to file where to save the configuration. To push the files to the Master, use :mod:`cp.push <salt.modules.cp.push>` Execution function. CLI Example: .. code-block:: bash salt '*' net.save_config source=running rD rC rE r z Unable to retrieve the configr3 r/ NTz config saved to )r r/ r ) r r rN rO rR r# r+ rP rQ )rF �pathrb �fh_r r r � save_config s � �r� � r! c C s� t | | d�}|r |d s|S |d } td | | ||||||||| | d� }tjj�| d�� }|�� }W d � n1 s;w Y td || |||d �S ) ay .. versionadded:: 2019.2.0 Replace occurrences of a pattern in the configuration source. If ``show_changes`` is ``True``, then a diff of what changed will be returned, otherwise a ``True`` will be returned when changes are made, and ``False`` when no changes are made. This is a pure Python implementation that wraps Python's :py:func:`~re.sub`. pattern A regular expression, to be matched using Python's :py:func:`~re.search`. repl The replacement text. count: ``0`` Maximum number of pattern occurrences to be replaced. If count is a positive integer ``n``, only ``n`` occurrences will be replaced, otherwise all occurrences will be replaced. flags (list or int): ``8`` A list of flags defined in the ``re`` module documentation from the Python standard library. Each list item should be a string that will correlate to the human-friendly flag name. E.g., ``['IGNORECASE', 'MULTILINE']``. Optionally, ``flags`` may be an int, with a value corresponding to the XOR (``|``) of all the desired flags. Defaults to 8 (which supports 'MULTILINE'). bufsize (int or str): ``1`` How much of the configuration to buffer into memory at once. The default value ``1`` processes one line at a time. The special value ``file`` may be specified which will read the entire file into memory before processing. append_if_not_found: ``False`` If set to ``True``, and pattern is not found, then the content will be appended to the file. prepend_if_not_found: ``False`` If set to ``True`` and pattern is not found, then the content will be prepended to the file. not_found_content Content to use for append/prepend if not found. If None (default), uses ``repl``. Useful when ``repl`` uses references to group in pattern. search_only: ``False`` If set to true, this no changes will be performed on the file, and this function will simply return ``True`` if the pattern was matched, and ``False`` if not. show_changes: ``True`` If ``True``, return a diff of changes made. Otherwise, return ``True`` if changes were made, and ``False`` if not. backslash_literal: ``False`` Interpret backslashes as literal backslashes for the repl and not escape characters. This will help when using append/prepend so that the backslashes are not interpreted for the repl on the second run of the state. source: ``running`` The configuration source. Choose from: ``running``, ``candidate``, or ``startup``. Default: ``running``. path Save the temporary configuration to a specific path, then read from there. test: ``False`` Dry run? If set as ``True``, will apply the config, discard and return the changes. Default: ``False`` and will commit the changes on the device. commit: ``True`` Commit the configuration changes? Default: ``True``. debug: ``False`` Debug mode. Will insert a new key in the output dictionary, as ``loaded_config`` containing the raw configuration loaded on the device. replace: ``True`` Load and replace the configuration. Default: ``True``. If an equal sign (``=``) appears in an argument to a Salt command it is interpreted as a keyword argument in the format ``key=val``. That processing can be bypassed in order to pass an equal sign through to the remote shell command by manually specifying the kwarg: .. code-block:: bash salt '*' net.replace_pattern "bind-address\s*=" "bind-address:" CLI Example: .. code-block:: bash salt '*' net.replace_pattern PREFIX-LIST_NAME new-prefix-list-name salt '*' net.replace_pattern bgp-group-name new-bgp-group-name count=1 �rF r� r r/ z file.replace) r� �flags�bufsize�append_if_not_found�prepend_if_not_found�not_found_content� search_only� show_changes�backslash_literal�rNr4 �r� rX r$ r7 r �r� rR r r rN rP �read)�pattern�replr� r� r� r� r� r� r� r� r� rF r� rX r7 r$ r � config_saved�replace_patternr� �updated_configr r r r� , s0 x � � �r� rD c C s� t ||d�} | r | d s| S | d }td || ||||||d�}tjj�|d�� }|�� }W d � n1 s7w Y td || | | | d �S ) aZ .. versionadded:: 2019.2.0 Replace content of the configuration source, delimited by the line markers. A block of content delimited by comments can help you manage several lines without worrying about old entries removal. marker_start The line content identifying a line as the start of the content block. Note that the whole line containing this marker will be considered, so whitespace or extra content before or after the marker is included in final output. marker_end The line content identifying a line as the end of the content block. Note that the whole line containing this marker will be considered, so whitespace or extra content before or after the marker is included in final output. content The content to be used between the two lines identified by ``marker_start`` and ``marker_stop``. append_if_not_found: ``False`` If markers are not found and set to True then, the markers and content will be appended to the file. prepend_if_not_found: ``False`` If markers are not found and set to True then, the markers and content will be prepended to the file. append_newline: ``False`` Controls whether or not a newline is appended to the content block. If the value of this argument is ``True`` then a newline will be added to the content block. If it is ``False``, then a newline will not be added to the content block. If it is ``None`` then a newline will only be added to the content block if it does not already end in a newline. show_changes: ``True`` Controls how changes are presented. If ``True``, this function will return the of the changes made. If ``False``, then it will return a boolean (``True`` if any changes were made, otherwise False). source: ``running`` The configuration source. Choose from: ``running``, ``candidate``, or ``startup``. Default: ``running``. path: ``None`` Save the temporary configuration to a specific path, then read from there. This argument is optional, can be used when you prefers a particular location of the temporary file. test: ``False`` Dry run? If set as ``True``, will apply the config, discard and return the changes. Default: ``False`` and will commit the changes on the device. commit: ``True`` Commit the configuration changes? Default: ``True``. debug: ``False`` Debug mode. Will insert a new key in the output dictionary, as ``loaded_config`` containing the raw configuration loaded on the device. replace: ``True`` Load and replace the configuration. Default: ``True``. CLI Example: .. code-block:: bash salt '*' net.blockreplace 'ntp' 'interface' '' r� r r/ zfile.blockreplace)� marker_start� marker_end�contentr� r� r� �append_newliner� Nr4 r� r� )r� r� r� r� r� r� r� rF r� rX r r$ r7 r� r� r� r� r r r � blockreplace� s( Z � � �r� c C s� t ||d�} | r | d s| S | d }td | �} | du r&ddd| � d�d �S td || |d �} tjj�|d �� }|�� }W d � n1 sFw Y td ||| | |d�S )a, .. versionadded:: 2019.2.0 Apply a patch to the configuration source, and load the result into the running config of the device. patchfile A patch file to apply to the configuration source. options Options to pass to patch. source_hash If the patch file (specified via the ``patchfile`` argument) is an HTTP(S) or FTP URL and the file exists in the minion's file cache, this option can be passed to keep the minion from re-downloading the file if the cached copy matches the specified hash. show_changes: ``True`` Controls how changes are presented. If ``True``, this function will return the of the changes made. If ``False``, then it will return a boolean (``True`` if any changes were made, otherwise False). source: ``running`` The configuration source. Choose from: ``running``, ``candidate``, or ``startup``. Default: ``running``. path: ``None`` Save the temporary configuration to a specific path, then read from there. This argument is optional, can the user prefers a particular location of the temporary file. test: ``False`` Dry run? If set as ``True``, will apply the config, discard and return the changes. Default: ``False`` and will commit the changes on the device. commit: ``True`` Commit the configuration changes? Default: ``True``. debug: ``False`` Debug mode. Will insert a new key in the output dictionary, as ``loaded_config`` containing the raw configuration loaded on the device. replace: ``True`` Load and replace the configuration. Default: ``True``. CLI Example: .. code-block:: bash salt '*' net.patch https://example.com/running_config.patch r� r r/ z cp.cache_fileFNz The file "z" does not exist.)r/ r r z file.patch)�optionsr� r4 r� r� )Z patchfiler� ru r� r� rF r� rX r r$ r7 r� Zpatchfile_cacher� r� r� r r r �patch, s" C � � �r� ) FFFTNNNNNN)NNNN)NNNNNN)r- r- r- )r- )r- r- r )N) NNFTFFNNNNNNrv )NNNNr� rv NNFFTFFNNNNN)NN)r r� r! FFNFTFNNFTFT) r- FFTFrD NFTFT) r- rv NTrD NFTFT)7�__doc__rG �loggingrW Zsalt.utils.filesr Zsalt.utils.napalmZsalt.utils.templatesZsalt.utils.versions� getLogger�__name__r# ZjxmleaserU � ImportErrorr Z__proxyenabled__Z__virtual_aliases__r r r r r r& rc r r Zproxy_napalm_wrapre ri rj rm r~ r� r� r� r� r� r� r� r� r� r� r r% rI r� r� r� rM r� r� r� r� r� r r r r �<module> sV � � ] 3 ? R �- �< �= 7 * : D 1 / � � v � � �! �- ) � �q�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings