os_listener – Добавление/удаление слушателя для балансировщика нагрузки из OpenStack Cloud
Новая версия с 2.7.
Обзор
- Добавление или удаление слушателя для балансировщика нагрузки из службы балансировки нагрузки OpenStack.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная прослойка, прежде чем произойдет таймаут для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| 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-сертификата, который может использоваться для проверки запросов 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 строка добавлен в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| loadbalancer - / обязательно | Имя или идентификатор балансировщика нагрузки, к которому принадлежит этот слушатель. | |
| name - / обязательно | Имя, которое должно быть задано слушателю | |
| protocol - |
| Протокол для слушателя. |
| protocol_port - | Значение по умолчанию: 80 | Номер порта протокола для слушателя. |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| 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 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 | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/os_listener_module.html
