os_pool – Добавление/удаление пула в службе балансировки нагрузки из OpenStack Cloud

Новое в версии 2.7.

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

Описание

Добавление или удаление пула из службы балансировки нагрузки OpenStack.

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ожидать сокетная часть перед истечением срока ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests.
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 raw		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка добавлен в 2.3	Варианты: admin internal public ←	Тип URL-адреса конечной точки, который необходимо извлечь из каталога служб. псевдонимы: endpoint_type
lb_algorithm -	Варианты: LEAST_CONNECTIONS ROUND_ROBIN ← SOURCE_IP	Алгоритм балансировки нагрузки для пула.
listener -		Имя или идентификатор слушателя, к которому принадлежит этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener.
loadbalancer -		Имя или идентификатор балансировщика нагрузки, к которому принадлежит этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener.
name - / обязательно		Имя, которое должно быть задано пулу
protocol -	Варианты: HTTP ← HTTPS PROXY TCP UDP	Протокол для пула.
region_name строка		Название региона.
state -	Варианты: present ← absent	Ресурс должен быть присутствовать или отсутствовать.
timeout целое число	По умолчанию: 180	Время, в течение которого модуль должен ждать, пока пул не перейдет в состояние ACTIVE.
validate_certs булево	Варианты: no ← yes	Необходимо ли проверять запросы SSL API. До Ansible 2.3 это имело значение `yes`. псевдонимы: verify
wait булево	Варианты: no yes ←	Если модуль должен ждать, пока пул не станет 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 pool, wait for the pool to be active.
- os_pool:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-pool
    loadbalancer: test-loadbalancer
    protocol: HTTP
    lb_algorithm: ROUND_ROBIN

# Delete a pool
- os_pool:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-pool

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

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

Ключ		Возвращаемое значение	Описание
id строка		При успехе, когда state равен 'present'	UUID пула. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener сложный		При успехе, когда state равен 'present'	Словарь, описывающий пул.
	description строка		Описание пула. Пример: описание
	id строка		Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up логический		Административное состояние пула. Пример: True
	lb_algorithm строка		Алгоритм балансировки нагрузки для пула. Пример: ROUND_ROBIN
	listener_id строка		Идентификатор слушателя, к которому относится пул. Пример: 956aa716-9c2f-11e8-83b3-44a8422643a4
	listeners список		Список идентификаторов слушателей. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	loadbalancer_id строка		Идентификатор балансировщика нагрузки, к которому относится пул. Это поле устанавливается, когда пул не относится ни к одному слушателю в балансировщике нагрузки. Пример: 7c4be3f8-9c2f-11e8-83b3-44a8422643a4
	loadbalancers список		Список идентификаторов балансировщиков нагрузки. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	members список		Список идентификаторов членов. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	name строка		Имя, присвоенное пулу. Пример: test
	operating_status строка		Рабочее состояние пула. Пример: ONLINE
	protocol строка		Протокол для пула. Пример: HTTP
	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_pool_module.html