os_server_group – Управление группами серверов OpenStack
Описание
- Добавление или удаление групп серверов из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать подсистема сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| 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 строка |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name - / обязательно | Имя группы серверов. | |
| policies - | Список из одного или нескольких имен политик, которые необходимо связать с группой серверов. Список должен содержать по крайней мере одно имя политики. В настоящее время допустимыми именами политик являются anti-affinity, affinity, soft-anti-affinity и soft-affinity. | |
| region_name строка | Имя региона. | |
| state - |
| Укажите желаемое состояние ресурса. Когда 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.
- 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. [сообщество]
Авторы
- 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.9/modules/os_server_group_module.html
