os_loadbalancer – Добавление/удаление балансировщика нагрузки из OpenStack Cloud
Новое в версии 2.7.
Обзор
- Добавить или удалить балансировщик нагрузки из службы балансировщика нагрузки OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для API-вызовов. Если это опущено, ничего не будет передано в библиотеку requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о домене, если облако ее поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые для этого плагина авторизации. Этот параметр не нужен, если предоставлен имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type - | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| cacert - | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. | |
| cert - | Путь к клиенту сертификату для использования в рамках транзакции SSL. | |
| cloud - | Именованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface - добавлено в 2.3 |
| Тип URL-адреса конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| key - | Путь к клиенту ключу для использования в рамках транзакции SSL. | |
| name - / обязательно | Имя, которое должно быть присвоено балансировщику нагрузки | |
| region_name - | Имя региона. | |
| state - |
| Ресурс должен присутствовать или отсутствовать. |
| timeout - | По умолчанию: 180 | Количество времени, которое модуль должен ждать, пока балансировщик нагрузки не перейдет в состояние ACTIVE. |
| verify boolean |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| vip_address - | IP-адрес виртуального IP-адреса балансировщика нагрузки. | |
| vip_network - | Имя или идентификатор сети для виртуального IP-адреса балансировщика нагрузки. Один из vip_network, vip_subnet или vip_port должен быть указан. | |
| vip_port - | Имя или идентификатор порта виртуального IP-адреса балансировщика нагрузки. Один из vip_network, vip_subnet или vip_port должен быть указан. | |
| vip_subnet - | Имя или идентификатор подсети для виртуального IP-адреса балансировщика нагрузки. Один из vip_network, vip_subnet или vip_port должен быть указан. | |
| wait boolean |
| Если модуль должен ждать создания балансировщика нагрузки. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем из явных параметров в играх. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create a load balancer by specifying the VIP subnet.
- os_loadbalancer:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
state: present
name: my_lb
vip_subnet: my_subnet
timeout: 150
# Create a load balancer by specifying the VIP network and the IP address.
- os_loadbalancer:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
state: present
name: my_lb
vip_network: my_network
vip_address: 192.168.0.11
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | успех | Уникальный UUID. |
| is_admin_state_up boolean | успех | Административное состояние балансировщика нагрузки. |
| listeners список | успех | Связанные идентификаторы слушателей, если есть. |
| name строка | успех | Имя, присвоенное балансировщику нагрузки. |
| operating_status строка | успех | Рабочее состояние балансировщика нагрузки. |
| pools список | успех | Связанные идентификаторы пулов, если есть. |
| provisioning_status строка | успех | Статус подготовки балансировщика нагрузки. |
| vip_address строка | успех | IP-адрес виртуального IP балансировщика нагрузки. |
| vip_network_id строка | успех | Идентификатор сети, к которой относится порт виртуального IP балансировщика нагрузки. |
| vip_port_id строка | успех | Идентификатор порта виртуального IP балансировщика нагрузки. |
| vip_subnet_id строка | успех | Идентификатор подсети, к которой относится порт виртуального IP балансировщика нагрузки. |
Статус
- Не гарантируется обратная совместимость интерфейса модуля. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/os_loadbalancer_module.html
