Модуль community.general.proxmox_storage_info – Получение информации об одном или нескольких хранилищах Proxmox VE

Примечание

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

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

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

Для использования в книге задач укажите: community.general.proxmox_storage_info.

Новая в community.general 2.2.0

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

Описание

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

Требования

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

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 строка / обязательно	Укажите пользователя для аутентификации.
storage псевдонимы: имя строка	Возвращает информацию только о конкретном хранилище.
type строка	Фильтр по типу хранилища.
validate_certs логическое значение	Если `false`, сертификаты SSL не будут проверены. Используется только на сайтах, управляемых вами, с самоподписанными сертификатами. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

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

Примечания

Примечание

Параметры, специфичные для хранилища, могут быть возвращены этим модулем. Пожалуйста, обратитесь к документации по адресу https://pve.proxmox.com/wiki/Storage.

Примеры

- name: List existing storages
  community.general.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.general.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.general.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 список / элементы=словарь	Список пулов хранения. Возвращаемое значение: при успехе
content список / элементы=строка	Типы содержимого Proxmox, доступные в этом хранилище Возвращаемое значение: при успехе
digest строка	Хеш-код хранилища Возвращаемое значение: при успехе
nodes список / элементы=строка	Список узлов, связанных с этим хранилищем Возвращаемое значение: при успехе, если хранилище не локальное
path строка	Физический путь к этому хранилищу Возвращаемое значение: при успехе
prune-backups список / элементы=словарь	Параметры хранения резервных копий Возвращаемое значение: при успехе
shared логическое значение	Является ли это хранилище общим? Возвращаемое значение: при успехе
storage строка	Имя хранилища Возвращаемое значение: при успехе
type строка	Тип хранилища Возвращаемое значение: при успехе

Авторы

Tristan Le Guern (@tleguern)

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

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