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

Примечание

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

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

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

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

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

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

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

Требования

Следующие требования необходимы на хосте, выполняющем этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Описание
api_timeout integer	Время ожидания сокетного уровня перед завершением вызовов API по тайм-ауту. Если параметр не указан, в библиотеку requests ничего не передаётся.
assign_floating_ip псевдонимы: auto_public_ip boolean	Автоматически выделять плавающий IP-адрес и связывать его с VIP. Устарел, вместо него используйте openstack.cloud.floating_ip. Варианты: `false` ← (по умолчанию) `true`
auth dictionary	Словарь с данными аутентификации, необходимыми выбранному облачному модулю аутентификации. Для стандартного модуля password в него входят auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других модулей этот параметр должен содержать необходимые им данные. Параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.
auth_type string	Имя используемого модуля аутентификации. Если в облаке используется аутентификация не по паролю, здесь следует указать имя модуля и соответствующим образом обновить содержимое параметра auth.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов CA, который можно использовать для проверки запросов к API через SSL.
client_cert псевдонимы: cert string	Путь к клиентскому сертификату, используемому при обмене данными через SSL.
client_key псевдонимы: key string	Путь к клиентскому ключу, используемому при обмене данными через SSL.
cloud any	Именованное облако или конфигурация облака, с которыми выполняются действия. Если cloud — строка, она ссылается на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.
delete_floating_ip псевдонимы: delete_public_ip boolean	Если state имеет значение `present`, а delete_floating_ip — `true`, связанный с VIP плавающий IP-адрес будет удалён. Если state имеет значение `absent`, а delete_floating_ip — `true`, связанный с VIP плавающий IP-адрес будет удалён вместе с балансировщиком нагрузки. Устарел, вместо него используйте openstack.cloud.floating_ip. Варианты: `false` ← (по умолчанию) `true`
description string	Удобочитаемое описание балансировщика нагрузки.
flavor string	Тип балансировщика нагрузки. Этот атрибут нельзя обновить.
floating_ip_address псевдонимы: public_ip_address string	Плавающий IP-адрес, также называемый публичным IP-адресом, связанный с VIP. Устарел, вместо него используйте openstack.cloud.floating_ip.
floating_ip_network псевдонимы: public_network string	Имя или идентификатор внешней сети Neutron, в которой будет создан плавающий IP-адрес. Устарел, вместо него используйте openstack.cloud.floating_ip.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string / обязательный	Имя балансировщика нагрузки. Этот атрибут нельзя обновить.
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если путь не указан, журнал не ведётся.
state string	Должен ли ресурс существовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время ожидания ansible для запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы к API через SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
vip_address string	IP-адрес виртуального IP-адреса балансировщика нагрузки. Этот атрибут нельзя обновить.
vip_network string	Имя или идентификатор сети для виртуального IP-адреса балансировщика нагрузки. При создании необходимо указать один из параметров: vip_network, vip_subnet или vip_port. Этот атрибут нельзя обновить.
vip_port string	Имя или идентификатор порта виртуального IP-адреса балансировщика нагрузки. Один из При создании необходимо указать один из параметров: vip_network, vip_subnet или vip_port. Этот атрибут нельзя обновить.
vip_subnet string	Имя или идентификатор подсети для виртуального IP-адреса балансировщика нагрузки. При создании необходимо указать один из параметров: vip_network, vip_subnet или vip_port. Этот атрибут нельзя обновить.
wait boolean	Должен ли ansible ожидать завершения создания запрошенного ресурса. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Авторы

Группа специальных интересов OpenStack Ansible

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

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