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 и любую информацию о домене, если облако её поддерживает. Для других плагинов этот параметр должен содержать требуемые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения 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.
name - / обязательно		Имя, которое должно быть присвоено члену.
pool - / обязательно		Имя или идентификатор пула, к которому принадлежит этот член.
protocol_port -	Значение по умолчанию: 80	Номер порта протокола для члена.
region_name -		Имя региона.
state -	Варианты: present ← absent	Ресурс должен быть present или absent.
subnet_id -		Идентификатор подсети, из которой доступна служба члена.
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, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config

Примеры

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

Статус

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