Модуль community.proxmox.proxmox_storage_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_info.

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

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

Получение сведений об одном или нескольких хранилищах Proxmox VE.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

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`.
storage псевдонимы: name string	Возвращать сведения только об указанном хранилище.
type string	Фильтр по типу хранилища.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная среды `PROXMOX_VALIDATE_CERTS`. Возможные значения: `false` `true`

Атрибуты

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

Примечания

Примечание

Этот модуль может возвращать параметры, относящиеся к конкретному хранилищу. См. документацию по адресу https://pve.proxmox.com/wiki/Storage.

Примеры

- name: List existing storages
  community.proxmox.proxmox_storage_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) }}"
  register: proxmox_storages

- name: List NFS storages only
  community.proxmox.proxmox_storage_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) }}"
    type: nfs
  register: proxmox_storages_nfs

- name: Retrieve information about the lvm2 storage
  community.proxmox.proxmox_storage_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
  register: proxmox_storage_lvm

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

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

Ключ	Описание
proxmox_storages list / элементы=dictionary	Список пулов хранения. Возвращается: при успешном выполнении
content list / элементы=string	Типы содержимого Proxmox, доступные в этом хранилище. Возвращается: при успешном выполнении
digest string	Контрольная сумма хранилища. Возвращается: при успешном выполнении
nodes list / элементы=string	Список узлов, связанных с этим хранилищем. Возвращается: при успешном выполнении, если хранилище не является локальным
path string	Физический путь к этому хранилищу. Возвращается: при успешном выполнении
prune-backups list / элементы=dictionary	Параметры хранения резервных копий. Возвращается: при успешном выполнении
shared boolean	Является ли это хранилище общим. Возвращается: при успешном выполнении
storage string	Имя хранилища. Возвращается: при успешном выполнении
type string	Тип хранилища. Возвращается: при успешном выполнении

Авторы

Tristan Le Guern (@tleguern)

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

© 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_info_module.html