Модуль openstack.cloud.host_aggregate — Управление агрегатами хостов OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в playbook укажите: openstack.cloud.host_aggregate.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание, обновление или удаление агрегатов хостов OpenStack. Если агрегат с указанным именем уже существует, он будет обновлён с новым именем, новой зоной доступности, новыми метаданными и новым списком хостов.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должна ждать сокетная часть, прежде чем истечет время ожидания для вызовов API. Если это опущено, в библиотеку запросов ничего не будет передано.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, требуемые данным плагином авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то, кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка	Зона доступности для создания агрегата.
ca_cert псевдонимы: cacert строка	Путь к пакету CA Cert, который может использоваться для проверки запросов SSL API.
client_cert псевдонимы: cert строка	Путь к клиенту сертификат для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к клиенту ключ для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_.. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
hosts список / элементы=строка	Список хостов для установки для агрегата.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
metadata словарь	Словарь метаданных.
name строка / обязательно	Имя агрегата.
purge_hosts булево	Следует ли удалять хосты, отсутствующие в hosts, из агрегата Варианты: `false` `true` ← (по умолчанию)
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state строка	Ресурс должен быть присутствующим или отсутствующим. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Нужно ли проверять запросы SSL API. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`

wait

boolean

Должен ли ansible ждать, пока запрашиваемый ресурс не будет завершен.

Выбор:

false
true ← (по умолчанию)

Примечания

Примечание

Стандартные переменные среды 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 словарь	Ресурс агрегата хостов. Возвращается: При успехе, когда state присутствует
availability_zone строка	Зона доступности агрегата Возвращается: всегда
created_at строка	Дата и время создания ресурса Возвращается: всегда
deleted_at строка	Дата и время удаления ресурса Null, если is_deleted не true Возвращается: всегда
hosts строка	Хосты, принадлежащие агрегату Возвращается: всегда
id строка	UUID агрегата. Возвращается: всегда
is_deleted boolean	Удалён ли ресурс Возвращается: всегда
metadata строка	Метаданные, присоединённые к агрегату Возвращается: всегда
name строка	Имя агрегата Возвращается: всегда
updated_at строка	Дата и время обновления ресурса Возвращается: всегда
uuid строка	UUID агрегата Возвращается: всегда

Авторы

OpenStack Ansible SIG

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/host_aggregate_module.html