os_listener – Добавление/удаление слушателя для балансировщика нагрузки из OpenStack Cloud

Новое в версии 2.7.

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

Обзор

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

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout -		Сколько времени должна ждать сокетная прослойка перед таймаутом для API-вызовов. Если это значение опущено, оно не будет передано в библиотеку requests.
auth -		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые этим плагином. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type -		Название плагина авторизации для использования. Если облако использует что-то помимо парольной авторизации, здесь следует указать имя плагина, а содержимое параметра auth следует соответствующим образом обновить.
availability_zone -		Игнорируется. Присутствует для обратной совместимости.
cacert -		Путь к пакету сертификатов CA, который можно использовать для проверки SSL API-запросов.
cert -		Путь к клиенту сертификату, который необходимо использовать в рамках SSL-транзакции.
cloud -		Используемое облако или конфигурация облака. Если cloud — строка, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную той, что присутствует в разделе clouds.yaml.
interface - добавлено в 2.3	Варианты: public ← internal admin	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
key -		Путь к клиенту ключу для использования в рамках SSL-транзакции.
loadbalancer - / обязательно		Имя или идентификатор балансировщика нагрузки, к которому относится этот слушатель.
name - / обязательно		Имя, которое должно быть присвоено слушателю.
protocol -	Варианты: HTTP ← HTTPS TCP TERMINATED_HTTPS	Протокол для слушателя.
protocol_port -	По умолчанию: 80	Номер порта протокола для слушателя.
region_name -		Имя региона.
state -	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout -	По умолчанию: 180	Время, которое модуль должен ожидать, пока балансировщик нагрузки не перейдёт в состояние ACTIVE.
verify boolean	Варианты: no yes	Необходимо ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs
wait boolean	Варианты: no yes ←	Нужно ли модулю ожидать, пока балансировщик нагрузки не станет ACTIVE.

Примечания

Примечание

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

Примеры

# Create a listener, wait for the loadbalancer to be active.
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-listener
    loadbalancer: test-loadbalancer
    protocol: HTTP
    protocol_port: 8080

# Create a listener, do not wait for the loadbalancer to be active.
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-listener
    loadbalancer: test-loadbalancer
    protocol: HTTP
    protocol_port: 8080
    wait: no

# Delete a listener
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-listener
    loadbalancer: test-loadbalancer

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

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

Ключ		Возвращаемое значение	Описание
id строка		При успехе, когда state равно 'present'	UUID слушателя. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener сложный тип		При успехе, когда state равно 'present'	Словарь, описывающий слушатель.
	description строка		Описание слушателя. Пример: description
	id строка		Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up булево значение		Административное состояние слушателя. Пример: True
	load_balancer_id строка		UUID балансировщика нагрузки, к которому принадлежит этот слушатель. Пример: b32eef7e-d2a6-4ea4-a301-60a873f89b3b
	loadbalancers список		Список идентификаторов балансировщиков нагрузки. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	name строка		Имя, присвоенное слушателю. Пример: test
	operating_status строка		Рабочее состояние слушателя. Пример: ONLINE
	protocol строка		Протокол для слушателя. Пример: HTTP
	protocol_port целое число		Номер порта протокола для слушателя. Пример: 80
	provisioning_status строка		Статус подготовки слушателя. Пример: ACTIVE

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Lingxian Kong (@lingxiankong)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_listener_module.html