File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/states/__pycache__/pkg.cpython-310.pyc
o
�N�g�% � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddl Zddl
m Z m Z m
Z
ddlmZ ddlmZ ddlmZ ddlmZ eee� �Zejj�� r�ddlm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ ee e� �Z ee#e� �Z#ee e� �Z ee e� �Z ee$e� �Z$ee"e� �Z"ee e� �Z ee e� �Z ee!e� �Z!e�%e&�Z'd d
� Z(d d � Z)dLd
d�Z*dd� Z+ dMdd�Z,dLdd�Z-dd� Z. dNdd�Z/dOdd �Z0 dPd d �Z1 dQd d �Z2dOd!d"�Z3d#d$� Z4d%d&� Z5d'd(� Z6dRd)d*�Z7 dSd+d,�Z8 dTd-d.�Z9dOd/d0�Z:dLd1d2�Z; dUd3d4�Z< 5 dVd6d7�Z=dWd8d9�Z>dWd:d;�Z?dXd<d=�Z@dOd>d?�ZAd@dA� ZBdBdC� ZCdDdE� ZDdFdG� ZEdYdHdI�ZFdYdJdK�ZGdS )Za�
Installation of packages using OS package managers such as yum or apt-get
=========================================================================
.. note::
On minions running systemd>=205, as of version 2015.8.12, 2016.3.3, and
2016.11.0, `systemd-run(1)`_ is now used to isolate commands which modify
installed packages from the ``salt-minion`` daemon's control group. This is
done to keep systemd from killing the package manager commands spawned by
Salt, when Salt updates itself (see ``KillMode`` in the `systemd.kill(5)`_
manpage for more information). If desired, usage of `systemd-run(1)`_ can
be suppressed by setting a :mod:`config option <salt.modules.config.get>`
called ``systemd.use_scope``, with a value of ``False`` (no quotes).
.. _`systemd-run(1)`: https://www.freedesktop.org/software/systemd/man/systemd-run.html
.. _`systemd.kill(5)`: https://www.freedesktop.org/software/systemd/man/systemd.kill.html
Salt can manage software packages via the pkg state module, packages can be
set up to be installed, latest, removed and purged. Package management
declarations are typically rather simple:
.. code-block:: yaml
vim:
pkg.installed
A more involved example involves pulling from a custom repository.
.. code-block:: yaml
base:
pkgrepo.managed:
- name: ppa:wolfnet/logstash
- dist: precise
- file: /etc/apt/sources.list.d/logstash.list
- keyid: 28B04E4A
- keyserver: keyserver.ubuntu.com
logstash:
pkg.installed:
- fromrepo: ppa:wolfnet/logstash
Multiple packages can also be installed with the use of the pkgs
state module
.. code-block:: yaml
dotdeb.repo:
pkgrepo.managed:
- name: deb http://packages.dotdeb.org wheezy-php55 all
- dist: wheezy-php55
- file: /etc/apt/sources.list.d/dotbeb.list
- keyid: 89DF5277
- keyserver: keys.gnupg.net
- refresh_db: true
php.packages:
pkg.installed:
- fromrepo: wheezy-php55
- pkgs:
- php5-fpm
- php5-cli
- php5-curl
.. warning::
Make sure the package name has the correct case for package managers which are
case-sensitive (such as :mod:`pkgng <salt.modules.pkgng>`).
� N)�CommandExecutionError� MinionError�SaltInvocationError)� _repack_pkgs)�nested)�namespaced_function)� OrderedDict) �_get_latest_pkg_version�_get_package_info�_get_repo_details�_refresh_db_conditional�_repo_process_pkg_sls�_reverse_cmp_pkg_versions�genrepo�
get_repo_data�
refresh_dbc C s dt v rdS dS )zn
Only make these states available if a pkg provider has been detected or
assigned for this minion
� pkg.installT)Fz pkg module could not be loaded��__salt__� r r �C/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/pkg.py� __virtual__t s r c C s* t jj�| �� �\}}|dv rd}||fS )z�
Return a tuple containing the comparison operator and the version. If no
comparison operator was passed, the comparison is assumed to be an "equals"
comparison, and "==" will be the operator returned.
)�=� �==)�salt�utils�pkgZsplit_comparison�strip)�pkgver�oper�verstrr r r �_get_comparison_spec~ s r" c C s$ |dur|S d| vod| vod|vS )z�
Conditionally ignore epoch, but only under all of the following
circumstances:
1. No value for ignore_epoch passed to state
2. desired_version has no epoch
3. oper does not contain a "<" or ">"
N�<�>�:r )r �desired_version� ignore_epochr r r �_check_ignore_epoch� s r( c C s: g }| � � } | s
|S | �d�D ] }t|�}|�|� q|S )zF
Returns a list of two-tuples containing (operator, version).
�,)r �splitr" �append)�version_conditions_string�resultZversion_conditionZoperator_and_versionr r r �_parse_version_string� s r. Fc C sd t |�}| D ])}d}|D ] \}}|r t|�dkr |dkr d}|o(t|g|||d�}q |r/ dS qdS )a
Returns True if any of the installed versions match the specified version conditions,
otherwise returns False.
installed_versions
The installed versions
version_conditions_string
The string containing all version conditions. E.G.
1.2.3-4
>=1.2.3-4
>=1.2.3-4, <2.3.4-5
>=1.2.3-4, <2.3.4-5, !=1.2.4-1
ignore_epoch : None
When a package version contains an non-zero epoch (e.g.
``1:3.14.159-2.el7``), and a specific version of a package is desired,
set this option to ``True`` to ignore the epoch when comparing
versions.
.. versionchanged:: 3001
If no value for this argument is passed to the state that calls
this helper function, and ``version_conditions_string`` contains no
epoch or greater-than/less-than, then the epoch will be ignored.
allow_updates : False
Allow the package to be updated outside Salt's control (e.g. auto updates on Windows).
This means a package on the Minion can have a newer version than the latest available in
the repository without enforcing a re-installation of the package.
(Only applicable if only one strict version condition is specified E.G. version: 2.0.6~ubuntu3)
T� r z>=�r' F)r. �len�_fulfills_version_spec) Zinstalled_versionsr, r' �
allow_updates�version_conditionsZinstalled_versionZ
fullfills_all�operator�version_stringr r r �_fulfills_version_string� s %
��r7 c
C sx t �d�}tjj�� rt| t�rd| v r| d } | D ] }|dkr&t�||�s6tjj j
||||t |||�d�r9 dS qdS )zp
Returns True if any of the installed versions match the specified version,
otherwise returns False
zpkg.version_cmp�versionr )Zver1r Zver2�cmp_funcr' TF) r �getr r �platformZ
is_freebsd�
isinstance�dict�fnmatch�versionsZcomparer( )r? r r& r' r9 �verr r r r2 � s"
��� r2 c s � fdd�| D �S )a/
Find packages which are marked to be purged but can't yet be removed
because they are dependencies for other installed packages. These are the
packages which will need to be 'unpurged' because they are part of
pkg.installed states. This really just applies to Debian-based Linuxes.
c s* g | ]}|t d dddi� ��v r|�qS )�
pkg.list_pkgs�
purge_desiredTr r ��.0�x��kwargsr r �
<listcomp>� s
�z)_find_unpurge_targets.<locals>.<listcomp>r )�desiredrG r rF r �_find_unpurge_targets� s
�rJ Tc K sV t d di |��}|rt||d�}|s| i ddd�S nA|r,t �ddd� �} | | �|i}n| |i}|�| i �}
| |v r\|
rK||
v rK| i d d
�|| �d�S |
r\|d u r\| i d d | � d
�d�S d} |s�z
t|fi |��} W n tys Y nLw g }
| �d�r�|
�d�d�t| d ���� | �d�r�| d � � D ]\}}|
�d�|d�|��� q�|
r�t
|
�dkr�|
�d� | i dd�|
�� � d�S i }g } |� � D ]@\}}|�|i �}
|
s�|||< q�|
r�|s�q�d } zt |
�
� ||d�s�|||< W q� t�y } z | �|j� W Y d }~q�d }~ww | �r| i dd�| �d�S |�s)d�| �r dnd�}| i d |d�S |S )z�
Inspect the arguments to pkg.downloaded and discover what packages need to
be downloaded. Return a dict of packages to download.
�pkg.list_downloaded�� normalizeF�3Invalidly formatted pkgs parameter. See minion log.��name�changesr- �comment�pkg.normalize_namec S � | S �Nr ��pkgnamer r r �<lambda> � z(_find_download_targets.<locals>.<lambda>Tz0Version {} of package '{}' is already downloadedN�Package z is already downloaded�
no_suggest�aThe following package(s) were not found, and no possible matches were found in the package db: {}�, �suggest�-Package '{}' not found (possible matches: {})r/ r �. r0 � z/All specified packages{} are already downloaded� (matching specified versions)r )r r r: �format�_preflight_checkr r+ �join�sorted�itemsr1 �rstripr7 �keys�strerror)rP r8 �pkgsrM �skip_suggestionsr' rG �cur_pkgs� to_download�_normalize_name�cver� version_spec�problems�commentsrW � suggestions�targetsr �exc�msgr r r �_find_download_targets� s�
�� � ��
� �
�
��
�
�� ��� �rx c K s� t d di |��}|r|}n| g}|�| i �r"| i dd| � d�d�S g }|D ]}|�|i �}|s6|�|� q&q&|sBd}| i d|d�S |S ) z�
Inspect the arguments to pkg.patch_installed and discover what advisory
patches need to be installed. Return a dict of advisory patches to install.
zpkg.list_installed_patchesTzAdvisory patch � is already installedrO z4All specified advisory patches are already installedNr )r r: r+ ) rP � advisory_idsrG Z cur_patchesrn ru Z
patch_namerp rw r r r �_find_advisory_targets� s*
�
�r{ c s� t d dkr
d|d< td dddi|��}|r't||d�}|s&| i dd d
�S nt�d d d
� �}|| �|i}d} g }
g } |�� D ]g\� } tt�d� ��}
t d dkr_|
r_� fdd�|�� D �}n|�� g �}|shq?td | �du rv|
�� � q?d} zt || |d�r�|
�� � nt
� d|| � W q? t y� } z | �|j
� W Y d}~q?d}~ww | r�| i dd�| �d
�S |
s�d�| r�dnd�}| i d|d
�S |
S )z�
Inspect the arguments to pkg.removed and discover what packages need to
be removed. Return a dict of packages to remove.
�os�FreeBSDT� with_originrA �versions_as_listrL FrN rO rS c S rT rU r rV r r r rX � rY z&_find_remove_targets.<locals>.<lambda>�/c � g | ] \}}|d � kr|�qS ��originr �rD �k�vrV r r rH � � z(_find_remove_targets.<locals>.<listcomp>�pkg_resource.version_cleanNr0 zVCurrent version (%s) did not match desired version specification (%s), will not removera z+All specified packages{} are already absentrb r r )�
__grains__r r r: rg �bool�re�searchr+ r7 �log�debugr rj re rc )rP r8 rk rM r' rG rm � to_removero rq ru rr r r� rp rv rw r rV r �_find_remove_targets� sl ��
�� ���
�r� c
1 sx d} t ||f�r�i ddd�S i } t|t�r)tdd� |D ��r)tdd� |D ��}
ng }
t|t�rCtdd� |D ��rCtdd� |D ��}ng }td d
krOd |
d < tjj� � rY| |
d
< |
�
dd�obdt v }zt d dGdd i|
��� |rzt d dGi |
��p|t � }W n t
y� } z�i d|jd�W Y d}~S d}~ww tjj� � r�|
�d
d�r�d } d} t||f�r�|r�t||d�}n
|r�t d ||d�}|sՈi dd�|r�d�d�S d�d�S t|fi |
��}n�tjj� � �rt�|
d d�}|s��i dd�� d�d�S |du �rt|�}|�rt �
d d d � �}|��|i}n�|i}t|fi |
��}tt�d ���}td d
k�r?|�r?�fd d!�� �� D �}n� �
�g �}�|v�r||�rc||v �rc|�sc|�sc�i d d"�|��d�S |�r||du �r||�s||�s|�i d d�� d#�d�S d}|�s�|�s�� �fd$d%�|�� D �}|�r�z
t|fi |
��}W n
t
�y� Y nQw g }|�
d&��r�|�d'�d(�t |d& ���� |�
d)��r�|d) �� D ]\} } |�d*�| d(�| ��� �q�|�r�t |�d+k�r�|�d,� �i dd-�|�� � d�S |�r�g nd.d!� |�� D �} | �rKt d/ | d
| i|
��} t | �d+k�r!| d0 | i} | �r(d } d} | D ]} | | �sD| � v �r@� | d1 | | < �q*d| | < �q*|� | � i }!i }"g }g }#d}$|�� D �]�\}%}&� �
|%g �}|�rz|�sz|%|v �rz� �
|�
|%�d0 g �}|�s�|&|!|%< �qY|�r |�r�|&|"|%< �qYd2t v�r��qYd3}'zt d4 |&|
d |
�
d5d �d6�}(W n t
�y� } z|�|'�|&|�� W Y d}~�qYd}~ww |(�s�|�|'�|&d7�� �qYt j!�"|(��s�|�|&� d8�� �qYt d2 |(�})|)du �r�|#�d9|&� �� �qY|)d: }*n^|&}*|�r |&|"|%< �qYt d; |%|&��s|&|!|%< �qYt d< |&�du �r^|�s\|�r\zt d= |%f|
|d>�|
��}+W n t
t#f�yP } z
|j}$W Y d}~�qYd}~ww |+�r\|&|"|%< |+| |%< �qYd},t| �oi|
�
d?��}-z
t$||*�|-d@�},W n t
�y� } z
|�|j� W Y d}~�qYd}~ww d }|,�s�|�r�|&|"|%< �qYt%|&�}.|�r�tdAd� |.D ���r�zt d= |%f|
|d>�|
��}+W n t
t#f�y� } z
|j}$W Y d}~�qYd}~ww |+�r�|&|"|%< |+| |%< �qYt&�'dB||&� |&|!|%< �qY|$�r�|�|$� |�r�i ddC�|�d�S t|!||"f��s3dD}/|/�|�r|�sdEnd,�}/�i d |/d�}0|#�r1|0�(dFg ��)|#� |0S ||!||"| |#| fS )Hz�
Inspect the arguments to pkg.installed and discover what packages need to
be installed. Return a dict of desired packages
Fz.Only one of "pkgs" and "sources" is permitted.rO c s �0 � | ]}t |t�rd |v r|�d �duV qdS �� ignore_typesN�r< � _OrderedDictr: rC r r r � <genexpr> � � � ��z(_find_install_targets.<locals>.<genexpr>c s �" � | ] }d |v r|� d �V qdS r� �r: rC r r r r� � � �c s r� ��verify_optionsNr� rC r r r r� $ r� c s r� r� r� rC r r r r� ) r� r| r} Tr~ �refresh�resolve_capabilities�pkg.list_providesrA r NrL zpkg_resource.pack_sourcesz3Invalidly formatted '{}' parameter. See minion log.rk �sources�saltenv)r� rZ z not found in the repository.rS c S rT rU r rV r r r rX q rY z'_find_install_targets.<locals>.<lambda>r� c r� r� r r� )rP r r rH } r� z)_find_install_targets.<locals>.<listcomp>z/Version {} of package '{}' is already installedry c s8 i | ]\}}|� v r|d u st � | |�d�s||�qS )Nr0 )r7 )rD rP r8 )rm r' r r �
<dictcomp>� s
���z)_find_install_targets.<locals>.<dictcomp>r[ r\ r] r^ r_ r/ r r` c S s g | ]
\}}|d kr|�qS )�latestr �rD rE �yr r r rH � � �pkg.latest_versionr ���zlowpkg.bin_pkg_infozUnable to cache {0}: {1}z
cp.cache_file�
verify_ssl)r� r� zfile not foundz does not exist on minionz Failed to parse metadata for r8 z%pkg_resource.check_extra_requirementsr� �
pkg.verify�r� r� r3 )r' r3 c s s � | ] \}}|d kV qdS )r Nr )rD r r8 r r r r� < s �
�zeCurrent version (%s) did not match desired version specification (%s), adding to installation targetsra z/All specified packages are already installed{0}z and are at the desired version�warningsr )*�allr< �list�any�nextr� r r r; �
is_windowsr: r r= r rj �popr rc rJ r
r r� r� r� rg rd r+ re rf r1 rh �updater| �path�existsr r7 r. r� r� �
setdefault�extend)1rP r8 rk r� rl �
pkg_verifyrM r' � reinstallr� rG �
was_refreshed�
altered_filesr� r� r� Zcur_provrv rI �
to_unpurge�pkginforo r� rp rq �
not_installedrr rs rW rt Z wants_latestZresolved_latest�keyru � to_reinstallr� Z
failed_verifyZ package_namer6 �errZ cached_pathZ source_infor! �
verify_resultZversion_fulfilledr3 r4 rw �retr )rm r' rP r �_find_install_targets� s@ ��
��
� �� �� �����
�
�
��
� �
� �
��
� ���
�
���
� ��
���
� ��
���
������
���r� c s� g }g }|s t � }| �� D ]�\� }d� v }td dkr)|r)� fdd�|�� D �}nNtd dkr@|r@|�� |�� �d�d ��}n7td dkrQ|�� �d �d
�}n&td d krb|�� �d
�d
�}n|�� �}|sw� |v rw|�|�� �d
�}|s|�� � q
|dkr�|�� � q
td |�s�|�� � q
|�d�r�|d
�|dd� �r�|�� � q
t |||d�r�|�� � q
|�� � q
||fS )zg
Determine whether or not the installed packages match what was requested in
the SLS file.
r� r| r} c r� r� r r� rV r r rH � r� z#_verify_install.<locals>.<listcomp>ZMacOSr� ZOpenBSD�%r � os_familyZDebianr r� r� �*Nr0 )
r= rg r� r: r* r+ r �endswith�
startswithr7 ) rI �new_pkgsr' �new_caps�_ok�failedr Z
has_originrp r rV r �_verify_installv sB
r� c C s@ || r || � d�rd}nd}d�| ||| sd�S || �S )z�
Helper function that retrieves and nicely formats the desired pkg (and
version if specified) so that helpful information can be printed in the
comment for the state.
)r# r$ r r r z{}{}{})r� rc )rP rI r r r r �_get_desired_pkg� s r� c K s� dt vri S i g d�}t d t| �� �d|i|��}|D ]"}|| d du r>|| d r7|| d |d |< q |d �|� q |S ) z>
Perform platform-specific checks on desired packages
z pkg.check_db)r^ r[ �fromrepo�foundFrt r^ r[ )r r� ri r+ )rI r� rG r� r� rW r r r rd � s"
��� �rd c C s t t_ t�| ��� }|S )z-
Serialize obj and format for output
)�__opts__r �outputrh )�objr� r r r �_nested_output� s r� c K s4 | rdt vr
| |fS t d | fd|i|��}|dfS )a�
Resolve capabilities in ``pkgs`` and exchange them with real package
names, when the result is distinct.
This feature can be turned on while setting the paramter
``resolve_capabilities`` to True.
Return the input dictionary with replaced capability names and as
second return value a bool which say if a refresh need to be run.
In case of ``resolve_capabilities`` is False (disabled) or not
supported by the implementation the input is returned unchanged.
zpkg.resolve_capabilitiesr� Fr )rk r� rG r� r r r �_resolve_capabilities� s
r� c 0 s� t |t�rt|�dkr| i ddd�S | r't||f�s'|r$| |ig}d}n| g}t|d< tjj�t |�}|rAt
|fd|i|��\}}t | t�sJ| du } | sQt | t�r\dt vr\| i d d
d�S t |t �si|durit |�}||d < t
| |||f||| |
| | |d �|��}z|\� �}�}}}|r�d }W n� t�y^ d
t v �rZd|v �rZz|d r�d
nd}t | | ||d��W n ttfy� } z| i d t |�d�W Y d}~ Y S d}~ww d�v r�d s�| i d d��d �d� Y S �fdd��D �}�fdd��D �}�fdd��D �}|D ] }|d d�|d �7 < |d |d< |d |d |d < �q|D ]}|d d�|d �7 < |d |d< �q*|D ]}|d d�|d �7 < |d |d< �qC| Y S w |�r|dt v�r|| i d d d�}|�rz|�d g ��|� |S |�r�d d� ��� D �}|�d d� ��� D �� n|�r�|}�fd d�|D �}|��fd!d�|D �� g } i } t d" �rr��r�|�r��} n �fd#d��D �} d$���} | �d%d&� �D �� | �d'| � �� |�r�| �d(�d$�|��� | �d)d&� |D �� ��rZ| �r1g } �D ] }!|�r| �|!� n| �t|!��� | �d*d&� | D �� �qd+}"|"d$�| �7 }"| �|"� n)�D ]&}!|�r;|!}#nt|!��}#| �d,�|#�� | �|!i i� | �t||! �� �q3| | dd-�| �d�}|�rp|�d g ��|� |S d}d}d}��s~��r�zt d. dbd||||||t��|
|
| d d/� |��}$W nD t�y� } z7| d d0�}|j�r�|j� di �|d< |j |d< n i |d< d1�|�|d< |�r�|�d g ��|� |W Y d}~S d}~ww |�r�d }t |$t ��r�| �|$� n
t |$t ��r�| �|$� i }$d
t v �r�d|v �r�z|d �r
d
nd}t | | � d2��W n4 ttf�yL } z%| �t |�� | | d d-�| �d�}|�r@|�d g ��|� |W Y d}~S d}~ww d�v �rq�d �sq| i d d��d �d�}|�ro|�d g ��|� |S �fd3d��D �}�fd4d��D �}�fd5d��D �}|�r�t d |� | d6< |�r��fd7d�| D ����fd8d�� D �}%�fd9d��D �}&nTt d: d;k�r�d|d<< t d= dbd>di|��}'|� d?d ��r�d@t v �r�t d@ dbi |��}(ni }(t � |'| |(dA�\})}&�fdBd�|)D ����fdCd�|)D �}%�fdDd�|&D �}&��rQ|�rd$���} n d$�� fdEd��D ��} t| �dFk �r3| �dG| � �� n | �dH�t��t��dIk�rCdJndKt��dIk�rMdLndM�� |�r�|D ]y}|d }*|*| v �r�| �|d � t| |* dN �dk�r}| |* dN d-7 < | |* dN dO�|d dN �7 < t| |* dP �dk�r�| |* dP d-7 < | |* dP dO�|d dP �7 < �qV| �|d � i | |*< dO�|d dN �| |* dN< �qV|%�r|�r�d$�|%�} n d$�� fdQd�|%D ��} t|%�dFk�r�| �dR| � �� n | �dS�t|%�t|%�dIk�rdJndKt|%�dIk�rdLndM�� |�r&|D ]
}| �|d � �qd}|&�rK|�r4d$�|&�} n d$�� fdTd�|&D ��} | �!ddU| � �� d }|�r]|D ]
}| �|d � �qPd }t | t��rwtdVdW� | D ���rwt"dXdW� | D ��}+ng }+t | t��r�tdYdW� | D ���r�t"dZdW� | D ��},ng },g �g }&�D ]<}!| �r�|!|$v �r���|!� �q�|&�|!� �q�| �r�t d |!f|+|,d[�|��}-|-�r�|&�|!� |-||!< �q���|!� �q���r�D ]2}.|�r�|.}#nt|.� �}#d\|#� d]�}"|.|v �r |"d^7 }"| �|"� | �t||. �� �q�| �|"� �q�|&�rJ|&D ]2}/|�r |/}#nt|/� �}#d_|#� d`�}"|/|v �rA|"da7 }"| �|"� | �t||/ �� �q| �|"� �qd }| | |d-�| �d�}|�r`|�d g ��|� |S )cu�_
Ensure that the package is installed, and that it is the correct version
(if specified).
.. note::
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like ``saltenv``, or
``reload_modules``, will be passed through to the call to
``pkg.install`` to install the package(s). For example, you can include
a ``disablerepo`` argument on platforms that use yum/dnf to disable
that repo:
.. code-block:: yaml
mypkg:
pkg.installed:
- disablerepo: base,updates
To see what is supported, check :ref:`this page <virtual-pkg>` to find
the documentation for your platform's ``pkg`` module, then look at the
documentation for the ``install`` function.
Any argument that is passed through to the ``install`` function, which
is not defined for that function, will be silently ignored.
:param str name:
The name of the package to be installed. This parameter is ignored if
either "pkgs" or "sources" is used. Additionally, please note that this
option can only be used to install packages from a software repository.
To install a package file manually, use the "sources" option detailed
below.
:param str version:
Install a specific version of a package. This option is ignored if
"sources" is used. Currently, this option is supported
for the following pkg providers: :mod:`apt <salt.modules.aptpkg>`,
:mod:`ebuild <salt.modules.ebuild>`,
:mod:`pacman <salt.modules.pacman>`,
:mod:`pkgin <salt.modules.pkgin>`,
:mod:`win_pkg <salt.modules.win_pkg>`,
:mod:`yum <salt.modules.yumpkg>`, and
:mod:`zypper <salt.modules.zypperpkg>`. The version number includes the
release designation where applicable, to allow Salt to target a
specific release of a given version. When in doubt, using the
``pkg.latest_version`` function for an uninstalled package will tell
you the version available.
.. code-block:: bash
# salt myminion pkg.latest_version vim-enhanced
myminion:
2:7.4.160-1.el7
.. important::
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the
``pkg.latest_version`` output above) must have the epoch included
when specifying the version number. For example:
.. code-block:: yaml
vim-enhanced:
pkg.installed:
- version: 2:7.4.160-1.el7
In version 2015.8.9, an **ignore_epoch** argument has been added to
:py:mod:`pkg.installed <salt.states.pkg.installed>`,
:py:mod:`pkg.removed <salt.states.pkg.removed>`, and
:py:mod:`pkg.purged <salt.states.pkg.purged>` states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed.
Also, while this function is not yet implemented for all pkg frontends,
:mod:`pkg.list_repo_pkgs <salt.modules.yumpkg.list_repo_pkgs>` will
show all versions available in the various repositories for a given
package, irrespective of whether or not it is installed.
.. code-block:: bash
# salt myminion pkg.list_repo_pkgs bash
myminion:
----------
bash:
- 4.2.46-21.el7_3
- 4.2.46-20.el7_2
This function was first added for :mod:`pkg.list_repo_pkgs
<salt.modules.yumpkg.list_repo_pkgs>` in 2014.1.0, and was expanded to
:py:func:`Debian/Ubuntu <salt.modules.aptpkg.list_repo_pkgs>` and
:py:func:`Arch Linux <salt.modules.pacman.list_repo_pkgs>`-based
distros in the 2017.7.0 release.
The version strings returned by either of these functions can be used
as version specifiers in pkg states.
You can install a specific version when using the ``pkgs`` argument by
including the version after the package:
.. code-block:: yaml
common_packages:
pkg.installed:
- pkgs:
- unzip
- dos2unix
- salt-minion: 2015.8.5-1.el6
If the version given is the string ``latest``, the latest available
package version will be installed à la ``pkg.latest``.
**WILDCARD VERSIONS**
As of the 2017.7.0 release, this state now supports wildcards in
package versions for SUSE SLES/Leap/Tumbleweed, Debian/Ubuntu,
RHEL/CentOS, Arch Linux, and their derivatives. Using wildcards can be
useful for packages where the release name is built into the version in
some way, such as for RHEL/CentOS which typically has version numbers
like ``1.2.34-5.el7``. An example of the usage for this would be:
.. code-block:: yaml
mypkg:
pkg.installed:
- version: '1.2.34*'
Keep in mind that using wildcard versions will result in a slower state
run since Salt must gather the available versions of the specified
packages and figure out which of them match the specified wildcard
expression.
:param bool refresh:
This parameter controls whether or not the package repo database is
updated prior to installing the requested package(s).
If ``True``, the package database will be refreshed (``apt-get
update`` or equivalent, depending on platform) before installing.
If ``False``, the package database will *not* be refreshed before
installing.
If unset, then Salt treats package database refreshes differently
depending on whether or not a ``pkg`` state has been executed already
during the current Salt run. Once a refresh has been performed in a
``pkg`` state, for the remainder of that Salt run no other refreshes
will be performed for ``pkg`` states which do not explicitly set
``refresh`` to ``True``. This prevents needless additional refreshes
from slowing down the Salt run.
:param str cache_valid_time:
.. versionadded:: 2016.11.0
This parameter sets the value in seconds after which the cache is
marked as invalid, and a cache update is necessary. This overwrites
the ``refresh`` parameter's default behavior.
Example:
.. code-block:: yaml
httpd:
pkg.installed:
- fromrepo: mycustomrepo
- skip_verify: True
- skip_suggestions: True
- version: 2.0.6~ubuntu3
- refresh: True
- cache_valid_time: 300
- allow_updates: True
- hold: False
In this case, a refresh will not take place for 5 minutes since the last
``apt-get update`` was executed on the system.
.. note::
This parameter is available only on Debian based distributions and
has no effect on the rest.
:param str fromrepo:
Specify a repository from which to install
.. note::
Distros which use APT (Debian, Ubuntu, etc.) do not have a concept
of repositories, in the same way as YUM-based distros do. When a
source is added, it is assigned to a given release. Consider the
following source configuration:
.. code-block:: text
deb http://ppa.launchpad.net/saltstack/salt/ubuntu precise main
The packages provided by this source would be made available via
the ``precise`` release, therefore ``fromrepo`` would need to be
set to ``precise`` for Salt to install the package from this
source.
Having multiple sources in the same release may result in the
default install candidate being newer than what is desired. If this
is the case, the desired version must be specified using the
``version`` parameter.
If the ``pkgs`` parameter is being used to install multiple
packages in the same state, then instead of using ``version``,
use the method of version specification described in the **Multiple
Package Installation Options** section below.
Running the shell command ``apt-cache policy pkgname`` on a minion
can help elucidate the APT configuration and aid in properly
configuring states:
.. code-block:: bash
root@saltmaster:~# salt ubuntu01 cmd.run 'apt-cache policy ffmpeg'
ubuntu01:
ffmpeg:
Installed: (none)
Candidate: 7:0.10.11-1~precise1
Version table:
7:0.10.11-1~precise1 0
500 http://ppa.launchpad.net/jon-severinsson/ffmpeg/ubuntu/ precise/main amd64 Packages
4:0.8.10-0ubuntu0.12.04.1 0
500 http://us.archive.ubuntu.com/ubuntu/ precise-updates/main amd64 Packages
500 http://security.ubuntu.com/ubuntu/ precise-security/main amd64 Packages
4:0.8.1-0ubuntu1 0
500 http://us.archive.ubuntu.com/ubuntu/ precise/main amd64 Packages
The release is located directly after the source's URL. The actual
release name is the part before the slash, so to install version
**4:0.8.10-0ubuntu0.12.04.1** either ``precise-updates`` or
``precise-security`` could be used for the ``fromrepo`` value.
:param bool skip_verify:
Skip the GPG verification check for the package to be installed
:param bool skip_suggestions:
Force strict package naming. Disables lookup of package alternatives.
.. versionadded:: 2014.1.1
:param bool resolve_capabilities:
Turn on resolving capabilities. This allow one to name "provides" or alias names for packages.
.. versionadded:: 2018.3.0
:param bool allow_updates:
Allow the package to be updated outside Salt's control (e.g. auto
updates on Windows). This means a package on the Minion can have a
newer version than the latest available in the repository without
enforcing a re-installation of the package.
.. versionadded:: 2014.7.0
Example:
.. code-block:: yaml
httpd:
pkg.installed:
- fromrepo: mycustomrepo
- skip_verify: True
- skip_suggestions: True
- version: 2.0.6~ubuntu3
- refresh: True
- allow_updates: True
- hold: False
:param bool pkg_verify:
.. versionadded:: 2014.7.0
Use pkg.verify to check if already installed packages require
reinstallion. Requested packages that are already installed and not
targeted for up- or downgrade are verified with pkg.verify to determine
if any file installed by the package have been modified or if package
dependencies are not fulfilled. ``ignore_types`` and ``verify_options``
can be passed to pkg.verify. See examples below. Currently, this option
is supported for the following pkg providers:
:mod:`yum <salt.modules.yumpkg>`,
:mod:`zypperpkg <salt.modules.zypperpkg>`.
Examples:
.. code-block:: yaml
httpd:
pkg.installed:
- version: 2.2.15-30.el6.centos
- pkg_verify: True
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo
- bar: 1.2.3-4
- baz
- pkg_verify:
- ignore_types:
- config
- doc
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo
- bar: 1.2.3-4
- baz
- pkg_verify:
- ignore_types:
- config
- doc
- verify_options:
- nodeps
- nofiledigest
:param list ignore_types:
List of types to ignore when verifying the package
.. versionadded:: 2014.7.0
:param list verify_options:
List of additional options to pass when verifying the package. These
options will be added to the ``rpm -V`` command, prepended with ``--``
(for example, when ``nodeps`` is passed in this option, ``rpm -V`` will
be run with ``--nodeps``).
.. versionadded:: 2016.11.0
:param bool normalize:
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.. versionadded:: 2014.7.0
Example:
.. code-block:: yaml
gpfs.gplbin-2.6.32-279.31.1.el6.x86_64:
pkg.installed:
- normalize: False
:param bool ignore_epoch:
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to ``True`` to explicitly ignore the epoch, and ``False`` to
strictly enforce it.
.. versionadded:: 2015.8.9
.. versionchanged:: 3001
In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to ``True``.
|
**MULTIPLE PACKAGE INSTALLATION OPTIONS:**
:param list pkgs:
A list of packages to install from a software repository. All packages
listed under ``pkgs`` will be installed via a single command.
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo
- bar
- baz
- hold: True
``NOTE:`` For :mod:`apt <salt.modules.aptpkg>`,
:mod:`ebuild <salt.modules.ebuild>`,
:mod:`pacman <salt.modules.pacman>`,
:mod:`winrepo <salt.modules.win_pkg>`,
:mod:`yum <salt.modules.yumpkg>`, and
:mod:`zypper <salt.modules.zypperpkg>`,
version numbers can be specified
in the ``pkgs`` argument. For example:
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo
- bar: 1.2.3-4
- baz
Additionally, :mod:`ebuild <salt.modules.ebuild>`, :mod:`pacman
<salt.modules.pacman>`, :mod:`zypper <salt.modules.zypperpkg>`,
:mod:`yum/dnf <salt.modules.yumpkg>`, and :mod:`apt
<salt.modules.aptpkg>` support the ``<``, ``<=``, ``>=``, and ``>``
operators for more control over what versions will be installed. For
example:
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo
- bar: '>=1.2.3-4'
- baz
``NOTE:`` When using comparison operators, the expression must be enclosed
in quotes to avoid a YAML render error.
With :mod:`ebuild <salt.modules.ebuild>` is also possible to specify a
use flag list and/or if the given packages should be in
package.accept_keywords file and/or the overlay from which you want the
package to be installed. For example:
.. code-block:: yaml
mypkgs:
pkg.installed:
- pkgs:
- foo: '~'
- bar: '~>=1.2:slot::overlay[use,-otheruse]'
- baz
:param list sources:
A list of packages to install, along with the source URI or local path
from which to install each package. In the example below, ``foo``,
``bar``, ``baz``, etc. refer to the name of the package, as it would
appear in the output of the ``pkg.version`` or ``pkg.list_pkgs`` salt
CLI commands.
.. code-block:: yaml
mypkgs:
pkg.installed:
- sources:
- foo: salt://rpms/foo.rpm
- bar: http://somesite.org/bar.rpm
- baz: ftp://someothersite.org/baz.rpm
- qux: /minion/path/to/qux.rpm
**PLATFORM-SPECIFIC ARGUMENTS**
These are specific to each OS. If it does not apply to the execution
module for your OS, it is ignored.
:param bool hold:
Force the package to be held at the current installed version.
Supported on YUM/DNF & APT based systems.
.. versionadded:: 2014.7.0
Supported on Zypper-based systems.
.. versionadded:: 3003
:param bool update_holds:
If ``True``, and this function would update the package version, any
packages which are being held will be temporarily unheld so that they
can be updated. Otherwise, if this function attempts to update a held
package, the held package(s) will be skipped and the state will fail.
By default, this parameter is set to ``False``.
Supported on YUM/DNF & APT based systems.
.. versionadded:: 2016.11.0
Supported on Zypper-based systems.
.. versionadded:: 3003
:param list names:
A list of packages to install from a software repository. Each package
will be installed individually by the package manager.
.. warning::
Unlike ``pkgs``, the ``names`` parameter cannot specify a version.
In addition, it makes a separate call to the package management
frontend to install each package, whereas ``pkgs`` makes just a
single call. It is therefore recommended to use ``pkgs`` instead of
``names`` to install multiple packages, both for the additional
features and the performance improvement that it brings.
:param bool install_recommends:
Whether to install the packages marked as recommended. Default is
``True``. Currently only works with APT-based systems.
.. versionadded:: 2015.5.0
.. code-block:: yaml
httpd:
pkg.installed:
- install_recommends: False
:param bool only_upgrade:
Only upgrade the packages, if they are already installed. Default is
``False``. Currently only works with APT-based systems.
.. versionadded:: 2015.5.0
.. code-block:: yaml
httpd:
pkg.installed:
- only_upgrade: True
.. note::
If this parameter is set to True and the package is not already
installed, the state will fail.
:param bool report_reboot_exit_codes:
If the installer exits with a recognized exit code indicating that
a reboot is required, the module function
*win_system.set_reboot_required_witnessed*
will be called, preserving the knowledge of this event
for the remainder of the current boot session. For the time being,
``3010`` is the only recognized exit code,
but this is subject to future refinement.
The value of this param
defaults to ``True``. This parameter has no effect
on non-Windows systems.
.. versionadded:: 2016.11.0
.. code-block:: yaml
ms vcpp installed:
pkg.installed:
- name: ms-vcpp
- version: 10.0.40219
- report_reboot_exit_codes: False
:return:
A dictionary containing the state of the software installation
:rtype dict:
.. note::
The ``pkg.installed`` state supports the usage of ``reload_modules``.
This functionality allows you to force Salt to reload all modules. In
many cases, Salt is clever enough to transparently reload the modules.
For example, if you install a package, Salt reloads modules because some
other module or state might require the package which was installed.
However, there are some edge cases where this may not be the case, which
is what ``reload_modules`` is meant to resolve.
You should only use ``reload_modules`` if your ``pkg.installed`` does some
sort of installation where if you do not reload the modules future items
in your state which rely on the software being installed will fail. Please
see the :ref:`Reloading Modules <reloading-modules>` documentation for more
information.
.. seealso:: unless and onlyif
If running pkg commands together with :ref:`aggregate <mod-aggregate-state>`
isn't an option, you can use the :ref:`creates <creates-requisite>`,
:ref:`unless <unless-requisite>`, or :ref:`onlyif <onlyif-requisite>`
syntax to skip a full package run. This can be helpful in large environments
with multiple states that include requisites for packages to be installed.
.. code-block:: yaml
# Using creates for a simple single-factor check
install_nginx:
pkg.installed:
- name: nginx
- creates:
- /etc/nginx/nginx.conf
.. code-block:: yaml
# Using file.file_exists for a single-factor check
install_nginx:
pkg.installed:
- name: nginx
- unless:
- fun: file.file_exists
args:
- /etc/nginx/nginx.conf
# Using unless with a shell test
install_nginx:
pkg.installed:
- name: nginx
- unless: test -f /etc/nginx/nginx.conf
.. code-block:: yaml
# Using file.search for a two-factor check
install_nginx:
pkg.installed:
- name: nginx
- unless:
- fun: file.search
args:
- /etc/nginx/nginx.conf
- 'user www-data;'
The above examples use different methods to reasonably ensure
that a package has already been installed. First, with checking for a
file that would be created with the package. Second, by checking for
specific text within a file that would be created or managed by salt.
With these requisists satisfied, creates/unless will return ``True`` and the
``pkg.installed`` state will be skipped.
.. code-block:: bash
# Example of state run without unless used
salt 'saltdev' state.apply nginx
saltdev:
----------
ID: install_nginx
Function: pkg.installed
Name: nginx
Result: True
Comment: All specified packages are already installed
Started: 20:11:56.388331
Duration: 4290.0 ms
Changes:
# Example of state run using unless requisite
salt 'saltdev' state.apply nginx
saltdev:
----------
ID: install_nginx
Function: pkg.installed
Name: nginx
Result: True
Comment: unless condition is true
Started: 20:10:50.659215
Duration: 1530.0 ms
Changes:
The result is a reduction of almost 3 seconds. In larger environments,
small reductions in waiting time can add up.
:ref:`Unless Requisite <unless-requisite>`
r T� No packages to install providedrO Nr� r� r� Fzpkg.verify not implementedr3 )r� rl r� rM r' r� r� �pkg.hold�hold�
pkg.unhold)rP rk r� r- z?An error was encountered while holding/unholding package(s): {}rR c � g | ] }� | d r� | �qS �rQ r rC ��hold_retr r rH � �
��z installed.<locals>.<listcomp>c �, g | ]}� | d s� | d r� | �qS �rQ r- r rC r� r r rH � �
�
��c � g | ] }� | d s� | �qS �r- r rC r� r r rH � r� z.
{}rQ rP zlowpkg.unpurgez lowpkg.unpurge not implementedr� c S � g | ] \}}t ||fg��qS r �r= r� r r r rH � c S r� r r� r� r r r rH r� c �( g | ]}t tt|�� ���� v r|�qS r �r� �iterr� ri rC �ru r r rH � ( c r� r r� rC )r� r r rH
r� �testc � g | ]}t |� ��qS r �r� rC r� r r rH � r] c S � i | ]}|d dd��qS �� installedr ��new�oldr rC r r r r� � z installed.<locals>.<dictcomp>z3The following packages would be installed/updated: z^The following packages would have their selection status changed from 'purge' to 'install': {}c S r� r� r rC r r r r� r� c S r� r� r rC r r r r� - r� z-The following packages would be reinstalled: zPPackage '{}' would be reinstalled because the following files have been altered:�
r ) rP r� r8 r� � skip_verifyrk r� r� rM � update_holdsr' �
split_arch�rP r- �8An error was encountered while installing package(s): {}�rP rk c r� r� r rC r� r r rH � r� c r� r� r rC r� r r rH � r� c r� r� r rC r� r r rH � r� rB c � g | ]}|� v r|�qS r r rC r� r r rH � r� c � g | ] }|� vr|�vr|�qS r r rC �ru r� r r rH � s c � g | ]}|� vr|�qS r r rC )�modifiedr r rH � r� r| r} r~ rA r r� r� )r' r� c r� r r rC r� r r rH � r� c r r r rC r r r rH � r� c r� r r rC r� r r rH � r� c r� r r� rC �rI r r rH � r� � z/The following packages were installed/updated: z+{} targeted package{} {} installed/updated.r/ �sr ZwereZwasr� z{}r� c r� r r� rC r r r rH � r� z/The following packages were already installed: z*{} targeted package{} {} already installedc r� r r� rC r r r rH � r� z1The following packages failed to install/update: c s r� r� r� rC r r r r� r� z installed.<locals>.<genexpr>c s r� r� r� rC r r r r� r� c s r� r� r� rC r r r r� r� c s r� r� r� rC r r r r� r� r� rZ z was reinstalled.z% The following files were remediated:z)Reinstall was not successful for package �.z- The following files could not be remediated:r )#r< r� r1 r� �__env__r r r �
check_refreshr� r� r �strr� �
ValueErrorr r rc r� r� rg re r� r+ r� r� r� �infor: �strerror_without_changesr= r� r� �insertr� )0rP r8 r� r� r� rl rk r� r3 r� rM r' r� r� rG r- r� r� r� r� �actionrv Z
modified_holdZnot_modified_holdZ failed_hold�ir� Z
oldsourcesrR rQ Z_targets�summaryZreinstall_targetsZ
reinstall_pkgrw Zpkgstr�pkg_retZ not_modifiedr� r� r� r� Z change_namer� r� r� Z modified_pkgZ
failed_pkgr )rI r� r ru r� r r� � s "�
��� � �����
�
�
�
� �5��
� � � �
�� �
�
����
���
�
�
�
� �
�
� ��
"& ��
�
�
�
�
���
�
�r� c
sD | i ddd�}dt vrd|d< d|d< |S t|t�r*t|�d kr*d
|d< d |d< |S | r;|s;|r8| |ig}d}n| g}d |v rB|d = t|fi |��\}}t| ||f||d
�|��� t� t�rdd� v rd� S t� t�svd|d< d�� �|d< |S td r�d� � �}d�|�|d< |S z t d d | ||d
||d�|��} d
|d< |d �
| � W n6 t y� }
z*| dd�}|
j r�|
j �
di �|d< |
j|d< n i |d< d|
� �|d< |W Y d}
~
S d}
~
ww t d d i |��} t� | |d�\} }
|
�rd� � fdd�|
D ��}d|d< d|� �|d< |d �s |d �s d
|d< d�d� � ��|d< |S ) aI
.. versionadded:: 2017.7.0
Ensure that the package is downloaded, and that it is the correct version
(if specified).
.. note::
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like ``saltenv``, or
``reload_modules``, will be passed through to the call to
``pkg.install`` to download the package(s). For example, you can include
a ``disablerepo`` argument on platforms that use yum/dnf to disable
that repo:
.. code-block:: yaml
mypkg:
pkg.downloaded:
- disablerepo: base,updates
To see what is supported, check :ref:`this page <virtual-pkg>` to find
the documentation for your platform's ``pkg`` module, then look at the
documentation for the ``install`` function.
Any argument that is passed through to the ``install`` function, which
is not defined for that function, will be silently ignored.
Currently supported for the following pkg providers:
:mod:`yum <salt.modules.yumpkg>`, :mod:`zypper <salt.modules.zypperpkg>` and :mod:`apt <salt.modules.aptpkg>`
:param str name:
The name of the package to be downloaded. This parameter is ignored if
either "pkgs" is used. Additionally, please note that this option can
only be used to download packages from a software repository.
:param str version:
Download a specific version of a package.
.. important::
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon must have the epoch included
when specifying the version number. For example:
.. code-block:: yaml
vim-enhanced:
pkg.downloaded:
- version: 2:7.4.160-1.el7
An **ignore_epoch** argument has been added to which causes the
epoch to be disregarded when the state checks to see if the desired
version was installed.
You can install a specific version when using the ``pkgs`` argument by
including the version after the package:
.. code-block:: yaml
common_packages:
pkg.downloaded:
- pkgs:
- unzip
- dos2unix
- salt-minion: 2015.8.5-1.el6
:param bool resolve_capabilities:
Turn on resolving capabilities. This allow one to name "provides" or alias names for packages.
.. versionadded:: 2018.3.0
CLI Example:
.. code-block:: yaml
zsh:
pkg.downloaded:
- version: 5.0.5-4.63
- fromrepo: "myrepository"
Nr rO rK Fr- z:The pkg.downloaded state is not available on this platformrR r Tz No packages to download provided� downloadonly)r� r' �3An error was encountered while checking targets: {}r� r] z.The following packages would be downloaded: {}r )rP rk r8 r r� r' rQ r� �7An error was encountered while downloading package(s): r0 c r� r r� rC r� r r rH � r� z downloaded.<locals>.<listcomp>z+The following packages failed to download: zPackages downloaded: {}r )r r< r� r1 r� rx r= rc r� re r� r r r: r
r� )rP r8 rk r� r' rG r� Z_refreshr r rv r� r� r� r r� r �
downloaded_ s� S
���
�
���
���
r c
K s� | i ddd�}dt vrd|d< d|d< |S t|t�r*t|�d kr*d
|d< d |d< |S t| |fi |��}t|t�r>d|v r>|S t|t�sPd|d< d �|�|d< |S td
rbd�|�}d|� �|d< |S zt d d| ||d�|��}d
|d< |d � |� W n6 t
y� } z*| dd�}|j r�|j � di �|d< |j
|d< n i |d< d|� �|d< |W Y d}~S d}~ww |d s�|d s�|r�dnd} d
|d< d�| �|d< |S )a�
.. versionadded:: 2017.7.0
Ensure that packages related to certain advisory ids are installed.
.. note::
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like ``saltenv``, or
``reload_modules``, will be passed through to the call to
``pkg.install`` to install the patch(es).
To see what is supported, check :ref:`this page <virtual-pkg>` to find
the documentation for your platform's ``pkg`` module, then look at the
documentation for the ``install`` function.
Any argument that is passed through to the ``install`` function, which
is not defined for that function, will be silently ignored.
Currently supported for the following pkg providers:
:mod:`yum <salt.modules.yumpkg>` and :mod:`zypper <salt.modules.zypperpkg>`
CLI Example:
.. code-block:: yaml
issue-foo-fixed:
pkg.patch_installed:
- advisory_ids:
- SUSE-SLE-SERVER-12-SP2-2017-185
- SUSE-SLE-SERVER-12-SP2-2017-150
- SUSE-SLE-SERVER-12-SP2-2017-120
Nr rO �pkg.list_patchesFr- z?The pkg.patch_installed state is not available on this platformrR r TzNo advisory ids providedr r� r] z4The following advisory patches would be downloaded: r �rP rz r rQ r� r r r� z?Advisory patch is not needed or related packages are already {}r )r r< r� r1 r{ r= rc r� re r� r r r: r
)
rP rz r rG r� ru r r rv �statusr r r �patch_installed
sf !�
�
���
���
��r c K s: dt vr | di dd�S d|v r|d= td | |dd�|��S )
a
.. versionadded:: 2017.7.0
Ensure that packages related to certain advisory ids are downloaded.
Currently supported for the following pkg providers:
:mod:`yum <salt.modules.yumpkg>` and :mod:`zypper <salt.modules.zypperpkg>`
CLI Example:
.. code-block:: yaml
preparing-to-fix-issues:
pkg.patch_downloaded:
- advisory_ids:
- SUSE-SLE-SERVER-12-SP2-2017-185
- SUSE-SLE-SERVER-12-SP2-2017-150
- SUSE-SLE-SERVER-12-SP2-2017-120
r Fz@The pkg.patch_downloaded state is not available on this platform)rP r- rQ rR r Tr Nr )r r )rP rz rG r r r �patch_downloadedj s � ��r c
s t jj�t|�}|�d�r| i ddd�S |r(tt|��� �}|s'| i ddd�S nt |t�r:t
|�dkr:| i ddd�S | g}t |d < t |fd
|i|��\}}zt
d |||d �|��}W n tyw } z| i dd
�| �d�W Y d} ~ S d} ~ ww z t
d |i |���W n ty� } z| i d| jd�W Y d} ~ S d} ~ ww t �t�r�|d �i�t |t�r�|d |i}i �g }
|D ]9} |�| �s��| �s�d| � d�} t�| � |
�| � q�|r�t�d�dkr�t
d | �r�| �| < q�|| �| < q�|
�r| i dd�|
�d�S ��r]|�s
g }
n �fdd�|D �}
td �rXg }|�dd�t��� � |
�rNt
|
�}|dk�rF|�d d��fd d�t|
�D �� � n|�|� d �� | i dd �|�d�S t jj�� �ri�fd d��D �}nt��}zt
d! d5dd|||d"�|��� W n t�y� } z| i dd#�| �d�W Y d} ~ S d} ~ ww � �r� �fd$d��D ���fd%d��D �}g }��r�d&�d�t����} |�| � |�r�d'�d�t|���} |�| � |
�r�t
|
�dk�r�d(�d�t|
���} nt
|
�� d)�} |�| � | � ��r dndd�|�d�S t
��dk�rd*�t
���}n t
��d+k�r)d,�d�t����}n
d-�ttt��� ����}|
�rVt
|
�dk�rM|d.�d�t|
���7 }n |d/�t
|
��7 }| � d|d�S t
|�dk�rmd0t
|�� d1�}nt
|�d+k�rd2�d�t|���}nd3|d � d4�}| i d|d�S )6a�
Ensure that the named package is installed and the latest available
package. If the package can be updated, this state function will update
the package. Generally it is better for the
:mod:`installed <salt.states.pkg.installed>` function to be
used, as :mod:`latest <salt.states.pkg.latest>` will update the package
whenever a new package is available.
.. note::
Any argument which is either a) not explicitly defined for this state,
or b) not a global state argument like ``saltenv``, or
``reload_modules``, will be passed through to the call to
``pkg.install`` to install the package(s). For example, you can include
a ``disablerepo`` argument on platforms that use yum/dnf to disable
that repo:
.. code-block:: yaml
mypkg:
pkg.latest:
- disablerepo: base,updates
To see what is supported, check :ref:`this page <virtual-pkg>` to find
the documentation for your platform's ``pkg`` module, then look at the
documentation for the ``install`` function.
Any argument that is passed through to the ``install`` function, which
is not defined for that function, will be silently ignored.
name
The name of the package to maintain at the latest available version.
This parameter is ignored if "pkgs" is used.
fromrepo
Specify a repository from which to install
skip_verify
Skip the GPG verification check for the package to be installed
refresh
This parameter controls whether or not the package repo database is
updated prior to checking for the latest available version of the
requested packages.
If ``True``, the package database will be refreshed (``apt-get update``
or equivalent, depending on platform) before checking for the latest
available version of the requested packages.
If ``False``, the package database will *not* be refreshed before
checking.
If unset, then Salt treats package database refreshes differently
depending on whether or not a ``pkg`` state has been executed already
during the current Salt run. Once a refresh has been performed in a
``pkg`` state, for the remainder of that Salt run no other refreshes
will be performed for ``pkg`` states which do not explicitly set
``refresh`` to ``True``. This prevents needless additional refreshes
from slowing down the Salt run.
:param str cache_valid_time:
.. versionadded:: 2016.11.0
This parameter sets the value in seconds after which the cache is
marked as invalid, and a cache update is necessary. This overwrites
the ``refresh`` parameter's default behavior.
Example:
.. code-block:: yaml
httpd:
pkg.latest:
- refresh: True
- cache_valid_time: 300
In this case, a refresh will not take place for 5 minutes since the last
``apt-get update`` was executed on the system.
.. note::
This parameter is available only on Debian based distributions and
has no effect on the rest.
:param bool resolve_capabilities:
Turn on resolving capabilities. This allow one to name "provides" or alias names for packages.
.. versionadded:: 2018.3.0
Multiple Package Installation Options:
(Not yet supported for: FreeBSD, OpenBSD, MacOS, and Solaris pkgutil)
pkgs
A list of packages to maintain at the latest available version.
.. code-block:: yaml
mypkgs:
pkg.latest:
- pkgs:
- foo
- bar
- baz
install_recommends
Whether to install the packages marked as recommended. Default is
``True``. Currently only works with APT-based systems.
.. versionadded:: 2015.5.0
.. code-block:: yaml
httpd:
pkg.latest:
- install_recommends: False
only_upgrade
Only upgrade the packages, if they are already installed. Default is
``False``. Currently only works with APT-based systems.
.. versionadded:: 2015.5.0
.. code-block:: yaml
httpd:
pkg.latest:
- only_upgrade: True
.. note::
If this parameter is set to True and the package is not already
installed, the state will fail.
report_reboot_exit_codes
If the installer exits with a recognized exit code indicating that
a reboot is required, the module function
*win_system.set_reboot_required_witnessed*
will be called, preserving the knowledge of this event
for the remainder of the current boot session. For the time being,
``3010`` is the only recognized exit code, but this
is subject to future refinement. The value of this param
defaults to ``True``. This parameter has no effect on
non-Windows systems.
.. versionadded:: 2016.11.0
.. code-block:: yaml
ms vcpp installed:
pkg.latest:
- name: ms-vcpp
- report_reboot_exit_codes: False
r� Fz)The "sources" parameter is not supported.rO z5Invalidly formatted "pkgs" parameter. See minion log.r Tr� r� r� r� )r� r� zVAn error was encountered while checking the newest available version of package(s): {}N� pkg.versionzNo information found for 'z'.r| �Gentooz portage_config.is_changed_usesra c r r r rC r� r r rH �
r� zlatest.<locals>.<listcomp>r� z4The following packages would be installed/upgraded: r] �
z/The following packages are already up-to-date: c s g | ] }|� d � | � d��qS )z (�)r rC )�curr r rH �
r� z packages are already up-to-dater� c s g | ]}|� | i�qS r r rC r� r r rH �
r� r )rP r� r� r� rk r� c sT g | ]&}� � |�r&� | � d �dur(�| � | � d ��d�vr(�| dkr|�qS )r� Nr) r� )r: r* rC )rQ ru r r rH �
s � �c r r r rC )r� r r rH �
r� z+The following packages failed to update: {}z?The following packages were successfully installed/upgraded: {}z2The following packages were already up-to-date: {}z" packages were already up-to-date zA{} targeted packages failed to update. See debug log for details.r/ zRThe following targeted packages failed to update. See debug log for details: ({}).z Package {} failed to update.z3 The following packages were already up-to-date: {}z#{} packages were already up-to-datezAll z packages are up-to-date.z!All packages are up-to-date ({}).rZ z is already up-to-dater ) r r r r r� r: r� r ri r< r1 r r� r r rc rj r
r� �errorr+ r� re rf r; r� r� r� )rP r� r� r� rk Z watch_flagsrG Z desired_pkgsZavailrv rr r rw Z
up_to_daters Zup_to_date_countZ
targeted_pkgsZ
successfulrR r )rQ r r� ru r r� � s� %
��� ���
��
���� ��
�
� ��
��
�����
����� � �
�
�
�
� ��� ���� �r� �removec
s" � dvr|i dd� � d�d�S zt d ||f||d�|��d }W n ty= } z|i dd |� �d�W Y d
}~S d
}~ww t||||fd |i|���t�t�r]d �v r]� d
kr[g �n�S t�t�ss� d
krig �n
|i dd���d�S � d
kr�t d d+ddd�|������fdd�|D �� ��� �s�|i dd�� d
kr�d�d�S d�d�S t d r�i } | �
� fdd��D �� || d
d�� d� ���d�S t d � � � |f||dd �|��}
t d d+d di|��} g } |D ];}
t d d v �r|
| v r�||
s�| �
|
� q�|
| v �r||
| |
v �r| �
|
d! ||
� q�|
| v �r#| �
|
� q� d
k�rAt d d+ddd�|���| ��fd"d�|D �� | �� | �rV||
dd#�� d� | ��d�S g }t�fd$d%�|D ��}|�r~|�
d&�d� |��� |�
d'�� d� ���� n |�
d(� � d)�� ||
dd*� |�d�S ),z-
Common function for package removal
)r" �purgeFzInvalid action 'z'. This is probably a bug.rO zpkg_resource.parse_targets)rM r8 r z0An error was encountered while parsing targets: Nr' r- r# r rA T)r �removedc r� r r rC )� old_removedr r rH j r� z _uninstall.<locals>.<listcomp>z-None of the targeted packages are installed{}z or partially installedr r� c s i | ] }|� � d �dd��qS )�dr r� r rC )r r r r� y r� z _uninstall.<locals>.<dictcomp>z'The following packages will be {}d: {}.r] �pkg.)rk r8 r� r r� )ZSuseZRedHat�Windows�-c r� r r rC )� new_removedr r rH � r� z(The following packages failed to {}: {}.c 3 s � | ] }|� vr|V qd S rU r rC r� r r r� � s � z _uninstall.<locals>.<genexpr>z-The following packages were not installed: {}z$The following packages were {}d: {}.zAll targeted packages were zd.ra r )r r r� r< r= r� rc r� �sortr� r� re r� r+ rf )r rP r8 rk rM r' rG Z
pkg_paramsrv Z_changesrQ r� r� �paramrs r� r )r r* r% ru r �
_uninstall1 s�
�����������
����
����
�� ��� �
�
��
�� ����r- c
K � t |d< ztd
d| ||||d�|��W S tyI } z*| dd�}|jr2|j�di �|d< |j|d< n i |d< d|� �|d< |W Y d }~S d }~ww ) a�
Verify that a package is not installed, calling ``pkg.remove`` if necessary
to remove the package.
name
The name of the package to be removed.
version
The version of the package that should be removed. Don't do anything if
the package is installed with an unmatching version.
.. important::
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the example above)
must have the epoch included when specifying the version number.
For example:
.. code-block:: yaml
vim-enhanced:
pkg.removed:
- version: 2:7.4.160-1.el7
In version 2015.8.9, an **ignore_epoch** argument has been added to
:py:mod:`pkg.installed <salt.states.pkg.installed>`,
:py:mod:`pkg.removed <salt.states.pkg.removed>`, and
:py:mod:`pkg.purged <salt.states.pkg.purged>` states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed. If **ignore_epoch** was not set
to ``True``, and instead of ``2:7.4.160-1.el7`` a version of
``7.4.160-1.el7`` were used, this state would report success since
the actual installed version includes the epoch, and the specified
version would not match.
normalize : True
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.. versionadded:: 2015.8.0
ignore_epoch : None
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to ``True`` to explicitly ignore the epoch, and ``False`` to
strictly enforce it.
.. versionadded:: 2015.8.9
.. versionchanged:: 3001
In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to ``True``.
Multiple Package Options:
pkgs
A list of packages to remove. Must be passed as a python list. The
``name`` parameter will be ignored if this option is passed. It accepts
version numbers as well.
.. versionadded:: 0.16.0
r� r" �r rP r8 rk rM r' Fr� rQ rR z4An error was encountered while removing package(s): Nr �r r- r r r: r
�rP r8 rk rM r' rG rv r� r r r r$ � s. C��
���r$ c
K r. ) a�
Verify that a package is not installed, calling ``pkg.purge`` if necessary
to purge the package. All configuration files are also removed.
name
The name of the package to be purged.
version
The version of the package that should be removed. Don't do anything if
the package is installed with an unmatching version.
.. important::
As of version 2015.8.7, for distros which use yum/dnf, packages
which have a version with a nonzero epoch (that is, versions which
start with a number followed by a colon like in the example above)
must have the epoch included when specifying the version number.
For example:
.. code-block:: yaml
vim-enhanced:
pkg.purged:
- version: 2:7.4.160-1.el7
In version 2015.8.9, an **ignore_epoch** argument has been added to
:py:mod:`pkg.installed <salt.states.pkg.installed>`,
:py:mod:`pkg.removed <salt.states.pkg.removed>`, and
:py:mod:`pkg.purged <salt.states.pkg.purged>` states, which
causes the epoch to be disregarded when the state checks to see if
the desired version was installed. If **ignore_epoch** was not set
to ``True``, and instead of ``2:7.4.160-1.el7`` a version of
``7.4.160-1.el7`` were used, this state would report success since
the actual installed version includes the epoch, and the specified
version would not match.
normalize : True
Normalize the package name by removing the architecture, if the
architecture of the package is different from the architecture of the
operating system. The ability to disable this behavior is useful for
poorly-created packages which include the architecture as an actual
part of the name, such as kernel modules which match a specific kernel
version.
.. versionadded:: 2015.8.0
ignore_epoch : None
If this option is not explicitly set, and there is no epoch in the
desired package version, the epoch will be implicitly ignored. Set this
argument to ``True`` to explicitly ignore the epoch, and ``False`` to
strictly enforce it.
.. versionadded:: 2015.8.9
.. versionchanged:: 3001
In prior releases, the default behavior was to strictly enforce
epochs unless this argument was set to ``True``.
Multiple Package Options:
pkgs
A list of packages to purge. Must be passed as a python list. The
``name`` parameter will be ignored if this option is passed. It accepts
version numbers as well.
.. versionadded:: 0.16.0
r� r# r/ Fr� rQ rR z3An error was encountered while purging package(s): Nr r0 r1 r r r �purged s, C��
��r2 c
s& | i ddd��dt vrd�d< �S d� v r!td d kr!d
�d< �S t|t�r~t�fd |i� ��\�}z1t d d d |i� ��}� fd d
�|�� D �}t�t�rb�fdd�|D �}�fdd
�|�� D �}W n ty} } zt|��d< �W Y d}~S d}~ww d�d< �S |s�d�d< d�d< �S t d r�d�d< |�d< d�d< �S zt d d |�d�� ���d< W n1 t
y� } z%|j r�|j � di ��d< |j
�d< n i �d< d|� ��d< �W Y d}~S d}~ww g }t�t�r��fd d�|�� D �}|�r d �d �|���d< d�d< �S d �d< d�d< �S )!a@
.. versionadded:: 2014.7.0
.. versionchanged:: 2018.3.0
Added support for the ``pkgin`` provider.
Verify that the system is completely up to date.
:param str name
The name has no functional value and is only used as a tracking
reference
:param bool refresh
refresh the package database before checking for new upgrades
:param list pkgs
list of packages to upgrade
:param bool resolve_capabilities:
Turn on resolving capabilities. This allow one to name "provides" or alias names for packages.
.. versionadded:: 2018.3.0
:param kwargs
Any keyword arguments to pass through to the ``pkg`` module.
For example, for apt systems: `dist_upgrade`, `cache_valid_time`, `force_conf_new`
.. versionadded:: 2015.5.0
FzFailed to updaterO zpkg.list_upgradesz#State pkg.uptodate is not availablerR r� r| r z2'fromrepo' argument not supported on this platformr� c s, i | ]\}}||t d |fi � ��d��qS )r r� r �rD rW r rF r r r� � s ���z uptodate.<locals>.<dictcomp>c r� r r �rD r �rk r r rH � r� z uptodate.<locals>.<listcomp>c s i | ] \}}|� v r||�qS r r r3 r5 r r r� � s
�Nz$refresh must be either True or Falsez System is already up-to-dateTr- r� z System update will be performedrQ z pkg.upgrade)r� rk z2An error was encountered while updating packages: c s g | ]
}|� d vr|�qS r� r r4 )r� r r rH � r� z-The following package(s) failed to update: {}r] zUpgrade ran successfullyr )r r� r< r� r� rg r� � Exceptionr
r� r r r: r
ri rc re )rP r� rk rG Zpackages�expectedrv �missingr )rG rk r� r �uptodatep sv
�
�� �� ��
��r9 c
s$ | i ddd�}dt vrd|d< |S �du rg �n t�t�s#d|d< |S t��D ]\}}t|t�s6t|��|< q'|du r>g }n t|t�sId |d< |S t|�D ]\}}t|t�s\t|�||< qMzt d | fi tjjjd)i � ����}W n, t t
fy� } z d
t|�v r�d |d< n d | � d
|� d�|d< |W Y d}~S d}~ww |d d |d d } �fdd�| D �}
|
r�d� d� |
��|d< |S |d d } | �
�fdd�|d d D �� | �
|� | s�d|d< d| � d�|d< |S |d d p�|d d p�|d d } td �r d|d< | �rd| � d �|d< |S d| � d �|d< |S zt d d)d!| i� ��|d"< W n9 t �yf }
z,| dd#�}|
j�rN|
j�d"i �|d"< |
j|d< n i |d"< d$� | |
�|d< |W Y d}
~
S d}
~
ww � fd%d�| D �}|�rd&� d� |��|d< |S d|d< d'� | | �r�d(nd�|d< |S )*a�
.. versionadded:: 2015.8.0
.. versionchanged:: 2016.11.0
Added support in :mod:`pacman <salt.modules.pacman>`
.. versionchanged:: 3006.2
For RPM-based systems, support for ``fromrepo``, ``enablerepo``, and
``disablerepo`` (as used in :py:func:`pkg.install
<salt.modules.yumpkg.install>`) has been added. This allows one to, for
example, use ``enablerepo`` to perform a group install from a repo that
is otherwise disabled.
Ensure that an entire package group is installed. This state is currently
only supported for the :mod:`yum <salt.modules.yumpkg>` and :mod:`pacman
<salt.modules.pacman>` package managers.
skip
Packages that would normally be installed by the package group
("default" packages), which should not be installed.
.. code-block:: yaml
Load Balancer:
pkg.group_installed:
- skip:
- piranha
include
Packages which are included in a group, which would not normally be
installed by a ``yum groupinstall`` ("optional" packages). Note that
this will not enforce group membership; if you include packages which
are not members of the specified groups, they will still be installed.
.. code-block:: yaml
Load Balancer:
pkg.group_installed:
- include:
- haproxy
.. versionchanged:: 2016.3.0
This option can no longer be passed as a comma-separated list, it
must now be passed as a list (as shown in the above example).
.. note::
The below options are only supported on RPM-based systems
fromrepo
Restrict ``yum groupinfo`` to the specified repo(s).
(e.g., ``yum --disablerepo='*' --enablerepo='somerepo'``)
.. code-block:: yaml
MyGroup:
pkg.group_installed:
- fromrepo: base,updates
.. versionadded:: 3006.2
enablerepo (ignored if ``fromrepo`` is specified)
Specify a disabled package repository (or repositories) to enable.
(e.g., ``yum --enablerepo='somerepo'``)
.. code-block:: yaml
MyGroup:
pkg.group_installed:
- enablerepo: myrepo
.. versionadded:: 3006.2
disablerepo (ignored if ``fromrepo`` is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., ``yum --disablerepo='somerepo'``)
.. code-block:: yaml
MyGroup:
pkg.group_installed:
- disablerepo: epel
.. versionadded:: 3006.2
.. note::
Because this is essentially a wrapper around :py:func:`pkg.install
<salt.modules.yumpkg.install>`, any argument which can be passed to
pkg.install may also be included here, and it will be passed on to the
call to :py:func:`pkg.install <salt.modules.yumpkg.install>`.
Fr rO zpkg.group_diffz1pkg.group_install not available for this platformrR Nz skip must be formatted as a listz#include must be formatted as a listzunexpected keyword argumentz/Repo options are not supported on this platformz:An error was encountered while installing/updating group 'z': r � mandatoryr� z
not installedc r� r r rC ��skipr r rH ^
r� z#group_installed.<locals>.<listcomp>z6The following mandatory packages cannot be skipped: {}r] c r r r rC r; r r rH h
r� �defaultTr- zGroup 'z' is already installedZoptionalr� z,' is partially installed and will be updatedz' will be installedr rk rQ r� zAAn error was encountered while installing/updating group '{}': {}c s& g | ]}|t d di � ��vr|�qS )rA r r rC rF r r rH �
s & z,Failed to install the following packages: {}zGroup '{}' was {}�updatedr )r r< r� � enumerater
r r �argsZ clean_kwargsr � TypeErrorrc re r� r� r r: r
)rP r< ZincluderG r� �idx�item�diffr� r: Z invalid_skipru Zpartially_installedrv r� r )rG r< r �group_installed� s� [
�
��
�
��� ��
�
�
��
�����rE c C sF d}dt v r t d | �}| d dks| d dkr!tjj�t� |S dS )a�
Set a flag to tell the install functions to refresh the package database.
This ensures that the package database is refreshed only once during
a state run significantly improving the speed of package management
during a state run.
It sets a flag for a number of reasons, primarily due to timeline logic.
When originally setting up the mod_init for pkg a number of corner cases
arose with different package managers and how they refresh package data.
It also runs the "ex_mod_init" from the package manager module that is
currently loaded. The "ex_mod_init" is expected to work as a normal
"mod_init" function.
.. seealso::
:py:func:`salt.modules.ebuild.ex_mod_init`
Tzpkg.ex_mod_init�funr� r� F)r r r r Z
write_rtagr� )�lowr� r r r �mod_init�
s rH c C sn g }d}g d�}| � d�|vr| S |D ]�}td |�}||v r q|� d�dkr�d|v r,q|� d�| � d�kr7q|� d�| � d�krBqd |v r\|du rLd }|d kr[|�|d � d
|d< qd |vr�|du rfd }|d kr�d |v rz|�|d � d
|d< qd
|v r�|�dd�}|dur�|�|d
|i� n|�|d
� d
|d< q|dur�|r�|| v r�| | �|� | S || |< | S )z�
The mod_aggregate function which looks up all packages in the available
low chunks and merges them into a single pkgs ref in the present low data
N)r� r� r$ r2 rF z
state.gen_tag�stater Z__agg__r� r� Tr� rk rP r8 )r: Z __utils__r� r� r+ ) rG �chunksZrunningrk Zpkg_typeZ agg_enabled�chunk�tagr8 r r r �
mod_aggregate�
sV �
� �rM c K sL |� dd�}ttttd�}||v r|| | fi |��S | i d|� d�dd�S )a1
Install/reinstall a package based on a watch requisite
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. It should not be called directly.
Parameters for this function should be set by the state being triggered.
�sfunN)r2 r� r$ r� r' z' does not work with the watch requisiteF�rP rQ rR r- )r� r2 r� r$ r� )rP rG rN Zmapfunr r r � mod_watch�
s
�
�rP c K s� | i ddd�}|� dd�}ddg}||v rB|�d�r;d }d
|� d | � �}||�d | g�d
|d�}td di |��}|S | i ddd�S | i d�|�dd�S )a
Create a beacon to monitor a package or packages
based on a beacon state argument.
.. note::
This state exists to support special handling of the ``beacon``
state argument for supported state functions. It should not be called directly.
Tr rO rN Nr� r$ Zbeaconr Zbeacon_�_rk �< )rP rk �interval�
beacon_modulezbeacon.presentzNot adding beacon.rO z7pkg.{} does not work with the mod_beacon state functionFr )r� r: Z
__states__rc )rP rG r� rN Zsupported_funcsrT Z beacon_nameZ
beacon_kwargsr r r �
mod_beacon s4
�� ��rU c K s< t |t�rt|�dkr|s| i ddd�S | r'|du r'|r$| |ig}d}n| g}i }d}dtv r7td � }d}nldtv r�td dd �}t�d
�}|D ]5} |�| �}
|
rw|
�d �} | d kr^d
} n| � d�} |�|
�d�d| � |
�d�� �ii� qI|�| i i� qIn#dtv r�td dd�}|� dg �D ] } |�| i i� q�n| i ddd�S dtvr�| i ddd�S | i dd
d�} g }
t
� }|D ]�}t |t �r�t t
|�� ��\}}n|}d}d}||v r�d|| v r�|| d }|�d�}|�|� ||vs�|�r�||k�r�td �r*||v �r|
�d�||�sd
nd|� d ��� q�|
�d �||�s!d
nd|� d ��� q�d}||v �r:td | |gd �}td | |gd �}|� |i �� d d��sRd| d < |�rx|� |i �� d d��rx|�rx|� |i �� d d��rx|
�d!|� d"�� n!|�r�|� |i �� d d��r�|
�d!|� d#�� n |
�d!|� d$�� | d% �|� q�|�r|D ]`}|| � d&d'�d'k�r��q�td �r�||v�r�|
�d(|� �� �q�||v�rtd | |gd �}|� |i �� d d��s�d| d < |�r�|� |i �� d)��r�|
�|� |�� d)�� | d% �|� �q�d*�|
�| d)< | d% �s | d) �s d+| d)< | S ),a4
.. versionadded:: 3005
Set package in 'hold' state, meaning it will not be changed.
:param str name:
The name of the package to be held. This parameter is ignored
if ``pkgs`` is used.
:param str version:
Hold a specific version of a package.
Full description of this parameter is in `installed` function.
.. note::
This parameter make sense for Zypper-based systems.
Ignored for YUM/DNF and APT
:param list pkgs:
A list of packages to be held. All packages listed under ``pkgs``
will be held.
.. code-block:: yaml
mypkgs:
pkg.held:
- pkgs:
- foo
- bar: 1.2.3-4
- baz
.. note::
For Zypper-based systems the package could be held for
the version specified. YUM/DNF and APT ingore it.
:param bool replace:
Force replacement of existings holds with specified.
By default, this parameter is set to ``False``.
r Tz No packages to be held providedrO NF�pkg.list_locks�pkg.list_holds��full�^(.+)-(\d+):(.*)\.\*� �0r r% r/ r8 � �pkg.get_selectionsr� �rI �rNo any function to get the list of held packages available.
Check if the package manager supports package locking.r� z;`hold` function is not implemented for the package manager.�= r� z8The following package's hold rule would be updated: {}{}� (version = r z)The following package would be held: {}{}r� r� r- rZ z was updated with hold rulez is now being heldz
was not heldrQ �type�packagez'The following package would be unheld: rR r� �No changes made)r< r� r1 r r� �compile�match�groupr� r: �setr= r� r� rg �lstrip�addr� r+ rc re )rP r8 rk �replacerG �locks�vr_lock�_locks�lock_re�lockrg �epochr� rs Z held_pkgsr �pkg_name�pkg_ver�lock_ver�
unhold_retr� r r r �heldH s� *�
(� ���
����
���� �
��
�rw c K s� t |t�rt|�dkr|s| i ddd�S | r!|du r!| |ig}d}i }d}dtv r1td � }d}nldtv rztd dd �}t�d
�}|D ]5} |�| �}
|
rq|
�d �} | d krXd
} n| � d�} |�|
�d�d| � |
�d�� �ii� qC|�| i i� qCn#dtv r�td dd�}|� dg �D ] } |�| i i� q�n| i ddd�S i } |D ] }
t |
t
�r�t t |
�
� ��\}}| �||i� q�| �|
di� q�| i dd
d�}g }|D ]�}|| � dd�dkr�q�d}|r�d|| v r�|| d }|�d�}|s�|| v �rQ|r�|| | k�rQtd �r|�d�|| � |��sd
nd|� d ��� q�td | |gd �}|� |i �� d d��s2d|d < |�rJ|� |i �� d ��rJ|�|� |�� d �� |d! �|� q�d"�|�|d < |d! �sg|d �sgd#|d < |S )$a�
.. versionadded:: 3005
Unset package from 'hold' state, to allow operations with the package.
:param str name:
The name of the package to be unheld. This parameter is ignored
if ``pkgs`` is used.
:param str version:
Unhold a specific version of a package.
Full description of this parameter is in `installed` function.
.. note::
This parameter make sense for Zypper-based systems.
Ignored for YUM/DNF and APT
:param list pkgs:
A list of packages to be unheld. All packages listed under ``pkgs``
will be unheld.
.. code-block:: yaml
mypkgs:
pkg.unheld:
- pkgs:
- foo
- bar: 1.2.3-4
- baz
.. note::
For Zypper-based systems the package could be held for
the version specified. YUM/DNF and APT ingore it.
For ``unheld`` there is no need to specify the exact version
to be unheld.
:param bool all:
Force removing of all existings locks.
By default, this parameter is set to ``False``.
r Tz!No packages to be unheld providedrO NFrV rW rX rZ r[ r\ r r% r/ r8 r] r^ r� r_ r` rc rd ra r� z+The following package would be unheld: {}{}rb r r� r� r- rR rQ r� re )r< r� r1 r r� rf rg rh r� r: r= r� r� rg rj r� r+ rc re )rP r8 rk r� rG rm rn ro rp rq rg rr Zdpkgsr rs rt r� rs ru rv r r r �unheld� s� ,�
(� ��
���rx rU )NF)NNNTFN)NN)NNNTN)
NNNNFFTNFF)F)
NNNFFNNFFTNFF)NNNN)NNFNT)r" NNNTN)NNTN)FN)NNF)H�__doc__r> �loggingr| r� Zsalt.utils.argsr Zsalt.utils.pkgZsalt.utils.platformZsalt.utils.versionsZsalt.exceptionsr r r Zsalt.modules.pkg_resourcer Z salt.outputr Zsalt.utils.functoolsr Zsalt.utils.odictr r� �globalsr r; r� Zsalt.modules.win_pkgr r
r r r
r r r r � getLogger�__name__r� r r" r( r. r7 r2 rJ rx r{ r� r� r� r� rd r� r� r� r r r r� r- r$ r2 r9 rE rH rM rP rU rw rx r r r r �<module> s� F , �
�
3
�
%
�R
�
~/
�
�
,
`)
� $
�
\
Z
j E A
1 0