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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: openstack.cloud.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 булево	Варианты: no ← yes	Требуется ли проверка запросов API SSL. До Ansible 2.3 по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: no yes ←	Должен ли 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/server_group_module.html