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

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

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

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должен ждать уровень сокетов, прежде чем истечет время ожидания для вызовов API. Если это значение опущено, оно не будет передано в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля пароль, он будет содержать auth_url, username, password, project_name и любые сведения о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые параметры, необходимые этому подключаемому модулю авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя подключаемого модуля авторизации для использования. Если облако использует что-либо помимо аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Игнорируется. Наличие для обратной совместимости
ca_cert строка		Путь к набору сертификатов CA, который можно использовать для проверки запросов SSL API. алиасы: cacert
client_cert строка		Путь к клиенту сертификат для использования в рамках SSL-транзакции. алиасы: cert
client_key строка		Путь к клиенту ключ для использования в рамках SSL-транзакции. алиасы: key
cloud сырой		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка	Варианты: 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	Нужно ли проверять запросы API SSL. До 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 строка		Описание пула. Пример: 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.9/modules/os_pool_module.html