os_server_group - Управление группами серверов OpenStack
Новая версия 2.2.
Обзор
- Добавление или удаление групп серверов из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для API-вызовов. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина проверки подлинности облака. Для плагина проверки подлинности по умолчанию (password), он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина проверки подлинности. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина проверки подлинности для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов. | |
| cert | Путь к клиенту сертификат для использования в рамках SSL-транзакции. | |
| cloud | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| name обязательно | Имя группы серверов. | |
| policies | Список одного или нескольких имён политик для ассоциации с группой серверов. Список должен содержать по крайней мере одно имя политики. В настоящее время допустимые имена политик — anti-affinity, affinity, soft-anti-affinity и soft-affinity. | |
| region_name | Имя региона. | |
| state |
| Укажите желаемое состояние ресурса. Когда state равен 'present', тогда policies требуется. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенный ресурс. |
| verify |
| Нужно ли проверять SSL-API-запросы. До версии 2.3 значение по умолчанию было True. Псевдонимы: validate_certs |
| wait |
| Должен ли 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 строка | успех | ID проекта, владеющего группой серверов. |
| user_id строка | успех | ID пользователя, владеющего группой серверов. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/os_server_group_module.html
