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

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

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

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address -		IP-адрес члена.
api_timeout целое число		Сколько времени слой сокетов должен ждать, прежде чем истечёт время ожидания для API-запросов. Если это опущено, в библиотеку запросов ничего не будет передано.
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 Cert, который может использоваться для проверки 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
name - / обязательно		Имя, которое должно быть присвоено члену.
pool - / обязательно		Имя или идентификатор пула, к которому принадлежит этот член.
protocol_port -	По умолчанию: 80	Номер порта протокола для члена.
region_name строка		Имя региона.
state -	Варианты: present ← absent	Должен ли ресурс присутствовать или отсутствовать.
subnet_id -		Идентификатор подсети, откуда доступна служба членов.
timeout целое число	По умолчанию: 180	Время, которое модуль должен ждать, пока балансировщик нагрузки не перейдёт в состояние ACTIVE.
validate_certs логическое значение	Варианты: нет ← да	Необходимо ли проверять SSL API-запросы. До 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.
- 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 строка		Имя участника. Пример: тест
	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.9/modules/os_member_module.html