Current File : //lib/python3.9/site-packages/ansible/plugins/netconf/__pycache__/__init__.cpython-39.pyc
a
�)g�B �
@ s d dl mZmZmZ eZd dlmZ d dlm Z d dl
m Z d dl m
Z
d dlmZ d dlmZ z,d dlmZ d d lmZmZmZ d
Zd ZW n, ey� Z zd ZeZW Y d Z[n
d Z[0 0 z d d
l m Z m Z m Z m Z W n, e!�y d d
l"m Z m Z m Z m Z Y n0 dd� Z#G dd� de
�Z$d S )� )�absolute_import�division�print_function)�abstractmethod��wraps)� AnsibleError)�
AnsiblePlugin)� to_native)�missing_required_lib)�RPCError)�to_xml�to_ele� NCElementTNF)�Element�
SubElement�tostring�
fromstringc s t � �� fdd��}|S )Nc s2 t s tdtd�tt�f ��� | g|�R i |��S )Nz%s: %sZncclient)� HAS_NCCLIENTr r r
�NCCLIENT_IMP_ERR)�self�args�kwargs��func� �D/usr/lib/python3.9/site-packages/ansible/plugins/netconf/__init__.py�wrapped1 s z ensure_ncclient.<locals>.wrappedr )r r r r r �ensure_ncclient0 s r c s� e Zd ZdZg d�Z� fdd�Zedd� �Zdd� Zd3d
d �Z d4d d
�Z
d5dd�Z d6dd�Z dd� Z
d7dd�Zd8dd�Zd9dd�Zd d � Zd:d d �Zd;d!d"�Zd#d$� Zd%d&� Zed'd(� �Zed)d*� �Zd+d,� Zd-d.� Zd/d0� Z d1d2� Z � Z S )<� NetconfBasea]
A base class for implementing Netconf connections
.. note:: Unlike most of Ansible, nearly all strings in
:class:`TerminalBase` plugins are byte strings. This is because of
how close to the underlying platform these plugins operate. Remember
to mark literal strings as byte string (``b"string"``) and to use
:func:`~ansible.module_utils._text.to_bytes` and
:func:`~ansible.module_utils._text.to_text` to avoid unexpected
problems.
List of supported rpc's:
:get: Retrieves running configuration and device state information
:get_config: Retrieves the specified configuration from the device
:edit_config: Loads the specified commands into the remote device
:commit: Load configuration from candidate to running
:discard_changes: Discard changes to candidate datastore
:validate: Validate the contents of the specified configuration.
:lock: Allows the client to lock the configuration system of a device.
:unlock: Release a configuration lock, previously obtained with the lock operation.
:copy_config: create or replace an entire configuration datastore with the contents of another complete
configuration datastore.
:get-schema: Retrieves the required schema from the device
:get_capabilities: Retrieves device information and supported rpc methods
For JUNOS:
:execute_rpc: RPC to be execute on remote device
:load_configuration: Loads given configuration on device
Note: rpc support depends on the capabilities of remote device.
:returns: Returns output received from remote device as byte string
Note: the 'result' or 'error' from response should to be converted to object
of ElementTree using 'fromstring' to parse output as xml doc
'get_capabilities()' returns 'result' as a json string.
Usage:
from ansible.module_utils.connection import Connection
conn = Connection()
data = conn.execute_rpc(rpc)
reply = fromstring(reply)
data = conn.get_capabilities()
json.loads(data)
conn.load_configuration(config=[''set system ntp server 1.1.1.1''], action='set', format='text')
)�rpc�
get_config�get� edit_config�validate� copy_config�dispatch�lock�unlock�discard_changes�commit�
get_schema�
delete_config�get_device_operationsc s t t| ��� || _d S �N)�superr �__init__� _connection)r Z
connection�� __class__r r r0 o s zNetconfBase.__init__c C s | j jS r. )r1 Zmanager�r r r r �ms s z
NetconfBase.mc
C sh z,t |�}| j�|�}t|d�r&|jn|jW S tyb } z |j}tt|���W Y d}~n
d}~0 0 dS )z�
RPC to be execute on remote device
:param name: Name of rpc in string format
:return: Received rpc response from remote host
�data_xmlN) r r5 r �hasattrr6 �xmlr � Exceptionr
)r �name�obj�resp�exc�msgr r r r w s zNetconfBase.rpcNc C s@ t |t�rt|�}|sd}| jj||d�}t|d�r:|jS |jS )a�
Retrieve all or part of a specified configuration
(by default entire configuration is retrieved).
:param source: Name of the configuration datastore being queried, defaults to running datastore
:param filter: This argument specifies the portion of the configuration data to retrieve
:return: Returns xml string containing the RPC response received from remote host
�running��source�filterr6 )�
isinstance�list�tupler5 r! r7 r6 r8 )r rA rB r< r r r r! � s
zNetconfBase.get_configc C s< t |t�rt|�}| jj||d�}t|d�r2|jn|j}|S )a�
Retrieve device configuration and state information.
:param filter: This argument specifies the portion of the state data to retrieve
(by default entire state data is retrieved)
:param with_defaults: defines an explicit method of retrieving default values
from the configuration
:return: Returns xml string containing the RPC response received from remote host
)rB �
with_defaultsr6 )rC rD rE r5 r" r7 r6 r8 )r rB rF r< Zresponser r r r" � s
zNetconfBase.getr8 � candidatec C s> |du rt d��| jj||||||d�}t|d�r8|jS |jS )a�
Loads all or part of the specified *config* to the *target* configuration datastore.
:param config: Is the configuration, which must be rooted in the `config` element.
It can be specified either as a string or an :class:`~xml.etree.ElementTree.Element`.
:param format: The format of configuration eg. xml, text
:param target: Is the name of the configuration datastore being edited
:param default_operation: If specified must be one of { `"merge"`, `"replace"`, or `"none"` }
:param test_option: If specified must be one of { `"test_then_set"`, `"set"` }
:param error_option: If specified must be one of { `"stop-on-error"`, `"continue-on-error"`, `"rollback-on-error"` }
The `"rollback-on-error"` *error_option* depends on the `:rollback-on-error` capability.
:return: Returns xml string containing the RPC response received from remote host
Nz config value must be provided)�format�target�default_operation� test_option� error_optionr6 )�
ValueErrorr5 r# r7 r6 r8 )r ZconfigrH rI rJ rK rL r< r r r r# � s
�zNetconfBase.edit_configc C s$ | j j|d�}t|d�r |jS |jS )aS
Validate the contents of the specified configuration.
:param source: Is the name of the configuration datastore being validated or `config` element
containing the configuration subtree to be validated
:return: Returns xml string containing the RPC response received from remote host
)rA r6 )r5 r$ r7 r6 r8 )r rA r< r r r r$ � s zNetconfBase.validatec C s$ | j �||�}t|d�r |jS |jS )a
Create or replace an entire configuration datastore with the contents of another complete configuration datastore.
:param source: Is the name of the configuration datastore to use as the source of the copy operation or `config`
element containing the configuration subtree to copy
:param target: Is the name of the configuration datastore to use as the destination of the copy operation
:return: Returns xml string containing the RPC response received from remote host
r6 )r5 r% r7 r6 r8 )r rA rI r< r r r r% � s zNetconfBase.copy_configc C sZ |du rt d��| jjt|�||d�}t|t�r8|j}n t|d�rP|jrP|j}n|j }|S )a�
Execute rpc on the remote device eg. dispatch('clear-arp-table')
:param rpc_command: specifies rpc command to be dispatched either in plain text or in xml element format (depending on command)
:param source: name of the configuration datastore being queried
:param filter: specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
:return: Returns xml string containing the RPC response received from remote host
Nz"rpc_command value must be providedr@ �data_ele)
rM r5 r& r rC r r6 r7 rN r8 )r Z rpc_commandrA rB r< �resultr r r r& � s
zNetconfBase.dispatchc C s$ | j j|d�}t|d�r |jS |jS )a.
Allows the client to lock the configuration system of a device.
:param target: is the name of the configuration datastore to lock,
defaults to candidate datastore
:return: Returns xml string containing the RPC response received from remote host
�rI r6 )r5 r' r7 r6 r8 �r rI r< r r r r' � s zNetconfBase.lockc C s$ | j j|d�}t|d�r |jS |jS )a:
Release a configuration lock, previously obtained with the lock operation.
:param target: is the name of the configuration datastore to unlock,
defaults to candidate datastore
:return: Returns xml string containing the RPC response received from remote host
rP r6 )r5 r( r7 r6 r8 rQ r r r r( � s zNetconfBase.unlockc C s | j �� }t|d�r|jS |jS )z�
Revert the candidate configuration to the currently running configuration.
Any uncommitted changes are discarded.
:return: Returns xml string containing the RPC response received from remote host
r6 )r5 r) r7 r6 r8 )r r< r r r r) � s
zNetconfBase.discard_changesFc C s( | j j|||d�}t|d�r"|jS |jS )az
Commit the candidate configuration as the device's new current configuration.
Depends on the `:candidate` capability.
A confirmed commit (i.e. if *confirmed* is `True`) is reverted if there is no
followup commit within the *timeout* interval. If no timeout is specified the
confirm timeout defaults to 600 seconds (10 minutes).
A confirming commit may have the *confirmed* parameter but this is not required.
Depends on the `:confirmed-commit` capability.
:param confirmed: whether this is a confirmed commit
:param timeout: specifies the confirm timeout in seconds
:param persist: make the confirmed commit survive a session termination,
and set a token on the ongoing confirmed commit
:return: Returns xml string containing the RPC response received from remote host
)� confirmed�timeout�persistr6 )r5 r* r7 r6 r8 )r rR rS rT r< r r r r* s zNetconfBase.commitc C s( | j j|||d�}t|d�r"|jS |jS )ae
Retrieve a named schema, with optional revision and type.
:param identifier: name of the schema to be retrieved
:param version: version of schema to get
:param format: format of the schema to be retrieved, yang is the default
:return: Returns xml string containing the RPC response received from remote host
)�versionrH r6 )r5 r+ r7 r6 r8 )r Z
identifierrU rH r< r r r r+ s zNetconfBase.get_schemac C s" | j �|�}t|d�r |jS |jS )z�
delete a configuration datastore
:param target: specifies the name or URL of configuration datastore to delete
:return: Returns xml string containing the RPC response received from remote host
r6 )r5 r, r7 r6 r8 rQ r r r r, ! s zNetconfBase.delete_configc C s | j �|�S r. )r5 �locked)r rI r r r rV * s zNetconfBase.lockedc C s dS )z�
Retrieves device information and supported
rpc methods by device platform and return result
as a string
:return: Netconf session capability
Nr r4 r r r �get_capabilities- s z NetconfBase.get_capabilitiesc C s dS )z�
Identifies the operating system of network device.
:param obj: ncclient manager connection instance
:return: The name of network operating system.
Nr )r; r r r �guess_network_os7 s z NetconfBase.guess_network_osc C s | j S )zs
Returns list of base rpc method supported by remote device
:return: List of RPC supported
)�__rpc__r4 r r r � get_base_rpc@ s zNetconfBase.get_base_rpcc C s dS )z�
Copies file to remote host
:param source: Source location of file
:param destination: Destination file path
:return: Returns xml string containing the RPC response received from remote host
Nr �r rA Z destinationr r r �put_fileG s zNetconfBase.put_filec C s dS )z�
Fetch file from remote host
:param source: Source location of file
:param destination: Source location of file
:return: Returns xml string containing the RPC response received from remote host
Nr r[ r r r �
fetch_fileP s zNetconfBase.fetch_filec C s� i }d� |�}d|v |d< d|v |d< d|v |d< d|v |d < d
|v |d < d |v |d
< d|v |d< g |d< |d
r�|d �d� |d r�|d �d� |d r�|d �d� t|d �|d< |S )z�
Retrieve remote host capability from Netconf server hello message.
:param server_capabilities: Server capabilities received during Netconf session initialization
:return: Remote host capabilities in dictionary format
�
z
:candidateZsupports_commitz:with-defaultsZsupports_defaultsz:confirmed-commitZsupports_confirm_commitz:startupZsupports_startupz:xpathZsupports_xpathz:writable-runningZsupports_writable_runningz :validateZsupports_validateZlock_datastorer? rG ZstartupZ
supports_lock)�join�append�bool)r Zserver_capabilitiesZ
operationsZ capabilitiesr r r r- Y s$
z!NetconfBase.get_device_operations)NN)NN)Nr8 rG NNN)rG )NNN)rG )rG )FNN)NNN) �__name__�
__module__� __qualname__�__doc__rY r0 �propertyr5 r r! r" r# r$ r% r& r' r( r) r* r+ r, rV r rW � staticmethodrX rZ r\ r] r- �
__classcell__r r r2 r r 9 s6 2
r )%Z
__future__r r r �typeZ
__metaclass__�abcr � functoolsr Zansible.errorsr Zansible.pluginsr Zansible.module_utils._textr
Zansible.module_utils.basicr Zncclient.operationsr Z
ncclient.xml_r
r r r r r9 �errZ
lxml.etreer r r r � ImportErrorZxml.etree.ElementTreer r r r r r �<module> s*
Mini Shell