Current File : //lib/python3.9/site-packages/ansible/plugins/cliconf/__pycache__/__init__.cpython-39.pyc
a
�)g$Y � @ s� d dl mZmZmZ eZd dlmZ d dlm Z d dl
m Z d dl m
Z
mZ d dlmZmZ zd dlmZ dZW n ey� d ZY n0 d
d � ZG d d
� d
e �ZdS )� )�absolute_import�division�print_function)�abstractmethod��wraps)�
AnsiblePlugin)� AnsibleError�AnsibleConnectionFailure)�to_bytes�to_text)� SCPClientTFc s t � �� fdd��}|S )Nc s> | j �� }t|dd��� �d�s(td��� | g|�R i |��S )NZsurrogate_or_strict��errors�#z'operation requires privilege escalation)� _connection�
get_promptr �strip�endswithr )�self�args�kwargs�prompt��func� �D/usr/lib/python3.9/site-packages/ansible/plugins/cliconf/__init__.py�wrapped% s
z enable_mode.<locals>.wrappedr )r r r r r � enable_mode$ s r c s e Zd ZdZg d�Z� fdd�Zdd� Zd8d
d �Zd d
� Zdd� Z dd� Z
dd� Z dd� Z e
d9dd��Ze
d:dd��Ze
d;dd ��Ze
d d � �Ze
d d � �Zd<d!d"�Zd#d$� Zd=d%d&�Zd>d)d*�Zd?d+d,�Zd@d-d.�ZdAd/d0�ZdBd1d2�Zd3d4� ZdCd6d7�Z � Z S )D� CliconfBasea"
A base class for implementing cli connections
.. note:: String inputs to :meth:`send_command` will be cast to byte strings
within this method and as such are not required to be made byte strings
beforehand. Please avoid using literal byte strings (``b'string'``) in
:class:`CliConfBase` plugins as this can lead to unexpected errors when
running on Python 3
List of supported rpc's:
:get_config: Retrieves the specified configuration from the device
:edit_config: Loads the specified commands into the remote device
:get: Execute specified command on remote device
:get_capabilities: Retrieves device information and supported rpc methods
:commit: Load configuration from candidate to running
:discard_changes: Discard changes to candidate datastore
Note: List of supported rpc's for remote device can be extracted from
output of get_capabilities()
:returns: Returns output received from remote device as byte string
Usage:
from ansible.module_utils.connection import Connection
conn = Connection()
conn.get('show lldp neighbors detail')
conn.get_config('running')
conn.edit_config(['hostname test', 'netconf ssh'])
)�
get_config� edit_config�get_capabilities�get�enable_response_logging�disable_response_loggingc s& t t| ��� || _t� | _d| _d S )NF)�superr �__init__r �list�history�response_logging)r Z
connection�� __class__r r r' P s zCliconfBase.__init__c C s$ | j �dd| j jj � | �� dS )z0Alarm handler raised in case of command timeout �logz2closing shell due to command timeout (%s seconds).N)r �
queue_message�
_play_context�timeout�close)r Zsignum�framer r r �_alarm_handlerV s zCliconfBase._alarm_handlerNFTc
C s� t |�||||d�}|durFt|t�r:dd� |D �|d< n t |�|d< |durxt|t�rldd� |D �|d< n t |�|d< | jjf i |��} | js�| j�d� n| j�|d | f� | S )
a Executes a command over the device connection
This method will execute a command over the device connection and
return the results to the caller. This method will also perform
logging of any commands based on the `nolog` argument.
:param command: The command to send over the connection to the device
:param prompt: A single regex pattern or a sequence of patterns to evaluate the expected prompt from the command
:param answer: The answer to respond with if the prompt is matched.
:param sendonly: Bool value that will send the command but not wait for a result.
:param newline: Bool value that will append the newline character to the command
:param prompt_retry_check: Bool value for trying to detect more prompts
:param check_all: Bool value to indicate if all the values in prompt sequence should be matched or any one of
given prompt.
:returns: The output from the device after executing the command
)�command�sendonly�newline�prompt_retry_check� check_allNc S s g | ] }t |��qS r �r ��.0�pr r r �
<listcomp>v � z,CliconfBase.send_command.<locals>.<listcomp>r c S s g | ] }t |��qS r r9 r: r r r r= { r> �answer)�*****r@ r4 )r �
isinstancer( r �sendr* r) �append)
r r4 r r? r5 r6 r7 r8 r Zrespr r r � send_command[ s& �
zCliconfBase.send_commandc C s | j S )z:Returns list of base rpc method supported by remote device)�__rpc__�r r r r � get_base_rpc� s zCliconfBase.get_base_rpcc C s | j S )aR Returns the history file for all commands
This will return a log of all the commands that have been sent to
the device and all of the output received. By default, all commands
and output will be redacted unless explicitly configured otherwise.
:return: An ordered list of command, output pairs
)r) rF r r r � get_history� s zCliconfBase.get_historyc C s t � | _dS )zB Resets the history of run commands
:return: None
N)r( r) rF r r r �
reset_history� s zCliconfBase.reset_historyc C s
d| _ dS )z Enable logging command responseTN�r* rF r r r r$ � s z#CliconfBase.enable_response_loggingc C s
d| _ dS )z Disable logging command responseFNrJ rF r r r r% � s z$CliconfBase.disable_response_logging�runningc C s dS )a� Retrieves the specified configuration from the device
This method will retrieve the configuration specified by source and
return it to the caller as a string. Subsequent calls to this method
will retrieve a new configuration from the device
:param source: The configuration source to return from the device.
This argument accepts either `running` or `startup` as valid values.
:param flags: For devices that support configuration filtering, this
keyword argument is used to filter the returned configuration.
The use of this keyword argument is device dependent and will be
silently ignored on devices that do not support it.
:param format: For devices that support fetching different configuration
format, this keyword argument is used to specify the format in which
configuration is to be retrieved.
:return: The device configuration as specified by the source argument.
Nr )r �source�flags�formatr r r r � s zCliconfBase.get_configc C s dS )ae Loads the candidate configuration into the network device
This method will load the specified candidate config into the device
and merge with the current configuration unless replace is set to
True. If the device does not support config replace an errors
is returned.
:param candidate: The configuration to load into the device and merge
with the current running configuration
:param commit: Boolean value that indicates if the device candidate
configuration should be pushed in the running configuration or discarded.
:param replace: If the value is True/False it indicates if running configuration should be completely
replace by candidate configuration. If can also take configuration file path as value,
the file in this case should be present on the remote host in the mentioned path as a
prerequisite.
:param comment: Commit comment provided it is supported by remote host
:return: Returns a json string with contains configuration applied on remote host, the returned
response on executing configuration commands and platform relevant data.
{
"diff": "",
"response": [],
"request": []
}
Nr )r � candidate�commit�replace�diff�commentr r r r! � s zCliconfBase.edit_configc C s dS )a. Execute specified command on remote device
This method will retrieve the specified data and
return it to the caller as a string.
:param command: command in string format to be executed on remote device
:param prompt: the expected prompt generated by executing command, this can
be a string or a list of strings
:param answer: the string to respond to the prompt with
:param sendonly: bool to disable waiting for response, default is false
:param newline: bool to indicate if newline should be added at end of answer or not
:param output: For devices that support fetching command output in different
format, this keyword argument is used to specify the output in which
response is to be retrieved.
:param check_all: Bool value to indicate if all the values in prompt sequence should be matched or any one of
given prompt.
:return: The output from the device after executing the command
Nr )r r4 r r? r5 r6 �outputr8 r r r r# � s zCliconfBase.getc C s( i }| � � |d< | �� |d< d|d< |S )a;
Returns the basic capabilities of the network device
This method will provide some basic facts about the device and
what capabilities it has to modify the configuration. The minimum
return from this method takes the following format.
eg:
{
'rpc': [list of supported rpcs],
'network_api': <str>, # the name of the transport
'device_info': {
'network_os': <str>,
'network_os_version': <str>,
'network_os_model': <str>,
'network_os_hostname': <str>,
'network_os_image': <str>,
'network_os_platform': <str>,
},
'device_operations': {
'supports_diff_replace': <bool>, # identify if config should be merged or replaced is supported
'supports_commit': <bool>, # identify if commit is supported by device or not
'supports_rollback': <bool>, # identify if rollback is supported or not
'supports_defaults': <bool>, # identify if fetching running config with default is supported
'supports_commit_comment': <bool>, # identify if adding comment to commit is supported of not
'supports_onbox_diff': <bool>, # identify if on box diff capability is supported or not
'supports_generate_diff': <bool>, # identify if diff capability is supported within plugin
'supports_multiline_delimiter': <bool>, # identify if multiline demiliter is supported within config
'supports_diff_match': <bool>, # identify if match is supported
'supports_diff_ignore_lines': <bool>, # identify if ignore line in diff is supported
'supports_config_replace': <bool>, # identify if running config replace with candidate config is supported
'supports_admin': <bool>, # identify if admin configure mode is supported or not
'supports_commit_label': <bool>, # identify if commit label is supported or not
}
'format': [list of supported configuration format],
'diff_match': [list of supported match values],
'diff_replace': [list of supported replace values],
'output': [list of supported command output format]
}
:return: capability as json string
ZrpcZ device_infoZcliconfZ network_api)rG �get_device_info)r �resultr r r r" � s
) z CliconfBase.get_capabilitiesc C s dS )aC Returns basic information about the network device.
This method will provide basic information about the device such as OS version and model
name. This data is expected to be used to fill the 'device_info' key in get_capabilities()
above.
:return: dictionary of device information
Nr rF r r r rU s
zCliconfBase.get_device_infoc C s | j �d| jj �S )a� Commit configuration changes
This method will perform the commit operation on a previously loaded
candidate configuration that was loaded using `edit_config()`. If
there is a candidate configuration, it will be committed to the
active configuration. If there is not a candidate configuration, this
method should just silently return.
:return: None
z(commit is not supported by network_os %s�r Zmethod_not_foundr/ Z
network_os)r rS r r r rP + s zCliconfBase.commitc C s | j �d| jj �S )a Discard candidate configuration
This method will discard the current candidate configuration if one
is present. If there is no candidate configuration currently loaded,
then this method should just silently return
:returns: None
z1discard_changes is not supported by network_os %srW rF r r r �discard_changes8 s zCliconfBase.discard_changesc C s dS )z�
:param rollback_id: The commit id to which configuration should be rollbacked
:param commit: Flag to indicate if changes should be committed or not
:return: Returns diff between before and after change.
Nr )r Z rollback_idrP r r r �rollbackC s zCliconfBase.rollback�scp� c C s� | j j�� }|dkr^ts td��t|�� |d�� }|�||�}W d � q�1 sR0 Y n<|dkr�|�� � }|�||� W d � n1 s�0 Y dS )a� Copies file over scp/sftp to remote device
:param source: Source file path
:param destination: Destination file path on remote device
:param proto: Protocol to be used for file transfer,
supported protocol: scp and sftp
:param timeout: Specifies the wait time to receive response from
remote host before triggering timeout exception
:return: None
rZ �QRequired library scp is not installed. Please install it using `pip install scp`�Zsocket_timeoutN�sftp) r �
paramiko_conn�_connect_uncached�HAS_SCPr r
�
get_transportZput� open_sftp) r rL � destination�protor0 �sshrZ �outr^ r r r � copy_fileL s ,
zCliconfBase.copy_filec C s� | j j�� }|dkrvts td��z@t|�� |d�� }|�||� W d � n1 sT0 Y W q� tyr Y q�0 n<|dkr�|� � � }|�||� W d � n1 s�0 Y dS )a� Fetch file over scp/sftp from remote device
:param source: Source file path
:param destination: Destination file path
:param proto: Protocol to be used for file transfer,
supported protocol: scp and sftp
:param timeout: Specifies the wait time to receive response from
remote host before triggering timeout exception
:return: None
rZ r\ r] Nr^ )
r r_ r` ra r r
rb r# �EOFErrorrc )r rL rd re r0 rf rZ r^ r r r �get_filea s .
zCliconfBase.get_filec C s dS )a:
Generate diff between candidate and running configuration. If the
remote host supports onbox diff capabilities ie. supports_onbox_diff in that case
candidate and running configurations are not required to be passed as argument.
In case if onbox diff capability is not supported candidate argument is mandatory
and running argument is optional.
:param candidate: The configuration which is expected to be present on remote host.
:param running: The base configuration which is used to generate diff.
:param diff_match: Instructs how to match the candidate configuration with current device configuration
Valid values are 'line', 'strict', 'exact', 'none'.
'line' - commands are matched line by line
'strict' - command lines are matched with respect to position
'exact' - command lines must be an equal match
'none' - will not compare the candidate configuration with the running configuration
:param diff_ignore_lines: Use this argument to specify one or more lines that should be
ignored during the diff. This is used for lines in the configuration
that are automatically updated by the system. This argument takes
a list of regular expressions or exact line matches.
:param path: The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top
level or global commands.
:param diff_replace: Instructs on the way to perform the configuration on the device.
If the replace argument is set to I(line) then the modified lines are
pushed to the device in configuration mode. If the replace argument is
set to I(block) then the entire command block is pushed to the device in
configuration mode if any line is not correct.
:return: Configuration and/or banner diff in json format.
{
'config_diff': ''
}
Nr )r rO rK Z
diff_matchZdiff_ignore_lines�pathZ diff_replacer r r �get_diffz s "zCliconfBase.get_diffc C s dS )aI
Execute a list of commands on remote host and return the list of response
:param commands: The list of command that needs to be executed on remote host.
The individual command in list can either be a command string or command dict.
If the command is dict the valid keys are
{
'command': <command to be executed>
'prompt': <expected prompt on executing the command>,
'answer': <answer for the prompt>,
'output': <the format in which command output should be rendered eg: 'json', 'text'>,
'sendonly': <Boolean flag to indicate if it command execution response should be ignored or not>
}
:param check_rc: Boolean flag to check if returned response should be checked for error or not.
If check_rc is False the error output is appended in return response list, else if the
value is True an exception is raised.
:return: List of returned response
Nr )r ZcommandsZcheck_rcr r r � run_commands� s zCliconfBase.run_commandsc C sl |s|st d��|dvr$t d| ��|r8|d s8t d��|rP|�dd�sPt d��|rh|�dd�sht d��d S ) Nz9must provide a candidate or replace to load configuration)TFz 'commit' must be a bool, got %sZsupports_replacez&configuration replace is not supportedZsupports_commit_commentFz commit comment is not supported)�
ValueErrorr# )r Z
operationsrO rP rQ rS r r r � check_edit_config_capability� s z(CliconfBase.check_edit_config_capabilityc C s dS )z\
Ensure the command prompt on device is in right mode
:return: None
Nr rF r r r �set_cli_prompt_context� s z"CliconfBase.set_cli_prompt_context�exitc C sn | j �� }|du r$td| j j d��t|dd��� }|rj|�|�rj| j �dd� | �|� | j �� }q$qjq$dS )a&
Update the cli prompt context to ensure it is in operational mode
:param config_context: It is string value to identify if the current cli prompt ends with config mode prompt
:param exit_command: Command to execute to exit the config mode
:return: None
NzGcli prompt is not identified from the last received response window: %s)�messageZsurrogate_then_replacer Zvvvvz%wrong context, sending exit to device) r r r
Z_last_recv_windowr r r r. rD )r Zconfig_contextZ exit_commandrg r r r �_update_cli_prompt_context� s
�
z&CliconfBase._update_cli_prompt_context)NNNFTFF)rK NN)NTNFN)NNNFTNF)N)T)NNrZ r[ )NNrZ r[ )NNNNNN)NT)NTNN)Nrq ) �__name__�
__module__� __qualname__�__doc__rE r' r3 rD rG rH rI r$ r% r r r! r# r" rU rP rX rY rh rj rl rm ro rp rs �
__classcell__r r r+ r r . s<
-
.
$
r N)Z
__future__r r r �typeZ
__metaclass__�abcr � functoolsr Zansible.pluginsr Zansible.errorsr r
Zansible.module_utils._textr r rZ r
ra � ImportErrorr r r r r r �<module> s
Mini Shell