openstack.cloud.os_member – Добавление/удаление члена пула в балансировщике нагрузки из OpenStack Cloud

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в плейбуке укажите: openstack.cloud.os_member.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address строка		IP-адрес члена.
api_timeout целое число		Сколько времени должен ждать уровень сокетов перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или 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 сырой		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога службы. псевдонимы: endpoint_type
name строка / обязательно		Имя, которое должно быть присвоено члену
pool строка / обязательно		Имя или идентификатор пула, к которому принадлежит этот член.
protocol_port целое число	Значение по умолчанию: 80	Номер порта протокола для члена.
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Ресурс должен присутствовать или отсутствовать.
subnet_id строка		Идентификатор подсети, из которой доступна служба члена.
timeout целое число	Значение по умолчанию: 180	Количество времени, которое модуль должен ждать, пока балансировщик нагрузки не перейдет в состояние ACTIVE.
validate_certs логическое значение	Варианты: нет ← да	Требуется ли проверка запросов API SSL. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
wait логическое значение	Варианты: нет да ←	Если модуль должен ждать, пока балансировщик нагрузки не станет 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 member, wait for the member to be created.
- openstack.cloud.lb_member:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-member
    pool: test-pool
    address: 192.168.10.3
    protocol_port: 8080

# Delete a listener
- openstack.cloud.lb_member:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-member
    pool: test-pool

Значения возврата

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

Ключ		Возвращаемое значение	Описание
id строка		При успехе, когда state равен 'present'	UUID члена. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
member сложный тип		При успехе, когда state равен 'present'	Словарь, описывающий члена.
	address строка	успех	IP-адрес сервера-члена бэкенда. Пример: 192.168.2.10
	description строка	успех	Описание члена. Пример: описание
	id строка	успех	Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up логическое значение	успех	Административное состояние члена. Пример: True
	name строка	успех	Присвоенное имя члену. Пример: test
	operating_status строка	успех	Рабочее состояние члена. Пример: ONLINE
	protocol_port целое число	успех	Номер порта протокола для члена. Пример: 80
	provisioning_status строка	успех	Статус подготовки члена. Пример: ACTIVE
	subnet_id строка	успех	Идентификатор подсети, из которой доступна служба члена. Пример: 489247fa-9c25-11e8-9679-00224d6b7bc1

Авторы

OpenStack Ansible SIG

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