File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/disk.cpython-310.pyc
o
;j,~ � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Zddl Zddl m
Z
mZ ddiZe�e�Zdd� Zdd � Zd
d � Zd=d d
�Zd=dd�Zd=dd�Zejjj� d�d>dd��Z dd� Z dd� Z d=dd�Z dd� Z!ejjj� d �ejjj� d � d?d d���Z"ejjj�#d!d"g�d#d$� �Z$ejjj� d%�d@d'd(��Z%ejjj� d%�d=d)d*��Z&ejjj� d%�d=d+d,��Z'd>d-d.�Z(ejjj� d/�dAd2d/��Z)d3d4� Z*d5d6� Z+d7d8� Z,d9d:� Z-d;d<� Z.dS )Bz,
Module for managing disks and blockdevices
� N)�CommandExecutionError�SaltInvocationError�format_�formatc C s t jj�� rdS dS )z)
Only work on POSIX-like systems
)Fz$This module doesn't work on Windows.T)�salt�utils�platformZ
is_windows� r r �E/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/disk.py� __virtual__ s r c C s� | � � r t�| �S z.ddddddddd �}| d
|v r2t�| d d
� �}|t�|| d
� }|W S t�| �W S tyB | Y S w ) z�
Convert a string to a number, allowing for a K|M|G|T postfix, 32.8K.
Returns a decimal number if the string is a real number,
or the string unchanged otherwise.
Z10E3Z10E6Z10E9Z10E12Z10E15Z10E18Z10E21Z10E24)�K�M�G�T�P�E�Z�Y���N)�isdigit�decimal�Decimal�
ValueError)�textZ postPrefixes�vr r r
�_parse_numbers s(
�
�r c C s@ d}| du r|S d}| D ]}||v r||7 }q t d|� ���|S )z'
Sanitize flags passed into df
� N) �a�B�h�H�i�k�lr �tr �xr zInvalid flag passed to )r )�argsZcaller�flags�allowed�flagr r r
� _clean_flags> s
r* c
C s
t | d�}tj�d�s$td dkr$t�d� t�d�dkr"t�d� i S td dkr-d }ntd d
ks9td d kr<d }n td d
krEd}nd}|rP|d|� �7 }i }td |dd�� � }d}|D ]�}|seq`|�
d�rkq`|rs|d | }|� � }t |�dkr�|}q`d}t |�dkr�|d �
� s�|d � d|d � �|d< |�d� t |�dkr�|d �
� r�t |�dk r�q`z>td dkr�|d |d |d |d |d |d |d |d d �||d! < n|d |d |d |d |d d"�||d < W q` t�y t�d#� i }Y q`w |S )$z�
Return usage information for volumes mounted on this minion
.. versionchanged:: 2019.2.0
Default for SunOS changed to 1 kilobyte blocks
CLI Example:
.. code-block:: bash
salt '*' disk.usage
z
disk.usagez /etc/mtab�kernel�Linuxz df cannot run without /etc/mtabZvirtual_subtypeZLXCz�df command failed and LXC detected. If you are running a Docker container, consider linking /proc/mounts to /etc/mtab or consider running Docker with -privileged�df -P�OpenBSD�AIX�df -kP�SunOSzdf -k�df� -�cmd.runF�Z python_shellN�
Filesystem� � � r �Darwin� � � � � )�
filesystemz
512-blocks�used� available�capacityZiusedZifreez%iused� )r@ z 1K-blocksrA rB rC �&Problem parsing disk usage information)r* �os�path�isfile�
__grains__�log�error�get�__salt__�
splitlines�
startswith�split�lenr �pop�
IndexError)r& r' �cmd�ret�outZoldline�line�compsr r r
�usageN sz
�
� � ��
�rY c
C sJ t | d�}td dkrd}nd}|r|d|� �7 }i }td |dd ��� }|D ]{}|�d
�r/q'|�� }|s6q'zZtd d kr\t|d �t|d
� |d |d
|d |d d�||d < n3td dkry|d |d |d |d |d d�||d
< n|d |d |d |d |d d�||d < W q' ttfy� t �
d� i }Y q'w |S )z�
Return inode usage information for volumes mounted on this minion
CLI Example:
.. code-block:: bash
salt '*' disk.inodeusage
zdisk.inodeusager+ r/ zdf -izdf -iPr3 r4 Fr5 r6 r. r= r> r? r )�inodesrA �freeZuser@ rD r< r9 r8 r; z'Problem parsing inode usage information) r* rI rM rN rO rP �intrS r rJ rK )r& r' rT rU rV rW rX r r r
�
inodeusage� sR
� � ��
�r] c C sT t d dkr d}nt d dkst d dkrd}nd}i }td |d d
��� }|D ]i}|s-q(|�d �r3q(|�� }t|�d kra|d
�� sa|d � d|d
� �|d< |�d
� t|�d kra|d
�� rCt|�d k rhq(zt d dkrx|d ||d < n|d ||d < W q( ty� t �
d� i }Y q(w | r�| |vr�t �
d| � i }|S | r�|| S |S )z�
Return partition information for volumes mounted on this minion
CLI Example:
.. code-block:: bash
salt '*' disk.percent /var
r+ r, r- r. r/ r0 r2 r4 Fr5 r6 r9 r8 r r7 r: r< rD r= rE zFProblem parsing disk usage information: Partition '%s' does not exist!) rI rM rN rO rP rQ r rR rS rJ rK )r& rT rU rV rW rX r r r
�percent� sL
� �
� ��r^ �blkidc C s� dg}| r |� | � n |r|�d|g� i }td |dd�}|d dkr&|S |d �� D ]?}|s1q,|�� }|d d d
� } i }t�d |�d �d
�}tt|�gd
� D ]\} }
| � d�� d �} |
� d�|| < qS||| < q,|S )a�
Return block device attributes: UUID, LABEL, etc. This function only works
on systems where blkid is available.
device
Device name from the system
token
Any valid token used for the search
CLI Example:
.. code-block:: bash
salt '*' disk.blkid
salt '*' disk.blkid /dev/sda
salt '*' disk.blkid token='UUID=6a38ee5-7235-44e7-8b22-816a403bad5d'
salt '*' disk.blkid token='TYPE=ext4'
r_ �-t� cmd.run_allFr5 �retcoder �stdoutNr z"*"r7 r9 �=�")
�append�extendrM rN rP �re� partition�zip�iter�strip) �device�tokenrT rU Z blkid_resultrW rX �infoZdevice_attributes�key�valuer r r
r_
s*
c K s< ddddd�}d}g }i }|� � D ]V\}}||vr#|�d�s#|||< q|dv r4|d ks4|d
u s4|||< q||v rg|| }|d krJ|�|�d d
�� n|�d� |dv r\|d|� d�7 }q|d|� d|� d�7 }q|r}d�dd� |� � D ��} td| � ���d|� | � �}
td |
dd�} | d dkr�t| d � ��t| |�S ) a�
Set attributes for the specified device
CLI Example:
.. code-block:: bash
salt '*' disk.tune /dev/sda1 read-ahead=1024 read-write=True
Valid options are: ``read-ahead``, ``filesystem-read-ahead``,
``read-only``, ``read-write``.
For ``read-only`` and ``read-write``, the value must be set to ``True``.
See the ``blockdev(8)`` manpage for a more complete description of these
options.
ZsetraZsetfraZsetroZsetrw)z
read-aheadzfilesystem-read-ahead� read-only�
read-writer �__)rr rs �TrueTrs �setrL Zgetro�--r7 z, c s s" � | ] \}}|� d |� �V qdS )rd Nr )�.0r" r r r r
� <genexpr>r s � ztune.<locals>.<genexpr>zInvalid keyword arguments: z blockdev ra Fr5 rb r �stderr) �itemsrO rf �replace�joinr rM r �dump) rm �kwargsZ kwarg_map�optsr& Zinvalid_kwargsrp rq ZswitchZinvalid_kwargs_strrT Zblockdev_resultr r r
�tune: sB �
�
r� c C s\ d| � �}z
t d |dd�}W n tjy Y dS w |d dkr#dS t�d| |d � dS )
z}
Remove the filesystem information
CLI Example:
.. code-block:: bash
salt '*' disk.wipe /dev/sda1
z
wipefs -a ra Fr5 rb r TzError wiping device %s: %srz )rM �
subprocess�CalledProcessErrorrJ rK �rm rT rV r r r
�wipe s
� r� c C s� d� | �}i }dd� |�� D �}td |dd�}|d dkrMd d� |d
�� D �}d}|D ] }|||| < |d }q-|rKi } |D ]}
||
| |
< q@| S |S dS ) z�
Return all contents of dumpe2fs for a specified device
CLI Example:
.. code-block:: bash
salt '*' disk.dump /dev/sda1
z�blockdev --getro --getsz --getss --getpbsz --getiomin --getioopt --getalignoff --getmaxsect --getsize --getsize64 --getra --getfra {}c S s" g | ]
}|� d �r|dd� �qS )rw r9 N)rO )rx �cr r r
�
<listcomp>� s " zdump.<locals>.<listcomp>ra Fr5 rb r c S s g | ]}|r|�qS r r )rx rW r r r
r� � � rc r8 )r rP rM rN ) rm r& rT rU r� rV �lines�countrW Ztemp_ret�argr r r
r~ � s& �
r~ c C sJ d| � �}z
t d |dd�}W n tjy Y dS w |d dkr#dS dS ) zx
Resizes the filesystem.
CLI Example:
.. code-block:: bash
salt '*' disk.resize2fs /dev/sda1
z
resize2fs ra Fr5 rb r TN)rM r� r� r� r r r
� resize2fs� s
� �r� �sync�mkfs�ext4Fc C s$ ddt |�g}|dur+|dd� dkr |�dt |�g� n|dkr+|�dd|� �g� |durA|dd� dkrA|�d d
|� �g� |durX|d v rX|d d� d
krX|�d|g� |rq|dd� dkrh|�d� n |dkrq|�d� |�t | �� td |dd�dk}td ddd�dk}t||g�S )a�
Format a filesystem onto a device
.. versionadded:: 2016.11.0
device
The device in which to create the new filesystem
fs_type
The type of filesystem to create
inode_size
Size of the inodes
This option is only enabled for ext and xfs filesystems
lazy_itable_init
If enabled and the uninit_bg feature is enabled, the inode table will
not be fully initialized by mke2fs. This speeds up filesystem
initialization noticeably, but it requires the kernel to finish
initializing the filesystem in the background when the filesystem
is first mounted. If the option value is omitted, it defaults to 1 to
enable lazy inode table zeroing.
This option is only enabled for ext filesystems
fat
FAT size option. Can be 12, 16 or 32, and can only be used on
fat or vfat filesystems.
force
Force mke2fs to create a filesystem, even if the specified device is
not a partition on a block special device. This option is only enabled
for ext and xfs filesystems
This option is dangerous, use it with caution.
CLI Example:
.. code-block:: bash
salt '*' disk.format /dev/sdX1
r� r` Nr; �extz-iZxfszsize=z-Ezlazy_itable_init=)� � � ����fatz-Fz-fz cmd.retcodeT)Zignore_retcoder r� )�strrg rf rM �all) rm �fs_typeZ
inode_sizeZlazy_itable_initr� �forcerT Z mkfs_successZ sync_successr r r
r � s* 5
�lsblkr2 c C s� t jj�d�r"td d| � ���� }t|�dkr"|d �� }|r"|S t jj�d�ritd dkrPt j�
d�rPtd d | � ��� � }t|�d
krN|d
}|rN|S d S td d | � ���� }t|�dkri|d }|ri|S d S )
z�
Return the filesystem name of the specified device
.. versionadded:: 2016.11.0
device
The name of the device
CLI Example:
.. code-block:: bash
salt '*' disk.fstype /dev/sdX1
r� r4 zlsblk -o fstype r8 r2 r+ r/ z/usr/sysv/bin/dfz/usr/sysv/bin/df -n r9 zdf -T r ) r r rG �whichrM rN rQ rl rI rF rH rP )rm Z lsblk_outr� Zdf_outr r r
�fstype s( � r� ZhdparmTc C sP d| � �}t d |�}|d dkr$d�||d �}|r t|��t�|� |d S )zT
Execute hdparm
Fail hard when required
return output when possible
zhdparm ra rb r z{}: {}rz rc )rM r r rJ �warning)r& ZfailhardrT �result�msgr r r
�_hdparmC s
r� c
C s
d}|du r |}n t |ttf�rd�|�}t | ttf�s | g} i }| D ]�}|�d�s/d|� �}i }td|� d|� �d��� D ]�}|�� }|rL||d krMq>d |v ra|�d d
�\}}t �
d d|�}nd |v rn|�d d
�\}}nq>|�� � � � dd
�}|�� }g } t �
d|�r�|�d�}| �t|d �� | �|d
�d�� n[i }
t �d|�� �D ]<} | �� } z t| �} | �| � W q� ty� d | v r�| �d d
�\} } | �� } | �� } | r�| |
| < n| r�| �| � Y q�w |
r�| �|
� | s�q>t| �d
kr�| d } | ||< q>|||< q#|S )z�
Retrieve all info's for all disks
parse 'em into a nice dict
(which, considering hdparms output, is quite a hassle)
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' disk.hdparms /dev/sda
ZaAbBcCdgHiJkMmNnQrRuWNr z/dev�/dev/�-r7 F�:r8 z is$rd �_z
[0-9]+ \(.*\)r z()z[/,])�
isinstance�list�tupler} rO r� rN rl rP rh �sub�lowerr| �matchrf r\ � ExceptionrQ )
�disksr& Z all_parmsrV �diskZ disk_datarW rp �valsZrvalsZvaldict�valZdeep_keyr r r
�hdparmsV sp
�
��
r� c C s i }t | d��� D ](\}}tt|�� ��\}}}||ks d|v r'd|i||< q |||| d�||< q |du r8|S |�� D ]A\}}z
|d t|� }W n tyj d|v rht|�d��}d| |d }|d }Y nw |dkrs|d }td |� d
|� �� q<dS ) a�
Get/set Host Protected Area settings
T13 INCITS 346-2001 (1367D) defines the BEER (Boot Engineering Extension Record)
and PARTIES (Protected Area Run Time Interface Extension Services), allowing
for a Host Protected Area on a disk.
It's often used by OEMS to hide parts of a disk, and for overprovisioning SSD's
.. warning::
Setting the HPA might clobber your data, be very careful with this on active disks!
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' disk.hpa /dev/sda
salt '*' disk.hpa /dev/sda 5%
salt '*' disk.hpa /dev/sda 10543256
�N�disabled�total)r� �visibleZhiddenN�%�d r z --yes-i-know-what-i-am-doing -Npr7 ) r� r{ �nextrk �valuesr\ r� rl r� )r� �sizeZhpa_datar� �datar� r� �statusr r r
�hpa� s2 � ���r� c
s� | � d�s d| } d| � �}td |dd�}|d dkr"t|d ��t|d �� �}g }|D ] }|� d
�rJt�d |�� �}d d
� |dd� D �} nq.� durX� fdd
�|D �}i }|D ]w}t�d|�sg |S tjd |�� t |�d�}t
|d �}|dur�||vr�q\t t ||dd� ��} z| d= W n t
y� Y nw | D ]0}
| |
} zt
| �} W n t
y� z dd
� | �d�D �} W n t
y� Y nw Y nw | | |
< q�| ||< q\|S )a�
Fetch SMART attributes
Providing attributes will deliver only requested attributes
Providing values will deliver only requested values for attributes
Default is the Backblaze recommended
set (https://www.backblaze.com/blog/hard-drive-smart-stats/):
(5,187,188,197,198)
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' disk.smart_attributes /dev/sda
salt '*' disk.smart_attributes /dev/sda attributes=(5,187,188,197,198)
r� zsmartctl --attributes ra �quiet�Zoutput_loglevelrb r rz rc zID#z\s+c S s g | ]}|� � �qS r )r� )rx rp r r r
r� � r� z$smart_attributes.<locals>.<listcomp>r8 Nc s g | ]
}|� v r
|nd �qS )r� r )rx �field�r� r r
r� s z[\s]*\d)�maxsplitr� c S � g | ]}t |��qS r )r\ )rx rq r r r
r� r� r7 )rO rM r rk rN rh rP rl r� rQ r\ �dictrj r� ) �devZ
attributesr� rT Z smart_result�fieldsrW Z
smart_attr�attrr� r� r� r r� r
�smart_attributes� s\
� �
� ���
r� �iostatr8 r= c C sL t jj�� r t| ||�S t jj�� rt| ||�S t jj�� r$t| ||�S dS )z�
Gather and return (averaged) IO stats.
.. versionadded:: 2016.3.0
.. versionchanged:: 2016.11.4
Added support for AIX
CLI Example:
.. code-block:: bash
salt '*' disk.iostat 1 5 disks=sda
N) r r r Zis_linux�
_iostat_linuxZ
is_freebsd� _iostat_fbsdZis_aix� _iostat_aix)�intervalr� r� r r r
r� # s �c C s$ dd� t |� D �}tt | |��}|S )z�
Transpose collected data, average it, stomp it in dict using header
Use Decimals so we can properly calc & round, convert to float 'caus' we can't transmit Decimals over 0mq
c S s, g | ]}t t|�t|� �t�d ����qS )z.01)�float�sumrQ Zquantizer r �rx �statr r r
r� A s ��z!_iostats_dict.<locals>.<listcomp>)rj r� )�header�statsr r r
�
_iostats_dict; s
�r� c
s� |du rd| � d|� d�}nt |t�r d| � d|� d|� �}n
d�| |d�|��}g }t�t�}g }g }d� ttd |d d
�� � �}|D ]L} | �
d �sLqD|sV| � � d d� }| d
ur�t |d
�} | rg| d �
� shn(| � � } | d }
dd� | d d� D �} t| �� k r�t| �� ||
�| � | d
usZqDi } � t|�k r�|� d� }|d� � }|�� D ] \}
} t| d �� krɇ fdd�| D �}� fdd�| D �||
< q�t||�| d< |�� D ] \}
} t|| �| |
< q�| S )z[
Tested on FreeBSD, quite likely other BSD's only need small changes in cmd syntax
Nziostat -xC -w z -c r7 z
iostat -x -w ziostat -x -w {} -c {} {}i� �cmd.run_stdoutr� r� rm r8 Fr c S � g | ]}t �|��qS r �r r �rx r% r r r
r� h � z _iostat_fbsd.<locals>.<listcomp>c s g | ]}|� d � �qS �Nr r� �Zh_lenr r
r� x � c s g | ]}|d � � �qS )r r r� r� r r
r� y r� �sys)r� r� r r} � collections� defaultdictr� rk rM rN rO rP r� �isalnumrQ rf r{ r� �
r� r� r� �
iostat_cmdZ sys_stats� dev_statsZ
sys_headerZ
dev_headerrU rW r� r� �iostatsr r� r
r� I sV
�
�� �r� c
C s� |d u rd| � d|� d�}nt |t�r d| � d|� d|� �}n
d�| |d�|��}g }t�t�}g }g }ttd |dd�� � �}|D ]e} | �
d�rf|sUt | � � d d � �}d
d � t
|�� � D �} |�| � qB| �
d �r�|swt | � � d d � �}| d
ur�t
|d
�} | r�| d �� s�n | � � } | d }
dd � | d d � D �} ||
�| � | d
us{qBi } |r�t||�| d< |�� D ] \}
} t|| �| |
< q�| S )Nz
iostat -x r7 z iostat -xd ziostat -xd {} {} {}r� r� r� zavg-cpu:r8 c S r� r r� r� r r r
r� � r� z!_iostat_linux.<locals>.<listcomp>zDevice:Fr c S r� r r� r� r r r
r� � r� r� )r� r� r r} r� r� r� rk rM rN rO r� rP r� rf r� r� r{ r� r r r
r� � sJ
�
�� r� c C sj t �d� |du rd| � d|� d�}nt|t�r$d|� d| � d|� �}n
d�d�|�| |�}i }d}g }d}d}t�t�} t d |��
� D ]�}
|
rS|
� d�sS|
� d �rTqEt �
d
|
�s�|
�d �} | d �� } | d }| d
}| d
�� }|| �� vr�g | |< t| | �}| | �i � i | | | |< || | | | d< g | | | | d< qEd |
v r�|
�d �}
|
d
�� }|
d �� }|| | d �� vr�i | | d |< || | d | d< g | | d | d< qE|
�� }
dd� |
dd� D �}| | d | d �|� qEi }| �� D ],\}}i ||< |D ] }|�� D ]}|| d }|| d }t||�|| |< �q�q�q|S )z?
AIX support to gather and return (averaged) IO stats.
zAIX disk iostat entryNz iostat -dD r7 ziostat -dD {} {} {}r r4 �Systemz -----------z\sr� r r8 r� r� c S r� r )r r� r r r
r� r� z _iostat_aix.<locals>.<listcomp>)rJ �debugr� r� r r} r� r� r� rM rN rO rh r� rP �keysrQ rf �lstripr{ r� )r� r� r� r� rU Zprocnr� Z disk_nameZ disk_moder� rW Z dsk_compsZ
dsk_firstsrX r� r� r� Z
list_modes�modesr r r
r� � sh
$
� ��r� c C s t d | �}t|�S )a
Return the filesystem type of the underlying device for a specified path.
.. versionadded:: 3006.0
path
The path for the function to evaluate.
CLI Example:
.. code-block:: bash
salt '*' disk.get_fstype_from_path /root
zmount.get_device_from_path)rM r� )rG r� r r r
�get_fstype_from_path s r� r� )NN)r� NNNF)T)r8 r= N)/�__doc__r� r �loggingrF rh r� Zsalt.utils.decoratorsr Zsalt.utils.decorators.pathZsalt.utils.pathZsalt.utils.platformZsalt.exceptionsr r Z__func_alias__� getLogger�__name__rJ r r r* rY r] r^ r Z
decoratorsrG r� r_ r� r� r~ r� r Z which_binr� r� r� r� r� r� r� r� r� r� r� r r r r
�<module> sd
Q
:1 /E
"�L
) M
5I :- d