Модуль openstack.cloud.host_aggregate — управление агрегатами хостов OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.host_aggregate.
Краткое описание
- Создание, обновление и удаление агрегатов хостов 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. |
availability_zone string | Зона доступности, в которой создается агрегат. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов ЦС, который можно использовать для проверки SSL-запросов API. |
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. |
hosts list / элементы=string | Список хостов, назначаемых агрегату. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
metadata dictionary | Словарь метаданных. |
name string / обязательный | Имя агрегата. |
purge_hosts boolean | Следует ли удалять из агрегата хосты, отсутствующие в hosts Варианты:
|
region_name string | Название региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
state string | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout integer | Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять SSL-запросы API. До 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/
Примеры
# Create a host aggregate
- openstack.cloud.host_aggregate:
cloud: mycloud
state: present
name: db_aggregate
hosts:
- host1
- host2
metadata:
type: dbcluster
# Add an additional host to the aggregate
- openstack.cloud.host_aggregate:
cloud: mycloud
state: present
name: db_aggregate
hosts:
- host3
purge_hosts: false
metadata:
type: dbcluster
# Delete an aggregate
- openstack.cloud.host_aggregate:
cloud: mycloud
state: absent
name: db_aggregate
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
aggregate dictionary | Ресурс агрегата хостов. Возвращается: при успешном выполнении, если state имеет значение present |
|
availability_zone string |
Зона доступности агрегата Возвращается: всегда |
|
created_at string |
Дата и время создания ресурса Возвращается: всегда |
|
deleted_at string |
Дата и время удаления ресурса Null, если is_deleted не равно true Возвращается: всегда |
|
hosts string |
Хосты, входящие в агрегат Возвращается: всегда |
|
id string |
UUID агрегата. Возвращается: всегда |
|
is_deleted boolean |
Удален ли ресурс Возвращается: всегда |
|
metadata string |
Метаданные, связанные с агрегатом Возвращается: всегда |
|
name string |
Имя агрегата Возвращается: всегда |
|
updated_at string |
Дата и время обновления ресурса Возвращается: всегда |
|
uuid string |
UUID агрегата Возвращается: всегда |
Ссылки на коллекцию
© 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/host_aggregate_module.html