openstack.cloud.os_server_group – Управление группами серверов OpenStack

Примечание

Этот плагин входит в сборку openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud

Для использования в книге задач укажите: openstack.cloud.os_server_group

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

Обзор

Добавление или удаление групп серверов из OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени в секундах должна ждать сокетная часть, прежде чем истечёт время ожидания для вызовов API. Если это опущено, библиотека запросов ничего не получит.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификата для использования в рамках транзакции SSL. псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key
cloud сырой		Назначенное облако или конфигурация облака для работы. Если cloud - это строка, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* - это словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога услуг. псевдонимы: endpoint_type
name строка / обязательно		Имя группы серверов.
policies список / элементы=строка		Список одного или более имён политик, которые нужно связать с группой серверов. Список должен содержать хотя бы одно имя политики. Текущие допустимые имена политик: anti-affinity, affinity, soft-anti-affinity и soft-affinity.
region_name строка		Название региона.
state строка	Варианты: present ← absent	Указывает желаемое состояние ресурса. Когда state — 'present', то policies обязательно.
timeout целое число	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
validate_certs логическое	Варианты: нет ← да	Нужно ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было `yes` псевдонимы: verify
wait логическое	Варианты: нет да ←	Должен ли Ansible ждать, пока запрашиваемый ресурс завершится.

Примечания

Примечание

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

Примеры

# Create a server group with 'affinity' policy.
- openstack.cloud.server_group:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: my_server_group
    policies:
      - affinity

# Delete 'my_server_group' server group.
- openstack.cloud.server_group:
    state: absent
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: my_server_group

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

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

Ключ	Возвращаемое значение	Описание
id строка	успех	Уникальный UUID.
members список / элементы=строка	успех	Список участников в группе серверов.
metadata словарь	успех	Ключевые пары метаданных и их значения.
name строка	успех	Имя группы серверов.
policies список / элементы=строка	успех	Список одного или более имён политик группы серверов.
project_id строка	успех	Идентификатор проекта, которому принадлежит группа серверов.
user_id строка	успех	Идентификатор пользователя, которому принадлежит группа серверов.

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_server_group_module.html