os_pool – Добавление/удаление пула в службе балансировки нагрузки из 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 Cert, которая может использоваться для проверки запросов API SSL.
cert -		Путь к клиенту сертификату для использования в рамках SSL-транзакции.
cloud -		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface - добавлен в 2.3	Варианты: public ← internal admin	Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
key -		Путь к клиентскому ключу для использования в рамках SSL-транзакции.
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.
verify boolean	Варианты: no yes	Нужно ли проверять запросы API SSL. До версии 2.3 это значение по умолчанию было True. псевдонимы: validate_certs
wait boolean	Варианты: no yes ←	Должен ли модуль ожидать, пока пул не станет ACTIVE.

Примечания

Примечание

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

Примеры

# 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 строка		При успехе, когда состояние равно 'present'	UUID пула. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener сложный тип		При успехе, когда состояние равно '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.7/modules/os_pool_module.html