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) |
| Тип 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 bool |
| Проверка запросов API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| 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. См. Техническое обслуживание модулей и поддержка для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/os_server_group_module.html
