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

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

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

Описание

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

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) должна ждать сокет-слой перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он должен содержать auth_url, username, password, project_name и любые сведения о доменах (например, os_user_domain_name или os_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 строка добавлен в 2.3	Варианты: 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.
- 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 строка	успешно	ID проекта, владеющего группой серверов.
user_id строка	успешно	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.8/modules/os_server_group_module.html