From 3b97fad577cd3aede773b6c7032e32ea5ea2ca69 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 24 Feb 2023 09:25:15 +0100 Subject: [PATCH] Add attributes to some filesystem modules (#5960) Add attributes to some filesystem modules. --- plugins/modules/beadm.py | 7 +++++++ plugins/modules/filesize.py | 10 +++++++--- plugins/modules/filesystem.py | 8 +++++++- plugins/modules/lvg.py | 7 +++++++ plugins/modules/lvol.py | 7 +++++++ plugins/modules/parted.py | 7 +++++++ plugins/modules/xfs_quota.py | 9 ++++++++- plugins/modules/zfs.py | 19 +++++++++++++------ plugins/modules/zfs_delegate_admin.py | 7 +++++++ 9 files changed, 70 insertions(+), 11 deletions(-) diff --git a/plugins/modules/beadm.py b/plugins/modules/beadm.py index 7a84997089..8857fd8464 100644 --- a/plugins/modules/beadm.py +++ b/plugins/modules/beadm.py @@ -17,6 +17,13 @@ description: - Create, delete or activate ZFS boot environments. - Mount and unmount ZFS boot environments. author: Adam Števko (@xen0l) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/filesize.py b/plugins/modules/filesize.py index a8c47d70fd..b3eb90d611 100644 --- a/plugins/modules/filesize.py +++ b/plugins/modules/filesize.py @@ -25,6 +25,12 @@ author: version_added: "3.0.0" +attributes: + check_mode: + support: full + diff_mode: + support: full + options: path: description: @@ -93,14 +99,12 @@ options: - This option is silently ignored. This module always modifies file size in-place. -notes: - - This module supports C(check_mode) and C(diff). - requirements: - dd (Data Duplicator) in PATH extends_documentation_fragment: - ansible.builtin.files + - community.general.attributes seealso: - name: dd(1) manpage for Linux diff --git a/plugins/modules/filesystem.py b/plugins/modules/filesystem.py index 4dcfddee23..0e6b815b4e 100644 --- a/plugins/modules/filesystem.py +++ b/plugins/modules/filesystem.py @@ -19,6 +19,13 @@ 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: @@ -87,7 +94,6 @@ notes: 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 I(state=absent). - - This module supports I(check_mode). seealso: - module: community.general.filesize - module: ansible.posix.mount diff --git a/plugins/modules/lvg.py b/plugins/modules/lvg.py index ca38565f4a..60eaaa42b2 100644 --- a/plugins/modules/lvg.py +++ b/plugins/modules/lvg.py @@ -17,6 +17,13 @@ module: lvg short_description: Configure LVM volume groups description: - This module creates, removes or resizes volume groups. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: vg: description: diff --git a/plugins/modules/lvol.py b/plugins/modules/lvol.py index 4489258da5..d193a4e837 100644 --- a/plugins/modules/lvol.py +++ b/plugins/modules/lvol.py @@ -19,6 +19,13 @@ module: lvol short_description: Configure LVM logical volumes description: - This module creates, removes or resizes logical volumes. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: vg: type: str diff --git a/plugins/modules/parted.py b/plugins/modules/parted.py index ae5e7584d1..ec72bd6f00 100644 --- a/plugins/modules/parted.py +++ b/plugins/modules/parted.py @@ -24,6 +24,13 @@ requirements: - align option (except 'undefined') requires parted 2.1 and above - If the version of parted is below 3.1, it requires a Linux version running the sysfs file system C(/sys/). +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: device: description: The block device (disk) where to operate. diff --git a/plugins/modules/xfs_quota.py b/plugins/modules/xfs_quota.py index 5f71334c01..d01f3dc0e6 100644 --- a/plugins/modules/xfs_quota.py +++ b/plugins/modules/xfs_quota.py @@ -19,7 +19,14 @@ description: - Configure quotas on XFS filesystems. - Before using this module /etc/projects and /etc/projid need to be configured. author: -- William Leemans (@bushvin) + - William Leemans (@bushvin) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: type: description: diff --git a/plugins/modules/zfs.py b/plugins/modules/zfs.py index 84e5c05b1f..83b2a6edf8 100644 --- a/plugins/modules/zfs.py +++ b/plugins/modules/zfs.py @@ -15,6 +15,19 @@ module: zfs short_description: Manage zfs description: - Manages ZFS file systems, volumes, clones and snapshots +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: partial + details: + - In certain situations it may report a task as changed that will not be reported + as changed when C(check_mode) is disabled. + - For example, this might occur when the zpool C(altroot) option is set or when + a size is written using human-readable notation, such as C(1M) or C(1024K), + instead of as an unqualified byte count, such as C(1048576). + diff_mode: + support: full options: name: description: @@ -39,12 +52,6 @@ options: - See the zfs(8) man page for more information. type: dict default: {} -notes: - - C(check_mode) is supported, but in certain situations it may report a task - as changed that will not be reported as changed when C(check_mode) is disabled. - For example, this might occur when the zpool C(altroot) option is set or when - a size is written using human-readable notation, such as C(1M) or C(1024K), - instead of as an unqualified byte count, such as C(1048576). author: - Johan Wiren (@johanwiren) ''' diff --git a/plugins/modules/zfs_delegate_admin.py b/plugins/modules/zfs_delegate_admin.py index 36a213a0fe..7891c32672 100644 --- a/plugins/modules/zfs_delegate_admin.py +++ b/plugins/modules/zfs_delegate_admin.py @@ -20,6 +20,13 @@ description: requirements: - "A ZFS/OpenZFS implementation that supports delegation with C(zfs allow), including: Solaris >= 10, illumos (all versions), FreeBSD >= 8.0R, ZFS on Linux >= 0.7.0." +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: