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-запросов. Если это значение опущено, библиотека requests ничего не получит.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости.
ca_cert строка		Путь к пакету сертификата CA, который может использоваться при проверке SSL API-запросов. псевдонимы: 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 булево	Варианты: нет ← да	Требуется ли проверка SSL API-запросов. До 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/server_group_module.html