Vh2h ddlmZmZmZeZdZdZddlZddl Z ddl Z ddl Z ddl m Z ddlmZddlmZGdd eZGd d eZGd d eZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGd d!eZGd"d#eZ Gd$d%eZ!Gd&d'eZ"eeeeeeeeeeee e!e"d(Z#d)Z$e%d*k(re$yy)+)absolute_importdivisionprint_functionaN author: - Alexander Bulimov (@abulimov) - quidame (@quidame) module: filesystem short_description: Makes a filesystem description: - This module creates a filesystem. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - If O(state=present), the filesystem is created if it does not already exist, that is the default behaviour if O(state) is omitted. - If O(state=absent), filesystem signatures on O(dev) are wiped if it contains a filesystem (as known by C(blkid)). - When O(state=absent), all other options but O(dev) are ignored, and the module does not fail if the device O(dev) does not actually exist. type: str choices: [present, absent] default: present version_added: 1.3.0 fstype: choices: [bcachefs, btrfs, ext2, ext3, ext4, ext4dev, f2fs, lvm, ocfs2, reiserfs, xfs, vfat, swap, ufs] description: - Filesystem type to be created. This option is required with O(state=present) (or if O(state) is omitted). - Ufs support has been added in community.general 3.4.0. - Bcachefs support has been added in community.general 8.6.0. type: str aliases: [type] dev: description: - Target path to block device (Linux) or character device (FreeBSD) or regular file (both). - When setting Linux-specific filesystem types on FreeBSD, this module only works when applying to regular files, aka disk images. - Currently V(lvm) (Linux-only) and V(ufs) (FreeBSD-only) do not support a regular file as their target O(dev). - Support for character devices on FreeBSD has been added in community.general 3.4.0. type: path required: true aliases: [device] force: description: - If V(true), allows to create new filesystem on devices that already has filesystem. type: bool default: false resizefs: description: - If V(true), if the block device and filesystem size differ, grow the filesystem into the space. - Supported for C(bcachefs), C(btrfs), C(ext2), C(ext3), C(ext4), C(ext4dev), C(f2fs), C(lvm), C(xfs), C(ufs) and C(vfat) filesystems. Attempts to resize other filesystem types will fail. - XFS Will only grow if mounted. Currently, the module is based on commands from C(util-linux) package to perform operations, so resizing of XFS is not supported on FreeBSD systems. - VFAT will likely fail if C(fatresize < 1.04). - Mutually exclusive with O(uuid). type: bool default: false opts: description: - List of options to be passed to C(mkfs) command. type: str uuid: description: - Set filesystem's UUID to the given value. - The UUID options specified in O(opts) take precedence over this value. - See xfs_admin(8) (C(xfs)), tune2fs(8) (C(ext2), C(ext3), C(ext4), C(ext4dev)) for possible values. - For O(fstype=lvm) the value is ignored, it resets the PV UUID if set. - Supported for O(fstype) being one of C(bcachefs), C(ext2), C(ext3), C(ext4), C(ext4dev), C(lvm), or C(xfs). - This is B(not idempotent). Specifying this option will always result in a change. - Mutually exclusive with O(resizefs). type: str version_added: 7.1.0 requirements: - Uses specific tools related to the O(fstype) for creating or resizing a filesystem (from packages e2fsprogs, xfsprogs, dosfstools, and so on). - Uses generic tools mostly related to the Operating System (Linux or FreeBSD) or available on both, as C(blkid). - On FreeBSD, either C(util-linux) or C(e2fsprogs) package is required. notes: - Potential filesystems on O(dev) are checked using C(blkid). In case C(blkid) is unable to detect a filesystem (and in case C(fstyp) on FreeBSD is also unable to detect a filesystem), this filesystem is overwritten even if O(force) is V(false). - On FreeBSD systems, both C(e2fsprogs) and C(util-linux) packages provide a C(blkid) command that is compatible with this module. However, these packages conflict with each other, and only the C(util-linux) package provides the command required to not fail when O(state=absent). seealso: - module: community.general.filesize - module: ansible.posix.mount - name: xfs_admin(8) manpage for Linux description: Manual page of the GNU/Linux's xfs_admin implementation. link: https://man7.org/linux/man-pages/man8/xfs_admin.8.html - name: tune2fs(8) manpage for Linux description: Manual page of the GNU/Linux's tune2fs implementation. link: https://man7.org/linux/man-pages/man8/tune2fs.8.html a - name: Create a ext2 filesystem on /dev/sdb1 community.general.filesystem: fstype: ext2 dev: /dev/sdb1 - name: Create a ext4 filesystem on /dev/sdb1 and check disk blocks community.general.filesystem: fstype: ext4 dev: /dev/sdb1 opts: -cc - name: Blank filesystem signature on /dev/sdb1 community.general.filesystem: dev: /dev/sdb1 state: absent - name: Create a filesystem on top of a regular file community.general.filesystem: dev: /path/to/disk.img fstype: vfat - name: Reset an xfs filesystem UUID on /dev/sdb1 community.general.filesystem: fstype: xfs dev: /dev/sdb1 uuid: generate - name: Reset an ext4 filesystem UUID on /dev/sdb1 community.general.filesystem: fstype: ext4 dev: /dev/sdb1 uuid: random - name: Reset an LVM filesystem (PV) UUID on /dev/sdc community.general.filesystem: fstype: lvm dev: /dev/sdc uuid: random N) AnsibleModule) to_native) LooseVersionc$eZdZdZdZdZdZy)Devicec ||_||_yN)modulepath)selfr rs p/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/filesystem.py__init__zDevice.__init__s  cVtj|j}tj|jrX|j j dd}|j j|d|jgd\}}}t|}|Stj|jrtjdk(rh|j j dd}|j j||jgd\}}}t|jd}|Stjj|jr+tjj|j}|S|j jd d |z S) z- Return size in bytes of device. Returns int blockdevTrequiredz --getsize64check_rcFreeBSDdiskinfoFzTarget device not supported: %schangedmsg)osstatrS_ISBLKst_moder get_bin_path run_commandintS_ISCHRplatformsystemsplitisfilegetsize fail_json)rstatinfo blockdev_cmddummyoutdevsize_in_bytes diskinfo_cmds rsizez Device.sizes]77499% <<(( );;33J3NL $ 7 7}VZV_V_8`ko 7 p E3"3x  \\(** +0AY0N;;33J3NL $ 7 7tyy8Q\` 7 a E3"399;q>2    WW^^DII &!wwtyy9   KK ! !%5VY]5] ! ^rc |jjdd}|jj|ddddd|jgd \}}}|d k7rd }|S|j d d }|S)zCReturn (first) mountpoint of device. Returns None when not mounted.findmntTrz--mtab --noheadingsz--outputTARGETz--sourceFrrN )r r#r$rr))r cmd_findmntrc mountpointr/s rget_mountpointzDevice.get_mountpointskk..y4.H !% 7 7hP^`j8@*dii9Ych!8!jJ 7J$))$/2Jrc|jSr )rrs r__str__zDevice.__str__s yyrN)__name__ __module__ __qualname__rr3r<r?rrr r s $ rr ceZdZdZgZdZgZdZdZgZ dZ dZ dZ dZ ddddZdZedZdZdd Zd Zd Zd Zd ZdZy) FilesystemNFTC)LANGLC_ALL LC_MESSAGESc||_yr )r )rr s rrzFilesystem.__init__s  rc,t|jSr )typer@r>s rfstypezFilesystem.fstypesDz"""rct)a)Return size in bytes of filesystem on device (integer). Should query the info with a per-fstype command that can access the device whenever it is mounted or not, and parse the command output. Parser must ensure to return an integer, or raise a ValueError. )NotImplementedError)rdevs r get_fs_sizezFilesystem.get_fs_sizes "##rc|jjry|rN|jrBt|jt|zs!||jd|g|jzz }|jj |j d}|g|jz|zt|gz}|jj|d|r.|jr!|j|j||yyyy)NrTrrnew_uuidrP) r check_modeMKFS_SET_UUID_OPTIONSsetMKFS_SET_UUID_EXTRA_OPTIONSr#MKFSMKFS_FORCE_FLAGSstrr$ CHANGE_UUID change_uuid)roptsrPuuidmkfscmds rcreatezFilesystem.creates ;; ! !  D..223c$i?33A6=@`@```{{'' D'Aft,,,t3s3xj@ d3 D$$)C)C)K   d  4*L$4rc|jjry|jjdd}|dt|g}|jj |dy)NwipefsTrz--allr)r rUr#r[r$)rrPrdras rrdzFilesystem.wipefssT ;; ! ! ))(T)BwC) d3rc||jj|jdg}||j|gzz }|S)z2Build and return the resizefs commandline as list.Tr)r r#GROWGROW_MAX_SPACE_FLAGS)rtargetcmdlines rgrow_cmdzFilesystem.grow_cmds>;;++DII+EF4,,x77rc |j} |j|}|ks-|jjd|j d | nC|jjr-|jjd d |j d | |jrA|j}|s,|jj |d|j d|}n t|}|jj|j!|d \}}}|S#t$r-|jj d|j zY4t $rl}|jjd|jdt|d|jj d|jd|Yd}~d}~wwxYw)z@Get dev and fs size and compare. Returns stdout of used command.z2module does not support resizing %s filesystem yetrzunable to process z output ''z output for NFz& filesystem is using the whole device rTzresizing filesystem z on device  needs to be mounted for operationsr)r3rQrOr r,rM ValueErrorwarnINFOr exit_jsonrUGROW_MOUNTPOINT_ONLYr<r[r$rj) rrPr1fssize_in_byteserrr; grow_targetr/r0s rgrowzFilesystem.grow s~88: _"..s3O!11 KK ! !%eiepepru5v ! w [[ # # KK ! !$]a]h]hjm4n ! o  $ $++-J %%X[]a]h]h*i%j$Kc(K KK33DMM+4NY]3^sE )# j KK ! !&Z]a]h]h&h ! i _ KK  499iX[n] ^ KK ! !diiY\&] ! ^ ^ _sD""2G G A!GG c|jj|jdg}|jr||j||gz }|S||j|gz }|S)z6Build and return the UUID change command line as list.Tr)r r#r\CHANGE_UUID_OPTION_HAS_ARGCHANGE_UUID_OPTION)rrTrhris rchange_uuid_cmdzFilesystem.change_uuid_cmd(sg;;++D,<,W,!$SV\\^A%6!7Jq6<<>!$0"%c!fll3&7&:";KJ 44K'' (T#Y' 'rN) r@rArBrYrZrrrfrtr\r{rQrCrrrras/ Dv D DK(rrceZdZdZdgZy)Reiserfsz mkfs.reiserfsz-qNr@rArBrYrZrCrrrrs Dvrrc4eZdZdZdgZddgZdZdZddgZdZ y ) Bcachefsz mkfs.bcachefsz--forcer--uuidbcachefsdeviceresizec.|jj|jj|jdt |gd\}}}|j D]}}d|vs|j }|d}d}d}gd} gd} | j|}d }|d k(rt|d } nt|d } |b|et| t||zcStt|#t$r| j|}d }YuwxYw) 7Return size in bytes of filesystem on device (integer).z show-superTrzSize: rN) BKiBMiBGiBTiBPiBEiBZiBYiB) rkBMBGBTBPBEBZBYBiirr) r r$r#rrr[rr)indexrpr%floatpowr) rrPr/stdoutrpartsunitbaseexpunits_2units_10values rrQzBcachefs.get_fs_sizes'#{{66 8P8PQUQZQZ8[8Dc#h8PZ^ 7 `vu%%' 7D4 QxWP !---CD !8aME!%(OE#us4~5661 74f&&" "...CD s C55DDN) r@rArBrYrZrVrrrfrgrQrCrrrrs4 D!{!8, D D$h/'rrc<eZdZdZdZdZgdZdZfdZdZ xZ S)Btrfsz mkfs.btrfsbtrfs) filesystemrmaxTctt| ||jj |j d}|jj |dgd\}}}tjd|}|stjd|}|r0t|jdtdk\r dg|_ yydg|_ |jjd |d |d y) NTrz --versionrz v([0-9.]+)rz3.12rz'Unable to identify mkfs.btrfs version (z, )) superrrr r#rYr$researchrgrouprZrq)rr r`r/rstderrmatch __class__s rrzBtrfs.__init__s eT#F+{{'' D'A $ 7 7{8KVZ 7 [vv .&1IInf5E EKKN+|F/CC)-%D&*FD ! KK  QWY_` arc|j}|s,|jj|d|jd|jj |jj |j ddd|gd\}}}|jD]$}d |vst|jd cStt|) rrnrorlrusagez-bTrz Device size) r<r r,rMr$r#rrrr%r)rpr)rrPr;r/rrs rrQzBtrfs.get_fs_sizes'')  KK ! !TWY]YdYd&e ! f#{{66 8P8PQUQZQZ8[8DgtU_8ako 7 qvu%%' -D$4::<+,, -f&&r) r@rArBrYrrrfrgrtrrQ __classcell__rs@rrrs) D D D:b" 'rrceZdZdZdgZy)Ocfs2z mkfs.ocfs2z-FxNrrCrrrrs Dwrrc0eZdZdZdZdZfdZdZxZS)F2fsz mkfs.f2fsz dump.f2fsz resize.f2fsctt| ||jj |j d}|jj |tjgd|j\}}}tjd|}|0t|jdtdk\r dg|_yyy) NTrFrz'F2FS-tools: mkfs.f2fs Ver: ([0-9.]+) \(rz1.9.0r)rrrr r#rYr$rdevnullrrrrrrZ)rr r`r/r0rrs rrz F2fs.__init__s dD"6*{{'' D'A KK33T2::4FQVgkgtgt3usE DcJ  EKKN+|G/DD)-%E rc|jj|jd}|jj|t |gd|j \}}}dx}}|j D]O}d|vrt|jd}n d|vrt|jd}d||fvsK||zStt|) z>Get sector size and total FS sectors and return their product.TrrNzInfo: sector size = zInfo: total FS sectors = ) r r#rrr$r[rrr%r)rpr)rrPrar/r0 sector_size sector_countrs rrQzF2fs.get_fs_sizeskk&&tyy4&@ KK33S#c(Odcgcpcp3qsE%)) lNN$ (D%-!$**,q/2 ,4"4::<?3 K66\)) (T#Y' 'r) r@rArBrYrrrfrrQrrs@rrrs D D D /*rrc4eZdZdZdZddgZfdZdZxZS)VFAT fatresize-srcxtt| |tjdk(rd|_yd|_y)Nr newfs_msdosz mkfs.vfat)rrrr'r(rY)rr rs rrz VFAT.__init__s/ dD"6* ??  )%DI#DIrc|jj|jd}|jj|dt |gd|j \}}}d}|j ddD]V}|jdd}t|dkr$|\}} |jd vseZdZdZdgZddgZdgZdZdZdZ dZ d Z d Z y ) LVMpvcreaterz-urz--norestorefilepvspvresizepvchangeFc |jj|jd}|jj|ddddddt |gd \}}}t |}|S) z!Get and return PV size, in bytes.Trr6-opv_sizez--unitsbz --nosuffixr)r r#rrr$r[r%)rrPrar/r3rs rrQzLVM.get_fs_size4s|kk&&tyy4&@![[44c>4QZ\egjlxz}B{C6DOS4TtUd)rN) r@rArBrYrZrVrXrrrfr\r{rzrQrCrrrr)sC Dv!8,#4"5 D DK!&rrceZdZdZdgZy)SwapmkswaprNrrCrrrr<s Dvrrc$eZdZdZdZdZdgZdZy)UFSnewfsdumpfsgrowfsz-yc|jj|jd}|jj|t |gd|j \}}}dx}}|j D]\}|jdrt|jd}n d|vrt|jd}d||fvsX||zStt|) zK^K^K`GaaGE9y(>STUVHd7mL&4(D5!FE2vu5551 i( ,  ! !!F& MM' "E -- C ]]8 $F == D MM' "E}}Z(H == DI JJL G 77>># $s* I      %     %  C   g  5C((#tRZZwPTV\^abe^f)ghOB B (//#y0!!'D!9 ,,c3s8_=FC \\^  ^ ##F+F n'E6] //:3S3S   U0sv|0|  }C, F0CC 8D   U  + !$$U8mpv8v$w ooc*  3 7 ,,d,D  3 7    ^ace!fkmsv  w yc= ' # W%K n   U0cfl0l  m ns3 OO21O2__main__)& __future__rrrrL __metaclass__ DOCUMENTATIONEXAMPLESrr'rr ansible.module_utils.basicr+ansible.module_utils.common.text.convertersrBansible_collections.community.general.plugins.module_utils.versionrobjectr rErrrrrrrrrrrrrrr,r<r@rCrrrFsQA@ ` D' R  4A[&V&Rkk\(*(6333&(*&(Rz ''z''T#'J#'LJ #*:#*L:>*&: +*+4           $h&V zFr