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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: openstack.cloud.loadbalancer.

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

Описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должна ждать сетевая прослойка, прежде чем отказать вызов API из-за истечения времени ожидания. Если этот параметр опущен, к библиотеке запросов ничего не будет передано.
assign_floating_ip псевдонимы: auto_public_ip логическое значение	Автоматически выделять адрес плавающего IP и ассоциировать его с VIP. Устарело, используйте openstack.cloud.floating_ip вместо этого. Варианты: `false` ← (по умолчанию) `true`
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии подключа к облаку. Для плагина password по умолчанию он должен содержать auth_url, username, password, project_name и любую информацию о домене (например, user_domain_name или project_domain_name), если облако поддерживает их. Для других плагинов этот параметр должен содержать параметры, необходимые для данного плагина. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то помимо парольной авторизации, здесь необходимо указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой тип	Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
delete_floating_ip псевдонимы: delete_public_ip логическое значение	Когда state равен `present` и delete_floating_ip равен `true`, тогда любой адрес плавающего IP, связанный с VIP, будет удалён. Когда state равен `absent` и delete_floating_ip равен `true`, тогда любой адрес плавающего IP, связанный с VIP, будет удалён вместе с балансировщиком. Устарело, используйте openstack.cloud.floating_ip вместо этого. Варианты: `false` ← (по умолчанию) `true`
description строка	Читаемый человеком текст, описывающий балансировщик.
flavor строка	Тип балансировщика. Это свойство нельзя изменить.
floating_ip_address псевдонимы: public_ip_address строка	Адрес плавающего IP (общедоступный IP-адрес), связанный с VIP. Устарело, используйте openstack.cloud.floating_ip вместо этого.
floating_ip_network псевдонимы: public_network строка	Имя или идентификатор внешней сети Neutron, на которой будет создан адрес плавающего IP. Устарело, используйте openstack.cloud.floating_ip вместо этого.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательно	Имя балансировщика. Это свойство нельзя изменить.
region_name строка	Имя региона.

sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Сколько времени Ansible должно ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs aliases: verify boolean	Должны ли проверяться запросы SSL API. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`
vip_address string	IP-адрес виртуального IP-адреса балансировщика нагрузки. Это атрибут не может быть обновлен.
vip_network string	Имя или идентификатор сети для виртуального IP-адреса балансировщика нагрузки. Для создания необходимо указать один из параметров vip_network, vip_subnet или vip_port. Это атрибут не может быть обновлен.
...	...

Примечания

Примечание

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

Примеры

- name: Create a load balancer
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: present
    vip_subnet: my_subnet

- name: Create another load balancer
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: present
    vip_address: 192.168.0.11
    vip_network: my_network

- name: Delete a load balancer and all its related resources
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: absent

- name: Delete a load balancer, its related resources and its floating ip
  openstack.cloud.loadbalancer:
    cloud: devstack
    delete_floating_ip: true
    name: my_lb
    state: absent

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

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

Ключ	Описание
floating_ip dictionary	Словарь, описывающий IP-адрес, прикрепленный к балансировщику нагрузки. Возвращается: При успешном завершении, когда state равно `present` и assign_floating_ip равно `true`.
created_at string	Метка времени, когда был назначен плавающий IP-адрес. Возвращается: при успехе
description string	Описание плавающего IP-адреса. Возвращается: при успехе
dns_domain string	DNS-домен. Возвращается: при успехе
dns_name string	DNS-имя. Возвращается: при успехе
fixed_ip_address string	Фиксированный IP-адрес, связанный с плавающим IP-адресом. Возвращается: при успехе
floating_ip_address string	IP-адрес плавающего IP. Возвращается: при успехе
floating_network_id string	Идентификатор сети, связанной с плавающим IP. Возвращается: при успехе
id string	Идентификатор плавающего IP. Возвращается: при успехе
name string	Имя плавающего IP. Возвращается: при успехе
port_details dictionary	Подробная информация о порте, с которым связан этот плавающий IP. Присутствует, если загружено расширение `fip-port-details`. Возвращается: при успехе
port_id string	Идентификатор порта, с которым связан плавающий IP. Возвращается: при успехе
project_id string	Идентификатор проекта, с которым связан этот плавающий IP. Возвращается: при успехе
qos_policy_id string	Идентификатор политики QoS, прикрепленной к плавающему IP. Возвращается: при успехе
revision_number string	Номер ревизии. Возвращается: при успехе
router_id string	Идентификатор маршрутизатора, с которым связан плавающий IP. Возвращается: при успехе
status string	Статус плавающего IP, который может быть «ACTIVE» или «DOWN». Возвращается: при успехе
subnet_id string	Идентификатор подсети, с которой связан плавающий IP. Возвращается: при успехе
tags list / elements=string	Список тегов. Возвращается: при успехе
updated_at string	Метка времени последнего обновления плавающего IP. Возвращается: при успехе
load_balancer dictionary	Словарь, описывающий балансировщик нагрузки. Возвращается: При успешном завершении, когда state равно `present`.
additional_vips string	Дополнительные VIP-адреса. Возвращается: при успехе

availability_zone string	Название целевой зоны доступности Octavia. Возвращено: success
created_at string	Метка времени создания балансировщика нагрузки. Возвращено: success
description string	Описание балансировщика нагрузки. Возвращено: success
flavor_id string	ID типа балансировщика нагрузки. Возвращено: success
id string	Уникальный UUID. Возвращено: success
is_admin_state_up boolean	Административное состояние балансировщика нагрузки. Возвращено: success
listeners list / elements=string	Связанные ID прослушивателей, если таковые имеются. Возвращено: success
name string	Имя, данное балансировщику нагрузки. Возвращено: success
operating_status string	Рабочее состояние балансировщика нагрузки. Возвращено: success
pools list / elements=string	Связанные ID пулов, если таковые имеются. Возвращено: success
project_id string	ID проекта, с которым связан этот балансировщик нагрузки. Возвращено: success
provider string	Имя поставщика для балансировщика нагрузки. Возвращено: success
provisioning_status string	Статус подготовки балансировщика нагрузки. Возвращено: success
tags string	Список связанных тегов. Возвращено: success
updated_at string	Метка времени последнего обновления балансировщика нагрузки. Возвращено: success
vip_address string	Виртуальный IP-адрес балансировщика нагрузки. Возвращено: success
vip_network_id string	ID сети, к которой принадлежит виртуальный IP-порт балансировщика нагрузки. Возвращено: success
vip_port_id string	ID виртуального IP-порта балансировщика нагрузки. Возвращено: success
vip_qos_policy_id string	ID политики QoS VIP. Возвращено: success
vip_subnet_id string	ID подсети, к которой принадлежит виртуальный IP-порт балансировщика нагрузки. Возвращено: 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/loadbalancer_module.html