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

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 целое число	Сколько времени должен ждать уровень сокета, прежде чем истечёт время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert алиасы: cacert строка	Путь к пакету сертификатов CA, который можно использовать в качестве части проверки запросов API SSL.
client_cert алиасы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key алиасы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в секции clouds.yaml.
interface алиасы: endpoint_type строка	Тип URL конечной точки для получения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательный	Имя группы серверов.
policy строка	Представляет текущее имя политики. Варианты: `"anti-affinity"` `"affinity"` `"soft-anti-affinity"` `"soft-affinity"`
region_name строка	Имя региона.
rules словарь	Правила, которые будут применяться к политике. В настоящее время поддерживается только правило `max_server_per_host` для политики `anti-affinity`.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
state строка	Указывает желаемое состояние ресурса. Когда state равен `present`, тогда policy является обязательным. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
validate_certs алиасы: verify логический	Необходимо ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`
wait логический	Должен ли 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/

Примеры

- 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 словарь	Объект, представляющий группу серверов Возвращается: при успешном выполнении, если присутствует параметр state
id строка	Уникальный UUID. Возвращается: всегда
member_ids список / элементы=строка	Список членов группы серверов Возвращается: всегда
metadata словарь	Пара ключей и значений метаданных. Возвращается: всегда
name строка	Название группы серверов. Возвращается: всегда
policies список / элементы=строка	Список ровно одного имени политики для ассоциации с группой. Доступно до микроверсии 2.63 Возвращается: всегда
policy строка	Представляет имя политики. Доступно начиная с версии 2.64. Возвращается: всегда
project_id строка	Идентификатор проекта, владеющего группой серверов. Возвращается: всегда
rules словарь	Поле правил, применяемое к политике. В настоящее время поддерживается только правило `max_server_per_host`, для политики `anti-affinity`. Возвращается: всегда
user_id строка	Идентификатор пользователя, владеющего группой серверов. Возвращается: всегда

Авторы

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/server_group_module.html