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

Примечание

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

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

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

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

Описание

Добавление или удаление пула из службы балансировки нагрузки OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Время ожидания сокета при вызове API. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. Псевдонимы: 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
lb_algorithm строка	Варианты: LEAST_CONNECTIONS ROUND_ROBIN ← SOURCE_IP	Алгоритм балансировки нагрузки для пула.
listener строка		Имя или идентификатор слушателя, к которому относится этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener.
loadbalancer строка		Имя или идентификатор балансировщика нагрузки, к которому относится этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener.
name строка / обязательный		Имя, которое должно быть дано пулу
protocol строка	Варианты: HTTP ← HTTPS PROXY TCP UDP	Протокол для пула.
region_name строка		Название региона.
state строка	Варианты: present ← absent	Должен ли ресурс присутствовать или отсутствовать.
timeout целое число	Значение по умолчанию: 180	Время ожидания модуля, пока пул не перейдет в состояние ACTIVE.
validate_certs булево	Варианты: нет ← да	Нужно ли проверять запросы API SSL. До 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 pool, wait for the pool to be active.
- openstack.cloud.lb_pool:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-pool
    loadbalancer: test-loadbalancer
    protocol: HTTP
    lb_algorithm: ROUND_ROBIN

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

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

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

Ключ		Возвращаемое значение	Описание
id строка		При успехе, когда состояние равно 'present'	UUID пула. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener сложный		При успехе, когда состояние равно 'present'	Словарь, описывающий пул.
	description строка	успех	Описание пула. Пример: описание
	id строка	успех	Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up булево	успех	Административное состояние пула. Пример: True
	lb_algorithm строка	успех	Алгоритм балансировки нагрузки для пула. Пример: ROUND_ROBIN
	listener_id строка	успех	Идентификатор слушателя, к которому принадлежит пул. Пример: 956aa716-9c2f-11e8-83b3-44a8422643a4
	listeners список / элементы=строка	успех	Список идентификаторов слушателей. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	loadbalancer_id строка	успех	Идентификатор балансировщика нагрузки, к которому принадлежит пул. Это поле устанавливается, когда пул не принадлежит ни одному слушателю в балансировщике нагрузки. Пример: 7c4be3f8-9c2f-11e8-83b3-44a8422643a4
	loadbalancers список / элементы=строка	успех	Список идентификаторов балансировщиков нагрузки. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	members список / элементы=строка	успех	Список идентификаторов членов. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	name строка	успех	Имя, заданное пулу. Пример: test
	operating_status строка	успех	Рабочее состояние пула. Пример: ONLINE
	protocol строка	успех	Протокол для пула. Пример: HTTP
	provisioning_status строка	успех	Состояние подготовки пула. Пример: ACTIVE

Авторы

OpenStack Ansible SIG

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