openstack.cloud.lb_member – Добавление/удаление члена для пула в балансировщике нагрузки из OpenStack Cloud

Примечание

Этот плагин входит в сборку openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в книге задач укажите: openstack.cloud.lb_member.

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

Описание

Добавление или удаление члена для пула из сервиса балансировщика нагрузки OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address строка		IP-адрес члена.
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 строка		Путь к пакету сертификатов CA, который может использоваться для проверки запросов SSL API. Псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату для использования в процессе SSL. Псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в процессе SSL. Псевдонимы: key
cloud сырой		Названное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, аналогичную той, что находится в разделе clouds.yaml.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type
name строка / обязательно		Имя, которое должно быть присвоено члену
pool строка / обязательно		Имя или идентификатор пула, к которому относится этот член.
protocol_port целое число	Значение по умолчанию: 80	Номер порта протокола для члена.
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
subnet_id строка		Идентификатор подсети, с которой доступен член службы.
timeout целое число	Значение по умолчанию: 180	Время, в секундах, которое модуль должен ждать, пока балансировщик нагрузки не перейдет в состояние ACTIVE.
validate_certs булево	Варианты: нет ← да	Подтверждать ли запросы SSL API. До Ansible 2.3 по умолчанию `yes`. Псевдонимы: verify
wait булево	Варианты: нет да ←	Если модуль должен ожидать, пока балансировщик нагрузки станет ACTIVE.

Примечания

Примечание

Могут использоваться стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об аутентификации определяется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти на странице https://docs.openstack.org/openstacksdk/

Примеры

# Create a member, wait for the member to be created.
- openstack.cloud.lb_member:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-member
    pool: test-pool
    address: 192.168.10.3
    protocol_port: 8080

# Delete a listener
- openstack.cloud.lb_member:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-member
    pool: test-pool

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращается	Описание
id строка		При успехе, когда state равен 'present'	UUID члена. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
member сложное		При успехе, когда state равен 'present'	Словарь, описывающий члена.
	address строка	успех	IP-адрес сервера члена бэкенда. Пример: 192.168.2.10
	description строка	успех	Описание члена. Пример: описание
	id строка	успех	Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up булево	успех	Административное состояние члена. Пример: True
	name строка	успех	Имя, присвоенное члену. Пример: test
	operating_status строка	успех	Рабочее состояние члена. Пример: ONLINE
	protocol_port целое число	успех	Номер порта протокола для члена. Пример: 80
	provisioning_status строка	успех	Состояние подготовки члена. Пример: ACTIVE
	subnet_id строка	успех	Идентификатор подсети, с которой доступен член службы. Пример: 489247fa-9c25-11e8-9679-00224d6b7bc1

Авторы

OpenStack Ansible SIG

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