Модуль openstack.cloud.server_group — управление группами серверов OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.server_group.
Краткое описание
- Добавление и удаление групп серверов в OpenStack.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Как долго уровень сокетов должен ожидать перед тем, как прервать вызовы API по тайм-ауту. Если параметр не указан, библиотеке requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми стратегии плагина аутентификации облака. Для плагина password, используемого по умолчанию, в нём должны содержаться auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если в облаке используется не аутентификация по паролю, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при SSL-соединении. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при SSL-соединении. |
cloud any | Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, извлекаемой из каталога служб. Варианты:
|
name string / обязательный | Имя группы серверов. |
policy string | Текущее имя политики. Варианты:
|
region_name string | Имя региона. |
rules dictionary | Правила, применяемые к политике. В настоящее время для политики |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
state string | Желаемое состояние ресурса. Если значение state равно Варианты:
|
timeout integer | Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения обработки запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут браться из файла конфигурации yaml: /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно заданных параметров в плейбуках. Дополнительную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Create a server group with 'affinity' policy.
openstack.cloud.server_group:
cloud: "{{ cloud }}"
state: present
name: my_server_group
policy: affinity
- name: Delete 'my_server_group' server group.
openstack.cloud.server_group:
cloud: "{{ cloud }}"
state: absent
name: my_server_group
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
server_group dictionary | Объект, представляющий группу серверов Возвращается: при успешном выполнении, если задано значение state |
|
id string |
Уникальный UUID. Возвращается: всегда |
|
member_ids list / elements=string |
Список участников группы серверов Возвращается: всегда |
|
metadata dictionary |
Пары ключей и значений метаданных. Возвращается: всегда |
|
name string |
Имя группы серверов. Возвращается: всегда |
|
policies list / elements=string |
Список, содержащий ровно одно имя политики, связанной с группой. Доступно до микроверсии 2.63 Возвращается: всегда |
|
policy string |
Имя политики. Доступно начиная с версии 2.64. Возвращается: всегда |
|
project_id string |
ID проекта, которому принадлежит группа серверов. Возвращается: всегда |
|
rules dictionary |
Поле правил, применяемых к политике. В настоящее время для политики Возвращается: всегда |
|
user_id string |
ID пользователя, которому принадлежит группа серверов. Возвращается: всегда |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/server_group_module.html