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

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

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

Обзор

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

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address -		IP-адрес члена.
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 сырые данные		Именованное облако или конфигурация облака для работы с ним. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или присутствуют переменные среды OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в секции clouds.yaml.
interface строка добавлен в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
name - / требуется		Имя, которое должно быть присвоено члену.
pool - / требуется		Имя или идентификатор пула, к которому принадлежит этот член.
protocol_port -	По умолчанию: 80	Номер порта протокола для члена.
region_name строка		Имя региона.
state -	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
subnet_id -		Идентификатор подсети, из которой доступен сервис члена.
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 member, wait for the member to be created.
- os_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
- os_member:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-member
    pool: test-pool

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

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

Ключ		Возвращаемое значение	Описание
id строка		При успехе, когда состояние равно 'present'	Уникальный идентификатор (UUID) члена. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
member сложный тип		При успехе, когда состояние равно '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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом 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_member_module.html