Spec-Zone.ru › Ansible

openstack.cloud.lb_member модуль — Управление членами пула балансировщика нагрузки OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные требования. Подробности см. в разделе Требования.

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

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

Краткое описание

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

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

address

string

IP-адрес участника.

Обязательно, когда state равно present.

Этот атрибут не может быть обновлен.

api_timeout

integer

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

auth

dictionary

Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, необходимые этому плагину аутентификации. Этот параметр не нужен, если предоставлено имя облака или присутствуют переменные среды OpenStack OS_*.

auth_type

string

Имя плагина аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом.

ca_cert

aliases: cacert

string

Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API.

client_cert

aliases: cert

string

Путь к клиентскому сертификату, используемому в качестве части транзакции SSL.

client_key

aliases: key

string

Путь к клиентскому ключу, используемому в качестве части транзакции SSL.

cloud

any

Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.

interface

aliases: endpoint_type

string

Тип URL-адреса конечной точки для получения из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

monitor_address

string

IP-адрес, используемый для мониторинга этого участника.

monitor_port

integer

Порт, используемый для мониторинга этого участника.

name

string / required

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

pool

string / required

Имя или ID пула, к которому принадлежит этот участник.

Этот атрибут не может быть обновлен.

protocol_port

integer

Номер порта протокола для участника.

Обязательно, когда state равно present.

Этот атрибут не может быть обновлен.

region_name

string

Имя региона.

sdk_log_level

string

Уровень логирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается

state

string

Должен ли ресурс быть present или absent.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subnet_id

string

ID подсети, из которой доступна служба участника.

Этот атрибут не может быть обновлен.

timeout

integer

Как долго ansible должен ждать запрашиваемый ресурс.

По умолчанию: 180

validate_certs

aliases: verify

boolean

Проверка SSL-запросов API.

До Ansible 2.3 по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ждать завершения запрошенного ресурса?

Варианты:

  • false
  • true ← (по умолчанию)

weight

integer

Вес члена определяет долю запросов или подключений, которые он обслуживает по сравнению с другими членами пула.

Например, член с весом 10 получает в пять раз больше запросов, чем член с весом 2. Значение 0 означает, что член не получает новых подключений, но продолжает обслуживать существующие. Допустимое значение — от 0 до 256.

По умолчанию в Octavia для weight установлено 1.

Примечания

Примечание

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

Примеры

- name: Create member in a load-balancer pool
  openstack.cloud.lb_member:
    address: 192.168.10.3
    cloud: mycloud
    name: test-member
    pool: test-pool
    protocol_port: 8080
    state: present

- name: Delete member from a load-balancer pool
  openstack.cloud.lb_member:
    cloud: mycloud
    name: test-member
    pool: test-pool
    state: absent

Значения возврата

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

Ключ

Описание

member

dictionary

Словарь, описывающий член пула балансировщика нагрузки.

Возвращается: При успехе, когда state равен present.

address

string

IP-адрес сервера заднего члена.

Возвращается: успех

backup

boolean

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

Возвращается: успех

created_at

string

Метка времени создания члена.

Возвращается: успех

id

string

Уникальный UUID.

Возвращается: успех

is_admin_state_up

boolean

Административное состояние члена.

Возвращается: успех

monitor_address

string

IP-адрес, используемый для мониторинга этого члена.

Возвращается: успех

monitor_port

integer

Порт, используемый для мониторинга этого члена.

Возвращается: успех

name

string

Имя, данное члену.

Возвращается: успех

operating_status

string

Рабочее состояние члена.

Возвращается: успех

project_id

string

ID проекта, с которым связан этот член.

Возвращается: успех

protocol_port

integer

Номер порта протокола для члена.

Возвращается: успех

provisioning_status

string

Статус подготовки члена.

Возвращается: успех

subnet_id

string

ID подсети, из которой доступна служба члена.

Возвращается: успех

tags

list / elements=string

Список связанных тегов.

Возвращается: успех

updated_at

string

Метка времени последнего обновления члена.

Возвращается: успех

weight

integer

Положительное целое число, указывающее относительную долю трафика, которую этот член должен получать из пула. Например, член с весом 10 получает в пять раз больше трафика, чем член с весом 2.

Возвращается: успех

pool

dictionary

Словарь, описывающий пул балансировщика нагрузки.

Возвращается: При успехе, когда state равен present.

alpn_protocols

list / elements=string

Список протоколов ALPN.

Возвращается: успех

created_at

string

Метка времени создания пула.

Возвращается: успех

description

string

Описание пула.

Возвращается: успех

health_monitor_id

string

ID монитора состояния.

Возвращается: успех

id

string

Уникальный UUID.

Возвращено: success

is_admin_state_up

boolean

Административное состояние пула.

Возвращено: success

lb_algorithm

string

Алгоритм балансировки нагрузки для пула.

Возвращено: success

listener_id

string

ID прослушивателя, к которому принадлежит пул.

Возвращено: success

listeners

list / elements=string

Список ID прослушивателей.

Возвращено: success

loadbalancer_id

string

ID балансировщика нагрузки, к которому принадлежит пул. Это поле устанавливается, когда пул не принадлежит ни одному прослушивателю в балансировщике нагрузки.

Возвращено: success

loadbalancers

list / elements=string

Список ID балансировщиков нагрузки.

Возвращено: success

members

list / elements=string

Список ID участников.

Возвращено: success

name

string

Имя, данное пулу.

Возвращено: success

operating_status

string

Оперативный статус пула.

Возвращено: success

project_id

string

ID проекта.

Возвращено: success

protocol

string

Протокол для пула.

Возвращено: success

provisioning_status

string

Статус подготовки пула.

Возвращено: success

session_persistence

dictionary

JSON-объект, указывающий на сохранение сессии для пула.

Возвращено: success

tags

list / elements=string

Список связанных тегов.

Возвращено: success

tls_ciphers

string

Сохраняет строку шифров в формате OpenSSL.

Возвращено: success

tls_enabled

boolean

Использовать TLS для подключений к серверам участников бэкэнда.

Возвращено: success

tls_versions

list / elements=string

Список используемых пулом версий протокола TLS.

Возвращено: success

updated_at

string

Метка времени обновления пула.

Возвращено: success

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API