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

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

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

Описание

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) должен ждать уровень сокета, прежде чем произойдёт таймаут для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любые данные о домене (например, os_user_domain_name или os_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
loadbalancer - / обязательный		Имя или идентификатор балансировщика нагрузки, к которому принадлежит этот слушатель.
name - / обязательный		Имя, которое должно быть присвоено слушателю
protocol -	Варианты: HTTP ← HTTPS TCP TERMINATED_HTTPS	Протокол для слушателя.
protocol_port -	Значение по умолчанию: 80	Номер порта протокола для слушателя.
region_name строка		Имя региона.
state -	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout целое число	Значение по умолчанию: 180	Время, в течение которого модуль должен ждать, пока балансировщик нагрузки не перейдёт в состояние ACTIVE.
validate_certs логическое значение	Варианты: no ← yes	Нужно ли проверять запросы SSL API. До Ansible 2.3 это значение по умолчанию было `yes`. Псевдонимы: verify
wait логическое значение	Варианты: no yes ←	Должен ли модуль ждать, пока балансировщик нагрузки не перейдет в состояние 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 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 строка		При успехе, когда состояние равно 'present'	UUID слушателя. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener сложный		При успехе, когда состояние равно '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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/os_listener_module.html