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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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, эта файловая система будет использована; иначе модуль не предпримет никаких действий и вернёт ошибку.

Примеры

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

Авторы

Gregory Furlong (@gnfzdz)

Ссылки на сборку

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