Current File : //lib/python3.9/site-packages/ansible/modules/__pycache__/yum_repository.cpython-39.pyc
a
�)gLc � @ sz d dl mZmZmZ eZdZdZdZd dl Z d dl
m Z d dl m
Z
d dlmZ G d d
� d
e�Zd d � Zed
krve� dS )� )�absolute_import�division�print_functiona>5
---
module: yum_repository
author: Jiri Tyr (@jtyr)
version_added: '2.1'
short_description: Add or remove YUM repositories
description:
- Add or remove YUM repositories in RPM-based Linux distributions.
- If you wish to update an existing repository definition use M(community.general.ini_file) instead.
options:
async:
description:
- If set to C(true) Yum will download packages and metadata from this
repo in parallel, if possible.
- In ansible-core 2.11, 2.12, and 2.13 the default value is C(true).
- This option has been deprecated in RHEL 8. If you're using one of the
versions listed above, you can set this option to None to avoid passing an
unknown configuration option.
type: bool
bandwidth:
description:
- Maximum available network bandwidth in bytes/second. Used with the
I(throttle) option.
- If I(throttle) is a percentage and bandwidth is C(0) then bandwidth
throttling will be disabled. If I(throttle) is expressed as a data rate
(bytes/sec) then this option is ignored. Default is C(0) (no bandwidth
throttling).
type: str
default: '0'
baseurl:
description:
- URL to the directory where the yum repository's 'repodata' directory
lives.
- It can also be a list of multiple URLs.
- This, the I(metalink) or I(mirrorlist) parameters are required if I(state) is set to
C(present).
type: list
elements: str
cost:
description:
- Relative cost of accessing this repository. Useful for weighing one
repo's packages as greater/less than any other.
type: str
default: '1000'
deltarpm_metadata_percentage:
description:
- When the relative size of deltarpm metadata vs pkgs is larger than
this, deltarpm metadata is not downloaded from the repo. Note that you
can give values over C(100), so C(200) means that the metadata is
required to be half the size of the packages. Use C(0) to turn off
this check, and always download metadata.
type: str
default: '100'
deltarpm_percentage:
description:
- When the relative size of delta vs pkg is larger than this, delta is
not used. Use C(0) to turn off delta rpm processing. Local repositories
(with file:// I(baseurl)) have delta rpms turned off by default.
type: str
default: '75'
description:
description:
- A human readable string describing the repository. This option corresponds to the "name" property in the repo file.
- This parameter is only required if I(state) is set to C(present).
type: str
enabled:
description:
- This tells yum whether or not use this repository.
- Yum default value is C(true).
type: bool
enablegroups:
description:
- Determines whether yum will allow the use of package groups for this
repository.
- Yum default value is C(true).
type: bool
exclude:
description:
- List of packages to exclude from updates or installs. This should be a
space separated list. Shell globs using wildcards (eg. C(*) and C(?))
are allowed.
- The list can also be a regular YAML array.
type: list
elements: str
failovermethod:
choices: [roundrobin, priority]
default: roundrobin
description:
- C(roundrobin) randomly selects a URL out of the list of URLs to start
with and proceeds through each of them as it encounters a failure
contacting the host.
- C(priority) starts from the first I(baseurl) listed and reads through
them sequentially.
type: str
file:
description:
- File name without the C(.repo) extension to save the repo in. Defaults
to the value of I(name).
type: str
gpgcakey:
description:
- A URL pointing to the ASCII-armored CA key file for the repository.
type: str
gpgcheck:
description:
- Tells yum whether or not it should perform a GPG signature check on
packages.
- No default setting. If the value is not set, the system setting from
C(/etc/yum.conf) or system default of C(false) will be used.
type: bool
gpgkey:
description:
- A URL pointing to the ASCII-armored GPG key file for the repository.
- It can also be a list of multiple URLs.
type: list
elements: str
module_hotfixes:
description:
- Disable module RPM filtering and make all RPMs from the repository
available. The default is C(None).
version_added: '2.11'
type: bool
http_caching:
description:
- Determines how upstream HTTP caches are instructed to handle any HTTP
downloads that Yum does.
- C(all) means that all HTTP downloads should be cached.
- C(packages) means that only RPM package downloads should be cached (but
not repository metadata downloads).
- C(none) means that no HTTP downloads should be cached.
choices: [all, packages, none]
type: str
default: all
include:
description:
- Include external configuration file. Both, local path and URL is
supported. Configuration file will be inserted at the position of the
I(include=) line. Included files may contain further include lines.
Yum will abort with an error if an inclusion loop is detected.
type: str
includepkgs:
description:
- List of packages you want to only use from a repository. This should be
a space separated list. Shell globs using wildcards (eg. C(*) and C(?))
are allowed. Substitution variables (e.g. C($releasever)) are honored
here.
- The list can also be a regular YAML array.
type: list
elements: str
ip_resolve:
description:
- Determines how yum resolves host names.
- C(4) or C(IPv4) - resolve to IPv4 addresses only.
- C(6) or C(IPv6) - resolve to IPv6 addresses only.
choices: ['4', '6', IPv4, IPv6, whatever]
type: str
default: whatever
keepalive:
description:
- This tells yum whether or not HTTP/1.1 keepalive should be used with
this repository. This can improve transfer speeds by using one
connection when downloading multiple files from a repository.
type: bool
default: 'no'
keepcache:
description:
- Either C(1) or C(0). Determines whether or not yum keeps the cache of
headers and packages after successful installation.
choices: ['0', '1']
type: str
default: '1'
metadata_expire:
description:
- Time (in seconds) after which the metadata will expire.
- Default value is 6 hours.
type: str
default: '21600'
metadata_expire_filter:
description:
- Filter the I(metadata_expire) time, allowing a trade of speed for
accuracy if a command doesn't require it. Each yum command can specify
that it requires a certain level of timeliness quality from the remote
repos. from "I'm about to install/upgrade, so this better be current"
to "Anything that's available is good enough".
- C(never) - Nothing is filtered, always obey I(metadata_expire).
- C(read-only:past) - Commands that only care about past information are
filtered from metadata expiring. Eg. I(yum history) info (if history
needs to lookup anything about a previous transaction, then by
definition the remote package was available in the past).
- C(read-only:present) - Commands that are balanced between past and
future. Eg. I(yum list yum).
- C(read-only:future) - Commands that are likely to result in running
other commands which will require the latest metadata. Eg.
I(yum check-update).
- Note that this option does not override "yum clean expire-cache".
choices: [never, 'read-only:past', 'read-only:present', 'read-only:future']
type: str
default: 'read-only:present'
metalink:
description:
- Specifies a URL to a metalink file for the repomd.xml, a list of
mirrors for the entire repository are generated by converting the
mirrors for the repomd.xml file to a I(baseurl).
- This, the I(baseurl) or I(mirrorlist) parameters are required if I(state) is set to
C(present).
type: str
mirrorlist:
description:
- Specifies a URL to a file containing a list of baseurls.
- This, the I(baseurl) or I(metalink) parameters are required if I(state) is set to
C(present).
type: str
mirrorlist_expire:
description:
- Time (in seconds) after which the mirrorlist locally cached will
expire.
- Default value is 6 hours.
type: str
default: '21600'
name:
description:
- Unique repository ID. This option builds the section name of the repository in the repo file.
- This parameter is only required if I(state) is set to C(present) or
C(absent).
type: str
required: true
password:
description:
- Password to use with the username for basic authentication.
type: str
priority:
description:
- Enforce ordered protection of repositories. The value is an integer
from 1 to 99.
- This option only works if the YUM Priorities plugin is installed.
type: str
default: '99'
protect:
description:
- Protect packages from updates from other repositories.
type: bool
default: 'no'
proxy:
description:
- URL to the proxy server that yum should use. Set to C(_none_) to
disable the global proxy setting.
type: str
proxy_password:
description:
- Password for this proxy.
type: str
proxy_username:
description:
- Username to use for proxy.
type: str
repo_gpgcheck:
description:
- This tells yum whether or not it should perform a GPG signature check
on the repodata from this repository.
type: bool
default: 'no'
reposdir:
description:
- Directory where the C(.repo) files will be stored.
type: path
default: /etc/yum.repos.d
retries:
description:
- Set the number of times any attempt to retrieve a file should retry
before returning an error. Setting this to C(0) makes yum try forever.
type: str
default: '10'
s3_enabled:
description:
- Enables support for S3 repositories.
- This option only works if the YUM S3 plugin is installed.
type: bool
default: 'no'
skip_if_unavailable:
description:
- If set to C(true) yum will continue running if this repository cannot be
contacted for any reason. This should be set carefully as all repos are
consulted for any given command.
type: bool
default: 'no'
ssl_check_cert_permissions:
description:
- Whether yum should check the permissions on the paths for the
certificates on the repository (both remote and local).
- If we can't read any of the files then yum will force
I(skip_if_unavailable) to be C(true). This is most useful for non-root
processes which use yum on repos that have client cert files which are
readable only by root.
type: bool
default: 'no'
sslcacert:
description:
- Path to the directory containing the databases of the certificate
authorities yum should use to verify SSL certificates.
type: str
aliases: [ ca_cert ]
sslclientcert:
description:
- Path to the SSL client certificate yum should use to connect to
repos/remote sites.
type: str
aliases: [ client_cert ]
sslclientkey:
description:
- Path to the SSL client key yum should use to connect to repos/remote
sites.
type: str
aliases: [ client_key ]
sslverify:
description:
- Defines whether yum should verify SSL certificates/hosts at all.
type: bool
default: 'yes'
aliases: [ validate_certs ]
state:
description:
- State of the repo file.
choices: [absent, present]
type: str
default: present
throttle:
description:
- Enable bandwidth throttling for downloads.
- This option can be expressed as a absolute data rate in bytes/sec. An
SI prefix (k, M or G) may be appended to the bandwidth value.
type: str
timeout:
description:
- Number of seconds to wait for a connection before timing out.
type: str
default: '30'
ui_repoid_vars:
description:
- When a repository id is displayed, append these yum variables to the
string if they are used in the I(baseurl)/etc. Variables are appended
in the order listed (and found).
type: str
default: releasever basearch
username:
description:
- Username to use for basic authentication to a repo or really any url.
type: str
extends_documentation_fragment:
- action_common_attributes
- files
attributes:
check_mode:
support: full
diff_mode:
support: full
platform:
platforms: rhel
notes:
- All comments will be removed if modifying an existing repo file.
- Section order is preserved in an existing repo file.
- Parameters in a section are ordered alphabetically in an existing repo
file.
- The repo file will be automatically deleted if it contains no repository.
- When removing a repository, beware that the metadata cache may still remain
on disk until you run C(yum clean all). Use a notification handler for this.
- "The C(params) parameter was removed in Ansible 2.5 due to circumventing Ansible's parameter
handling"
a�
- name: Add repository
ansible.builtin.yum_repository:
name: epel
description: EPEL YUM repo
baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/
- name: Add multiple repositories into the same file (1/2)
ansible.builtin.yum_repository:
name: epel
description: EPEL YUM repo
file: external_repos
baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/
gpgcheck: no
- name: Add multiple repositories into the same file (2/2)
ansible.builtin.yum_repository:
name: rpmforge
description: RPMforge YUM repo
file: external_repos
baseurl: http://apt.sw.be/redhat/el7/en/$basearch/rpmforge
mirrorlist: http://mirrorlist.repoforge.org/el7/mirrors-rpmforge
enabled: no
# Handler showing how to clean yum metadata cache
- name: yum-clean-metadata
ansible.builtin.command: yum clean metadata
# Example removing a repository and cleaning up metadata cache
- name: Remove repository (and clean up left-over metadata)
ansible.builtin.yum_repository:
name: epel
state: absent
notify: yum-clean-metadata
- name: Remove repository from a specific repo file
ansible.builtin.yum_repository:
name: epel
file: external_repos
state: absent
z�
repo:
description: repository name
returned: success
type: str
sample: "epel"
state:
description: state of the target, after execution
returned: success
type: str
sample: "present"
N)�
AnsibleModule)� configparser)� to_nativec @ sX e Zd ZdZdZdZe�� Zg d�Z ddgZ
dd� Z dd� Z d d
� Z
d d � Zd
d� ZdS )�YumRepoN)-�async� bandwidth�baseurl�cost� deltarpm_metadata_percentage�deltarpm_percentage�enabled� enablegroups�exclude�failovermethod�gpgcakey�gpgcheck�gpgkey�module_hotfixes� http_caching�include� includepkgs�
ip_resolve� keepalive� keepcache�metadata_expire�metadata_expire_filter�metalink�
mirrorlist�mirrorlist_expire�name�password�priority�protect�proxy�proxy_password�proxy_username�
repo_gpgcheck�retries�
s3_enabled�skip_if_unavailable� sslcacert�ssl_check_cert_permissions�
sslclientcert� sslclientkey� sslverify�throttle�timeout�ui_repoid_vars�usernamer r c C s� || _ | j j| _| jd | _| jd }tj�|�sD| j jd| d� tj�|d| jd �| jd< tj�| jd �r�| j �
| jd � d S )N�repoid�reposdirz#Repo directory '%s' does not exist.��msgz%s.repo�file�dest) �module�params�section�os�path�isdir� fail_json�join�isfile�repofile�read)�selfr< Z repos_dir� rH �B/usr/lib/python3.9/site-packages/ansible/modules/yum_repository.py�__init__� s
��
zYumRepo.__init__c C s� | j �| j�r | j �| j� | j �| j� | jd | jd | jd f}|dkr\| jjdd� t| j� � �D ]^\}}|| j
v r�t |t �r�d�
|�}nt |t�r�t|�}|d urj|| jv rj| j �| j||� qjd S )Nr r r )NNNzRParameter 'baseurl', 'metalink' or 'mirrorlist' is required for adding a new repo.r8 � )rE � has_sectionr> �remove_sectionZ add_sectionr= r< rB �sorted�items� list_params�
isinstance�listrC �bool�int�allowed_params�set)rG Z
req_params�key�valuerH rH rI �add s �
z YumRepo.addc
C s� t | j�� �r�z@t| jd d�� }| j�|� W d � n1 sB0 Y W q� ty� } z*| jjd| jd t |�d� W Y d }~q�d }~0 0 nXzt
� | jd � W nB t y� } z*| jjd| jd t |�d� W Y d }~n
d }~0 0 d S )Nr; �wzProblems handling file %s.)r9 �detailsz!Cannot remove empty repo file %s.)
�lenrE �sections�openr= �write�IOErrorr< rB r r? �remove�OSError)rG �fd�erH rH rI �save* s$ . � ��z YumRepo.savec C s | j �| j�r | j �| j� d S )N)rE rL r> rM )rG rH rH rI ra ? s zYumRepo.removec C sZ d}t | j�� �D ]B}|d| 7 }t | j�|��D ]\}}|d||f 7 }q2|d7 }q|S )N� z[%s]
z%s = %s
�
)rN rE r] rO )rG Z repo_stringr> rW rX rH rH rI �dumpD s
z YumRepo.dump)�__name__�
__module__� __qualname__r< r= r> r ZRawConfigParserrE rU rP rJ rY re ra rh rH rH rH rI r � s 0 r c 3 C sf t t � t ddd�t � t � t � t � t dd�t dd�t ddd�t ddgd�t � t d d
�t dd�t ddd d �t dd�t g d �d�t � t ddd�t g d
�d�t dd�t ddgd�t � t g d�d�t � t � t � t dd�t dd�t dd
�t � t dd�t � t dd
�t � t dd�t ddd�t � t dd�t dd�t dgd�t dd�t dgd�t dgd d�t dd gd �t d d gd d �t � t � t � t � d!�1} t dd�| d"< t| ddd#�}|jd$ �r�|jd%d&� |jd' }|jd( }|d k�r |jd) d u �r|jd* d u �r|jd+ d u �r|jd,d&� |jd- d u �r |jd.d&� |jd' |jd/< |jd- |jd'< |jd-= d0D ]8}||jv �rL|j| d u�rLd1�|j| �|j|< �qL|jd2 d u �r�|jd/ |jd2< t|�}|jd3 |�� |jd3 d4d5�}|d k�r�|�� n|d k�r�|�� |�� |d6< |d7 |d6 k}|j �s$|�r$|�
� t j �
|jd3 ��rP|�|j�}|�||�}|j||||d8� d S )9NrR �str)�type�elementsrS )rm Z
roundrobinr$ )�choicesF)�no_log)rm rn rp )�allZpackagesZnone)�4�6ZIPv4ZIPv6Zwhatever�0�1)�neverzread-only:pastzread-only:presentzread-only:futureT)�required�dictz/etc/yum.repos.dr@ )�defaultrm Zca_cert)�aliasesZ client_certZ
client_key)rz rp Zvalidate_certs)rm rz ZpresentZabsent)ro ry )1r
r r r
r � descriptionr r r r r: r r r r r r r r r r r r r r r! r" r= r# r$ r% r& r' r( r) r7 r* r+ r, r- r. r/ r0 r1 �stater2 r3 r4 r5 r )�
argument_specZadd_file_common_argsZsupports_check_moder= zmThe params option to yum_repository was removed in Ansible 2.5 since it circumvents Ansible's option handlingr8 r" r| r r r z<Parameter 'baseurl', 'metalink' or 'mirrorlist' is required.r{ z$Parameter 'description' is required.r6 )r r rg r: r; rf )Z
before_header�beforeZ after_header�afterr r~ )�changedZrepor| �diff)rx r r= rB rC r rh rY ra Z
check_modere r? r@ rD Zload_file_common_argumentsZ set_fs_attributes_if_differentZ exit_json) r} r< r" r| Z
list_paramZyumrepor� r� Z file_argsrH rH rI �mainS s�
�
�9�
� � ���� ��
r� �__main__)Z
__future__r r r rm Z
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNr? Zansible.module_utils.basicr Z ansible.module_utils.six.movesr Zansible.module_utils._textr �objectr r� ri rH rH rH rI �<module> s u*
Mini Shell