Модуль openstack.cloud.volume_service_info — получение служб томов OpenStack (Cinder)

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

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

Чтобы использовать его в плейбуке, укажите: openstack.cloud.volume_service_info.

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

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

Получение сведений о службах томов OpenStack (Cinder).

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Время ожидания сокетного уровня перед истечением времени ожидания вызовов API. Если значение не указано, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми для стратегии плагина аутентификации облака. Для стандартного плагина password в этом словаре должны содержаться auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные окружения OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если облако использует не аутентификацию по паролю, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth.
binary string	Фильтрация списка служб по имени двоичного файла службы.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов CA, который можно использовать для проверки запросов к API по SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при SSL-соединении.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при SSL-соединении.
cloud any	Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
host string	Фильтрация списка служб по имени хоста.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.
timeout integer	Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы к API по SSL. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения обработки запрошенного ресурса. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например OS_USERNAME.
Сведения для аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации yaml /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно заданных параметров в плейбуках. Дополнительную информацию см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Fetch all OpenStack Volume (Cinder) services
  openstack.cloud.volume_service_info:
    cloud: awesomecloud

- name: Fetch a subset of OpenStack Volume (Cinder) services
  openstack.cloud.volume_service_info:
    cloud: awesomecloud
    binary: "cinder-volume"
    host: "localhost"

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

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

Ключ	Описание
volume_services list / elements=dictionary	Список словарей с описанием служб томов (Cinder). Возвращается: всегда
availability_zone string	Имя зоны доступности. Возвращается: при успешном выполнении
binary string	Имя двоичного файла службы. Возвращается: при успешном выполнении
disabled_reason string	Причина отключения службы Возвращается: при успешном выполнении
host string	Имя хоста. Возвращается: при успешном выполнении
name string	Имя службы Возвращается: при успешном выполнении
state string	Состояние службы: up или down. Возвращается: при успешном выполнении
status string	Статус службы: enabled или disabled. Возвращается: при успешном выполнении
update_at string	Дата и время обновления ресурса Возвращается: при успешном выполнении

Авторы

Специальная группа Ansible по OpenStack

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

© 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/openstack/cloud/volume_service_info_module.html