Модуль community.proxmox.proxmox_storage_contents_info — список содержимого хранилища Proxmox VE

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.proxmox. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_storage_contents_info.

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

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

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

Требования

Следующие требования должны быть выполнены на хосте, где выполняется этот модуль.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой хост кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секретный ключ токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
content string	Фильтр по определённому типу содержимого. Варианты: `"all"` ← (по умолчанию) `"backup"` `"rootdir"` `"images"` `"iso"` `"import"`
node string / обязательный	Узел Proxmox, к которому подключено хранилище.
storage псевдонимы: name string / обязательный	Возвращать только содержимое, хранящееся в указанном хранилище.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. Текущее значение по умолчанию — `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vmid integer	Фильтр по определённому VMID.

Атрибуты

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

Примеры

- name: List existing storages
  community.proxmox.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 list / elements=dictionary	Содержимое хранилища, подключённого к узлу. Возвращается: при успешном выполнении
content string	Тип содержимого объектов, перечисленных в этом хранилище Proxmox. Возвращается: при успешном выполнении
ctime string	Время создания перечисленных объектов. Возвращается: при успешном выполнении
format string	Формат перечисленных объектов (может быть `raw`, `pbs-vm`, `iso`,…). Возвращается: при успешном выполнении
size integer	Размер перечисленных объектов. Возвращается: при успешном выполнении
subtype string	Подтип перечисленных объектов (может быть `qemu` или `lxc`). Возвращается: если хранилище предназначено для резервного копирования, обычно в хранилище PBS.
verification dictionary	Статус проверки резервных копий перечисленных объектов. Возвращается: если хранилище предназначено для резервного копирования, обычно в хранилище PBS. Пример: `{"state": "ok", "upid": "UPID:backup-srv:00130F49:1A12D8375:00001CD7:657A2258:verificationjob:daily\\x3av\\x2dd0cc18c5\\x2d8707:root@pam:"}`
volid string	Идентификатор тома перечисленных объектов. Возвращается: при успешном выполнении

Авторы

Julian Vanden Broeck (@l00ptr)

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

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