Current File : //lib/python3.9/site-packages/ansible/modules/__pycache__/wait_for.cpython-39.pyc
a
�)g�g � @ s< d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
d dl Z d dl Z d dl
Z
d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlmZmZ d dlmZ d dlmZ d Z dZ zd dl Z d
Z W n e y� e� � Z Y n0 G d d � d e!�Z"G d
d� de"�Z#dd� Z$dd� Z%dd� Z&dd� Z'dd� Z(e)dk�r8e(� dS )� )�absolute_import�division�print_functiona�
---
module: wait_for
short_description: Waits for a condition before continuing
description:
- You can wait for a set amount of time C(timeout), this is the default if nothing is specified or just C(timeout) is specified.
This does not produce an error.
- Waiting for a port to become available is useful for when services are not immediately available after their init scripts return
which is true of certain Java application servers.
- It is also useful when starting guests with the M(community.libvirt.virt) module and needing to pause until they are ready.
- This module can also be used to wait for a regex match a string to be present in a file.
- In Ansible 1.6 and later, this module can also be used to wait for a file to be available or
absent on the filesystem.
- In Ansible 1.8 and later, this module can also be used to wait for active connections to be closed before continuing, useful if a node
is being rotated out of a load balancer pool.
- For Windows targets, use the M(ansible.windows.win_wait_for) module instead.
version_added: "0.7"
options:
host:
description:
- A resolvable hostname or IP address to wait for.
type: str
default: 127.0.0.1
timeout:
description:
- Maximum number of seconds to wait for, when used with another condition it will force an error.
- When used without other conditions it is equivalent of just sleeping.
type: int
default: 300
connect_timeout:
description:
- Maximum number of seconds to wait for a connection to happen before closing and retrying.
type: int
default: 5
delay:
description:
- Number of seconds to wait before starting to poll.
type: int
default: 0
port:
description:
- Port number to poll.
- C(path) and C(port) are mutually exclusive parameters.
type: int
active_connection_states:
description:
- The list of TCP connection states which are counted as active connections.
type: list
elements: str
default: [ ESTABLISHED, FIN_WAIT1, FIN_WAIT2, SYN_RECV, SYN_SENT, TIME_WAIT ]
version_added: "2.3"
state:
description:
- Either C(present), C(started), or C(stopped), C(absent), or C(drained).
- When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed, C(drained) will check for active connections.
- When checking for a file or a search string C(present) or C(started) will ensure that the file or string is present before continuing,
C(absent) will check that file is absent or removed.
type: str
choices: [ absent, drained, present, started, stopped ]
default: started
path:
description:
- Path to a file on the filesystem that must exist before continuing.
- C(path) and C(port) are mutually exclusive parameters.
type: path
version_added: "1.4"
search_regex:
description:
- Can be used to match a string in either a file or a socket connection.
- Defaults to a multiline regex.
type: str
version_added: "1.4"
exclude_hosts:
description:
- List of hosts or IPs to ignore when looking for active TCP connections for C(drained) state.
type: list
elements: str
version_added: "1.8"
sleep:
description:
- Number of seconds to sleep between checks.
- Before Ansible 2.3 this was hardcoded to 1 second.
type: int
default: 1
version_added: "2.3"
msg:
description:
- This overrides the normal error message from a failure to meet the required conditions.
type: str
version_added: "2.4"
extends_documentation_fragment: action_common_attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
platform:
platforms: posix
notes:
- The ability to use search_regex with a port connection was added in Ansible 1.7.
- Prior to Ansible 2.4, testing for the absence of a directory or UNIX socket did not work correctly.
- Prior to Ansible 2.4, testing for the presence of a file did not work correctly if the remote user did not have read access to that file.
- Under some circumstances when using mandatory access control, a path may always be treated as being absent even if it exists, but
can't be modified or created by the remote user either.
- When waiting for a path, symbolic links will be followed. Many other modules that manipulate files do not follow symbolic links,
so operations on the path using other modules may not work exactly as expected.
seealso:
- module: ansible.builtin.wait_for_connection
- module: ansible.windows.win_wait_for
- module: community.windows.win_wait_for_process
author:
- Jeroen Hoekx (@jhoekx)
- John Jarvis (@jarv)
- Andrii Radyk (@AnderEnder)
a_
- name: Sleep for 300 seconds and continue with play
ansible.builtin.wait_for:
timeout: 300
delegate_to: localhost
- name: Wait for port 8000 to become open on the host, don't start checking for 10 seconds
ansible.builtin.wait_for:
port: 8000
delay: 10
- name: Waits for port 8000 of any IP to close active connections, don't start checking for 10 seconds
ansible.builtin.wait_for:
host: 0.0.0.0
port: 8000
delay: 10
state: drained
- name: Wait for port 8000 of any IP to close active connections, ignoring connections for specified hosts
ansible.builtin.wait_for:
host: 0.0.0.0
port: 8000
state: drained
exclude_hosts: 10.2.1.2,10.2.1.3
- name: Wait until the file /tmp/foo is present before continuing
ansible.builtin.wait_for:
path: /tmp/foo
- name: Wait until the string "completed" is in the file /tmp/foo before continuing
ansible.builtin.wait_for:
path: /tmp/foo
search_regex: completed
- name: Wait until regex pattern matches in the file /tmp/foo and print the matched group
ansible.builtin.wait_for:
path: /tmp/foo
search_regex: completed (?P<task>\w+)
register: waitfor
- ansible.builtin.debug:
msg: Completed {{ waitfor['match_groupdict']['task'] }}
- name: Wait until the lock file is removed
ansible.builtin.wait_for:
path: /var/lock/file.lock
state: absent
- name: Wait until the process is finished and pid was destroyed
ansible.builtin.wait_for:
path: /proc/3466/status
state: absent
- name: Output customized message when failed
ansible.builtin.wait_for:
path: /tmp/foo
state: present
msg: Timeout to find file /tmp/foo
# Do not assume the inventory_hostname is resolvable and delay 10 seconds at start
- name: Wait 300 seconds for port 22 to become open and contain "OpenSSH"
ansible.builtin.wait_for:
port: 22
host: '{{ (ansible_ssh_host|default(ansible_host))|default(inventory_hostname) }}'
search_regex: OpenSSH
delay: 10
connection: local
# Same as above but you normally have ansible_connection set in inventory, which overrides 'connection'
- name: Wait 300 seconds for port 22 to become open and contain "OpenSSH"
ansible.builtin.wait_for:
port: 22
host: '{{ (ansible_ssh_host|default(ansible_host))|default(inventory_hostname) }}'
search_regex: OpenSSH
delay: 10
vars:
ansible_connection: local
at
elapsed:
description: The number of seconds that elapsed while waiting
returned: always
type: int
sample: 23
match_groups:
description: Tuple containing all the subgroups of the match as returned by U(https://docs.python.org/3/library/re.html#re.MatchObject.groups)
returned: always
type: list
sample: ['match 1', 'match 2']
match_groupdict:
description: Dictionary containing all the named subgroups of the match, keyed by the subgroup name,
as returned by U(https://docs.python.org/3/library/re.html#re.MatchObject.groupdict)
returned: always
type: dict
sample:
{
'group': 'match'
}
N)�
AnsibleModule�missing_required_lib)�get_platform_subclass)�to_bytesFTc sZ e Zd ZdZdZdZejdejdiZ ddd�Z
� fd d
�Z d d � Z d
d� Z
dd� Z� ZS )�TCPConnectionInfoa�
This is a generic TCP Connection Info strategy class that relies
on the psutil module, which is not ideal for targets, but necessary
for cross platform support.
A subclass may wish to override some or all of these methods.
- _get_exclude_ips()
- get_active_connections()
All subclasses MUST define platform and distribution (which may be None).
�GenericNz0.0.0.0z::z::ffffz::ffff:0.0.0.0��prefix� match_allc s t t�}t| |��|�S )N)r r �super�__new__)�cls�args�kwargsZnew_cls�� __class__� �</usr/lib/python3.9/site-packages/ansible/modules/wait_for.pyr s zTCPConnectionInfo.__new__c C sL || _ t|jd �| _t| j jd �| _| �� | _tsH|j t
d�t d� d S )N�host�port�psutil)�msg� exception) �module�_convert_host_to_ip�params�ips�intr �_get_exclude_ips� exclude_ips�
HAS_PSUTIL� fail_jsonr �PSUTIL_IMP_ERR��selfr r r r �__init__ s
zTCPConnectionInfo.__init__c C s4 | j jd }g }|d ur0|D ]}|�t|�� q |S �N�
exclude_hosts)r r �extendr �r' r* r" r r r r r! " s z"TCPConnectionInfo._get_exclude_ipsc C s0 d}t �� D �] }z(t|d�r,|jdd�}n |jdd�}W n t jyR Y q Y n0 |D ]�}|j| jjd vrpqXt|d�r�|j \}}n
|j
\}}| j |kr�qXt|d�r�|j \}}n
|j
\}}|j|f| jv r�qXt|j|f| jv |j| j|j f| jv |�| jd ��o|j| jd f| jv f�rX|d
7 }qXq |S ) Nr �get_connectionsZinet)�kind�active_connection_states�
local_address�remote_addressr r
� )r Z process_iter�hasattrr- � connections�Error�statusr r r0 Zladdrr r1 Zraddr�familyr" �anyr �
match_all_ips�
startswith�ipv4_mapped_ipv6_address) r' �active_connections�pr4 Zconn�local_ip�
local_port� remote_ip� remote_portr r r � get_active_connections_count* s:
� z.TCPConnectionInfo.get_active_connections_count)�__name__�
__module__� __qualname__�__doc__�platform� distribution�socket�AF_INET�AF_INET6r9 r; r r( r! rB �
__classcell__r r r r r � s �� r c @ sf e Zd ZdZdZdZejdejdiZ ejdejdiZ
dd d
�Z d Z d Z
d
Zdd� Zdd� Zdd� ZdS )�LinuxTCPConnectionInfoz�
This is a TCP Connection Info evaluation strategy class
that utilizes information from Linux's procfs. While less universal,
does allow Linux targets to not require an additional library.
ZLinuxNz
/proc/net/tcpz/proc/net/tcp6Z00000000Z 00000000000000000000000000000000Z0000000000000000FFFF0000Z 0000000000000000FFFF000000000000r r2 � � c C s8 || _ t|jd �| _dt|jd � | _| �� | _d S )Nr z%0.4Xr )r �_convert_host_to_hexr r r r r! r" r& r r r r( j s z LinuxTCPConnectionInfo.__init__c C s4 | j jd }g }|d ur0|D ]}|�t|�� q |S r) )r r r+ rP r, r r r r! p s z'LinuxTCPConnectionInfo._get_exclude_ipsc
C sd d}| j �� D �]N}tj�| j | �s(q�z(z�t| j | �}|�� D ]�}|�� �� }|| j dkrdqD|| j
dd� | j j d D �vr�qD|| j �d�\}}| j
|kr�qD|| j �d�\}}||f| jv r�qDt||f| jv || j| f| jv |�| jd ��o|| jd f| jv f�rD|d 7 }qDW n& t�yF } z W Y d } ~ n
d } ~ 0 0 W |�� q|�� 0 q|S )
Nr r0 c S s g | ] }t |��qS r )�get_connection_state_id)�.0�_connection_stater r r �
<listcomp>� � zGLinuxTCPConnectionInfo.get_active_connections_count.<locals>.<listcomp>r/ �:r r
r2 )� source_file�keys�os�path�isfile�open� readlines�strip�split�local_address_field�connection_state_fieldr r r �remote_address_fieldr" r8 r r9 r: r; �IOError�close)
r' r< r7 �fZtcp_connectionr> r? r@ rA �er r r rB x s> �
�z3LinuxTCPConnectionInfo.get_active_connections_count)rC rD rE rF rG rH rI rJ rK rW r9 r; r` rb ra r( r! rB r r r r rM Q s$ ���rM c C sd t �| dddt j�}g }|D ]B\}}}}}|d }|�||f� |t jkr |�t jd| f� q |S )z�
Perform forward DNS resolution on host, IP will give the same IP
Args:
host: String with either hostname, IPv4, or IPv6 address
Returns:
List of tuples containing address family and IP
�P r z::ffff:)rI Z getaddrinfoZSOL_TCP�appendrJ rK ) r Zaddrinfor r7 Zsocktype�protoZ canonnameZsockaddr�ipr r r r � s
r c C s� g }| dur�t | �D ]p\}}t�t�||��}d}tdt|�d�D ]2}|||d � }t�t|dd��}d||f }qB|� ||f� q|S )as
Convert the provided host to the format in /proc/net/tcp*
/proc/net/tcp uses little-endian four byte hex for ipv4
/proc/net/tcp6 uses little-endian per 4B word for ipv6
Args:
host: String with either hostname, IPv4, or IPv6 address
Returns:
List of tuples containing address family and the
little-endian converted host
N� r � � )�basez%s%08X)
r �binasciiZb2a_hexrI Z inet_pton�range�lenZntohlr rh ) r r r7 rj Zhexip_nfZhexip_hf�iZ
ipgroup_nfZ
ipgroup_hfr r r rP � s rP c C s& | j d | j| jd d d d S )Ng � i i@B )Z microseconds�secondsZdays)� timedeltar r r �_timedelta_total_seconds� s
��rv c C s ddddddd�}|| S )NZ01Z02Z03Z04Z05Z06)� ESTABLISHED�SYN_SENT�SYN_RECV� FIN_WAIT1� FIN_WAIT2� TIME_WAITr )�stateZconnection_state_idr r r rQ � s �rQ c C s� t ttddd�tddd�tddd�tddd�tdd�td dg d
�d �td d�tdd�tdd
g d�d�td dd�tddd�tdd�d� d�} | jd }| jd }| jd }| jd }| jd }| jd }| jd }t|ddd �}| jd } t| ddd �}
| jd } | d u�rXzt�|
tj�} W n8 tj�yT }
z | jd |
d � W Y d }
~
n
d }
~
0 0 nd } i }d!}|�r~|�r~| jd"dd#� |�r�|d$k�r�| jd%dd#� |�r�|d&k�r�| jd'dd#� | jd( d u�r�|d&k�r�| jd)dd#� | jd* D ]:}z t |� W n& t
�y" | jd+| dd#� Y n0 �q�t j � � }|�rBt
�|� |�sf|�sf|d&k�rft
�|� �nl|d,v �r�|t j|d-� }t j � � |k �r,|�r�zt�|tj��s�W �q�W n t�y� Y �q�Y n0 nJ|�rz(t�||f|�}|�tj� |�� W n t
�y Y �q�Y n0 t
�| jd. � �q�t j � � | }|�r`| j| �pTd/||f |jd#� n |�r�| j| �pvd0| |jd#� �nN|d1v �rN|t j|d-� }t j � � |k �r�|�rzt�|� W n` t�y" }
zF|
j d2k�rt j � � | }| j| �pd3||
j f |jd#� W Y d }
~
n�d }
~
0 0 | �s.�q�z�t |d4���}t � t!j!|�"� dt!j#d5���b}| �$|�}|�r�|�%� �r||�%� }|�&� �r�|�&� }W d � W d � W �q�W d � n1 �s�0 Y W d � n1 �s�0 Y W n t�y Y n0 �n�|�r�t'�(t)|t j � � ��}zt�||ft*||��}W n t
�yV Y �n@0 | �r@d6}d7}t j � � |k �r�t'�(t)|t j � � ��}t+�+|gg g |�d } | �s��qf|�,d8�} | �sq�|| 7 }| �$|��rfd9}�q�qfz|�tj� W n8 tj�y* }
z |
j t j-k�r� W Y d }
~
nd }
~
0 0 |�� |�r��q�nVz|�tj� W n8 tj�y� }
z |
j t j-k�rt� W Y d }
~
nd }
~
0 0 |�� �q�t
�| jd. � �q�t j � � | }|�r| �r�| j| �p�d:| ||f |jd#� n | j| �p�d;||f |jd#� nF|�r�| �r2| j| �p&d<| |f |jd#� n| j| �pBd=| |jd#� n�|d&k�r�|t j|d-� }t.| �} t j � � |k �r�| �/� dk�r��q�t
�| jd. � �qpt j � � | }| j| �p�d>||f |jd#� t j � � | }| j0||| ||||jd?� d S )@N�strz 127.0.0.1)�type�defaultr i, � r )r �list)rw rz r{ ry rx r| )r �elementsr� rZ �started)�absent�drained�presentr� �stopped)r r� �choices)r r� r2 ) r �timeout�connect_timeout�delayr r/ rZ � search_regexr} r* �sleepr )Z
argument_specr r� r� r� r r} Zsurrogate_or_strictZpassthru)�errorsZ nonstringr� r z Invalid regular expression: %s)r r z:port and path parameter can not both be passed to wait_for)r �elapsedr� zLstate=stopped should only be used for checking a port in the wait_for moduler� zLstate=drained should only be used for checking a port in the wait_for moduler* z/exclude_hosts should only be with state=drainedr/ z,unknown active_connection_state (%s) defined)r� r� )rt r� z'Timeout when waiting for %s:%s to stop.z)Timeout when waiting for %s to be absent.)r� r� rN zFailed to stat %s, %s�rb)�accessrU Fi Tz2Timeout when waiting for search string %s in %s:%sz Timeout when waiting for %s:%sz/Timeout when waiting for search string %s in %sz Timeout when waiting for file %sz'Timeout when waiting for %s:%s to drain)r} r r� � match_groups�match_groupdictrZ r� )1r �dictr r �re�compile� MULTILINE�errorr$ rQ � Exception�datetimeZutcnow�timer� ru rY r� �F_OKrc rI Zcreate_connectionZshutdownZ SHUT_RDWRrd rt �stat�OSError�errno�strerrorr\ �
contextlib�closing�mmap�filenoZ ACCESS_READ�search� groupdict�groups�mathZceilrv �min�selectZrecvZENOTCONNr rB Z exit_json) r r r� r� r� r r} rZ �b_pathr� Zb_search_regexr Zb_compiled_search_rerf r� r� rS �start�end�sr� re Zmmr� Zalt_connect_timeoutZb_dataZmatchedZ max_timeout�readableZresponseZtcpconnsr r r �main� s<
��
(
6
b
"
�r� �__main__)*Z
__future__r r r r Z
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNro r� r� r� r� r� rY r� r� rI r� � tracebackZansible.module_utils.basicr r Z$ansible.module_utils.common.sys_infor Zansible.module_utils._textr r# r% r � ImportError�
format_exc�objectr rM r rP rv rQ r� rC r r r r �<module> sH tN SJ U
Mini Shell