Модуль community.general.btrfs_subvolume — управление подтомами btrfs

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.btrfs_subvolume.

Добавлено в community.general 6.6.0

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создаёт, обновляет и удаляет подтома и снимки btrfs.

Параметры

Параметр	Комментарии
automount boolean	Разрешить модулю временно подключить целевую файловую систему btrfs для проверки её текущего состояния и внесения необходимых изменений. Варианты: `false` ← (по умолчанию) `true`
default boolean	Сделать подтом, указанный в `name`, подтомом файловой системы по умолчанию. Варианты: `false` ← (по умолчанию) `true`
filesystem_device path	Блочное устройство, входящее в целевую файловую систему btrfs. Полезно для указания целевой файловой системы, если имеется несколько файловых систем btrfs.
filesystem_label string	Описательная метка, присвоенная целевой файловой системе btrfs. Полезно для указания целевой файловой системы, если имеется несколько файловых систем btrfs.
filesystem_uuid string	Уникальный идентификатор, присвоенный целевой файловой системе btrfs. Полезно для указания целевой файловой системы, если имеется несколько файловых систем btrfs.
name string / обязательный	Имя целевого подтома или снимка.
recursive boolean	Если значение равно true, родительские или дочерние подтома создаются или удаляются по мере необходимости для выполнения операции (соответственно для `state=present` и `state=absent`). Варианты: `false` ← (по умолчанию) `true`
snapshot_conflict string	Политика, определяющая поведение в случае, если по пути запрошенного снимка уже существует подтом. `skip` — создавать снимок, только если в целевом расположении ещё нет подтома; в противном случае указывать, что изменения не требуются. Предупреждение: этот параметр пока не проверяет, был ли целевой подтом создан как снимок указанного источника. `clobber` — если в запрошенном расположении уже существует подтом, сначала удалить его. Этот параметр не идемпотентен: при каждом выполнении создаётся новый снимок. `error` — если в запрошенном расположении уже существует подтом, вернуть ошибку. Этот параметр не идемпотентен: при повторном выполнении модуля возникает ошибка. Варианты: `"skip"` ← (по умолчанию) `"clobber"` `"error"`
snapshot_source string	Указывает исходный подтом для создаваемого снимка. Определяет, что создаваемый подтом является снимком.
state string	Указывает текущее состояние целевого подтома. Варианты: `"absent"` `"present"` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная В некоторых сценариях модуль может ошибочно сообщать о создании промежуточных подтомов. После монтирования, если вместо подтома обнаруживается каталогоподобный файл, операция пропускается.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

Если указан один или несколько параметров filesystem_device, filesystem_label или filesystem_uuid, ожидается наличие соответствующей файловой системы btrfs. Если эти параметры не указаны и существует только одна файловая система btrfs либо подключена только одна файловая система btrfs, используется эта файловая система; в противном случае модуль не выполняет никаких действий и возвращает ошибку.

Примеры

- name: Create a @home subvolume under the root subvolume
  community.general.btrfs_subvolume:
    name: /@home
    filesystem_device: /dev/vda2

- name: Remove the @home subvolume if it exists
  community.general.btrfs_subvolume:
    name: /@home
    state: absent
    filesystem_device: /dev/vda2

- name: Create a snapshot of the root subvolume named @
  community.general.btrfs_subvolume:
    name: /@
    snapshot_source: /
    filesystem_device: /dev/vda2

- name: Create a snapshot of the root subvolume and make it the new default subvolume
  community.general.btrfs_subvolume:
    name: /@
    snapshot_source: /
    default: true
    filesystem_device: /dev/vda2

- name: Create a snapshot of the /@ subvolume and recursively creating intermediate subvolumes as required
  community.general.btrfs_subvolume:
    name: /@snapshots/@2022_06_09
    snapshot_source: /@
    recursive: true
    filesystem_device: /dev/vda2

- name: Remove the /@ subvolume and recursively delete child subvolumes as required
  community.general.btrfs_subvolume:
    name: /@snapshots/@2022_06_09
    snapshot_source: /@
    recursive: true
    filesystem_device: /dev/vda2

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
filesystem dictionary	Сводка итогового состояния целевой файловой системы btrfs. Возвращается: при успехе
default_subvolume integer	ID подтома файловой системы по умолчанию. Возвращается: при успехе и если файловая система подключена Пример: `5`
devices list / элементы=string	Список устройств, назначенных файловой системе. Возвращается: при успехе Пример: `["/dev/sda1", "/dev/sdb1"]`
label string	Необязательная метка, назначенная файловой системе. Возвращается: при успехе Пример: `"Tank"`
subvolumes list / элементы=dictionary	Список словарей с метаданными всех подтомов файловой системы. Возвращается: при успехе и если файловая система подключена
id integer	Идентификатор подтома, уникальный в пределах содержащей его файловой системы. Возвращается: при успехе Пример: `256`
mountpoints list / элементы=string	Пути, по которым подтом подключён на целевом узле. Возвращается: при успехе Пример: `["/home"]`
parent integer	Идентификатор родительского подтома. Возвращается: при успехе Пример: `5`
path string	Полный путь к подтомy относительно корня файловой системы btrfs. Возвращается: при успехе Пример: `"/@home"`
uuid string	Уникальный идентификатор, присвоенный файловой системе. Возвращается: при успехе Пример: `"96c9c605-1454-49b8-a63a-15e2584c208e"`
modifications list / элементы=string	Список, каждый элемент которого описывает изменение целевой файловой системы btrfs. Возвращается: при успехе
target_subvolume_id integer	ID подтома, указанного параметром `name`: существовавшего ранее или созданного при выполнении модуля. Возвращается: при успехе и если подтом существует после выполнения модуля Пример: `257`

Авторы

Gregory Furlong (@gnfzdz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/btrfs_subvolume_module.html