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

Новая версия 2.2.

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

Обзор

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

Требования

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

openstacksdk
python >= 2.7

Параметры

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

Примечания

Примечание

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

Примеры

# Create a server group with 'affinity' policy.
- os_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.
- os_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 строка	успех	Идентификатор пользователя, которому принадлежит группа серверов.

Статус

Не гарантируется обратная совместимость интерфейса модуля. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Lingxian Kong (@kong)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.

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