Модуль community.general.proxmox_storage_contents_info – Вывод содержимого хранилища Proxmox VE

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.proxmox_storage_contents_info.

Новое в community.general 8.2.0

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

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

Извлекает информацию о хранящихся объектах в определенном хранилище, подключенном к узлу.

Требования

Указанные ниже требования необходимы на хосте, который выполняет этот модуль.

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Вы можете использовать переменную среды `PROXMOX_PASSWORD`.
api_port целое число добавлено в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Использует переменную среды `PROXMOX_PORT`, если не указано.
api_token_id строка добавлено в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секретный ключ токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
content строка	Фильтр по определенному типу контента. Варианты: `"all"` ← (по умолчанию) `"backup"` `"rootdir"` `"images"` `"iso"`
node строка / обязательно	Узел Proxmox, к которому подключено хранилище.
storage псевдонимы: name строка / обязательно	Возвращать только содержимое, хранящееся в этом конкретном хранилище.
validate_certs логическое	Если `false`, SSL-сертификаты не будут проверяться. Это следует использовать только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` ← (по умолчанию) `true`
vmid целое число	Фильтр по определенному VMID.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox добавлено в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в `check_mode` и возвращать прогноз измененного состояния без изменения цели.
diff_mode	Поддержка: N/A Это действие не изменяет состояние.	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в `check_mode`), в режиме diff.

Примеры

- name: List existing storages
  community.general.proxmox_storage_contents_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    storage: lvm2
    content: backup
    vmid: 130

Значения возврата

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

Ключ	Описание
proxmox_storage_content список / элементы=словарь	Содержание хранилища, подключенного к узлу. Возвращено: успех
content строка	Содержание Proxmox перечисленных объектов в этом хранилище. Возвращено: успех
ctime строка	Время создания перечисленных объектов. Возвращено: успех
format строка	Формат перечисленных объектов (может быть `raw`, `pbs-vm`, `iso`,…). Возвращено: успех
size целое число	Размер перечисленных объектов. Возвращено: успех
subtype строка	Подтип перечисленных объектов (может быть `qemu` или `lxc`). Возвращено: При хранилище, предназначенном для резервного копирования, обычно на хранилище PBS.
verification словарь	Статус проверки резервного копирования перечисленных объектов. Возвращено: При хранилище, предназначенном для резервного копирования, обычно на хранилище PBS. Пример: `{"state": "ok", "upid": "UPID:backup-srv:00130F49:1A12D8375:00001CD7:657A2258:verificationjob:daily:v-d0cc18c5-8707:root@pam:"}`
volid строка	Идентификатор тома перечисленных объектов. Возвращено: успех

Авторы

Julian Vanden Broeck (@l00ptr)

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

© 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/proxmox_storage_contents_info_module.html