bigip_pool_member – Управляет участниками пула F5 BIG-IP LTM
Описание
- Управляет участниками пулов F5 BIG-IP LTM через iControl SOAP API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка добавлен в 2.2 | IP-адрес члена пула. Может быть IPv4 или IPv6. При создании нового члена пула необходимо указать address или fqdn. После установки этот параметр изменить нельзя.псевдонимы: ip, host | ||
| aggregate список добавлен в 2.8 | Список определений членов пула, которые должны быть созданы, изменены или удалены. псевдонимы: members | ||
| availability_requirements словарь добавлен в 2.8 | Указывает, если активировано более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы, чтобы соединение считалось доступным. Указание пустой строки удалит мониторы и вернёт к наследованию от пула (по умолчанию). Указание значения none полностью отключит мониторинг работоспособности для члена. | ||
| at_least целое число | Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешными, прежде чем соединение будет считаться активным. Этот параметр актуален только при использовании type at_least. Этот параметр будет проигнорирован, если используется тип all. | ||
| type строка |
| Тип правила мониторинга при указании monitors.При создании нового пула, если значение не указано, используется значение по умолчанию 'all'. | |
| connection_limit целое число | Предел подключений для члена пула. Установка значения 0 отключает ограничение. | ||
| description строка | Описание члена пула. | ||
| fqdn строка добавлен в 2.6 | Имя FQDN члена пула. Может быть любым именем, являющимся валидным именем DNS по RFC 1123. Поэтому, могут использоваться только символы "A" до "Z", "a" до "z", "0" до "9", дефис ("-") и точка (".") Имена FQDN должны содержать как минимум одну точку; отделяющую хост от домена. например: host.domain. Имена FQDN должны заканчиваться буквой или цифрой. При создании нового члена пула необходимо указать address или fqdn. После установки этот параметр изменить нельзя.псевдонимы: hostname | ||
| fqdn_auto_populate логическое значение добавлен в 2.6 |
| Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, возвращаемые в результате разрешения запроса DNS для узла, определённого FQDN. При yes, система генерирует временный узел для каждого IP-адреса, возвращаемого в ответ на запрос DNS для FQDN узла. Кроме того, когда ответ DNS указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел.При no, система разрешает запрос DNS для FQDN узла с единственным IP-адресом, связанным с FQDN.При создании нового члена пула значение по умолчанию для этого параметра yes.После установки этот параметр изменить нельзя. Этот параметр игнорируется, когда reuse_nodes равен yes. | |
| ip_encapsulation строка добавлен в 2.8 | Указывает инкапсуляцию IP, используя IPIP (инкапсуляция IP внутри IP, RFC 2003) или GRE (Generic Router Encapsulation, RFC 2784) для исходящих пакетов (от системы BIG-IP до сервера-члена пула). При none, отключает инкапсуляцию IP.При inherit, наследует настройку инкапсуляции IP от пула члена.При любом другом значении, Варианты: Нет, Наследовать от пула, Указанное для члена. | ||
| monitors список добавлен в 2.8 | Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга данного ресурса. | ||
| name строка добавлен в 2.6 | Имя узла для создания или повторного использования при создании нового члена пула. Этот параметр необязателен и, если не указан, имя узла будет создано автоматически на основе указанного address или fqdn. Состояние enabled является псевдонимом present. | ||
| partition строка | По умолчанию: "Общий" | Раздел для управления ресурсами. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| pool строка / обязательно | Имя пула. Пул должен существовать. | ||
| port целое число / обязательно | Порт члена пула. Это значение нельзя изменить после установки. | ||
| preserve_node логическое значение добавлен в 2.1 |
| Когда состояние absent, попытка удалить узел, на который ссылается член пула.Узел не будет удалён, если он всё ещё ссылается на другие члены пула. В этом случае модуль не выведет ошибку. Установка значения yes отключает это поведение. | |
| priority_group целое число добавлен в 2.5 | Указывает число, представляющее группу приоритетов для члена пула. При добавлении нового члена значение по умолчанию 0, означающее, что член не имеет приоритета. Для задания приоритета необходимо активировать использование группы приоритетов при создании нового пула или добавлении/удалении членов пула. После активации система распределяет трафик в соответствии с номером группы приоритетов, назначенным члену пула. Чем больше число, тем выше приоритет, так что член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1. | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключ, который необходимо использовать для проверки подлинности соединения с удалённым устройством. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, которые используют самозаверенные сертификаты.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| rate_limit целое число | Предел скорости для члена пула (соединения в секунду). Установка значения 0 отключает ограничение. | ||
| ratio целое число | Вес коэффициента члена пула. Допустимые значения находятся в диапазоне от 1 до 100. Новые члены пула, если не переопределены, по умолчанию имеют значение 1. | ||
| replace_all_with булево добавлен в 2.8 |
| Удаление членов, не определённых в параметре aggregate. Эта операция выполняется полностью или не выполняется, то есть она остановится, если некоторые члены пула не могут быть удалены. псевдонимы: purge | |
| reuse_nodes булево добавлен в 2.6 |
| Использует определения узлов, если запрошено. | |
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| state строка / обязательно |
| Состояние члена пула. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs булево добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, которые используют самозаверенные сертификаты.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP ≥ 12.
- Модули F5 работают только с текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, убедитесь, что в задаче используется модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Add pool member
bigip_pool_member:
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Modify pool member ratio and description
bigip_pool_member:
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
ratio: 1
description: nginx server
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove pool member from pool
bigip_pool_member:
state: absent
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Force pool member offline
bigip_pool_member:
state: forced_offline
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create members with priority groups
bigip_pool_member:
pool: my-pool
partition: Common
host: "{{ item.address }}"
name: "{{ item.name }}"
priority_group: "{{ item.priority_group }}"
port: 80
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
loop:
- address: 1.1.1.1
name: web1
priority_group: 4
- address: 2.2.2.2
name: web2
priority_group: 3
- address: 3.3.3.3
name: web3
priority_group: 2
- address: 4.4.4.4
name: web4
priority_group: 1
- name: Add pool members aggregate
bigip_pool_member:
pool: my-pool
aggregate:
- host: 192.168.1.1
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
- host: 192.168.1.2
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
- host: 192.168.1.3
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add pool members aggregate, remove non aggregates
bigip_pool_member:
pool: my-pool
aggregate:
- host: 192.168.1.1
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
- host: 192.168.1.2
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
- host: 192.168.1.3
partition: Common
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
replace_all_with: yes
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address строка | changed | Адрес члена пула. Пример: 1.2.3.4 |
| connection_limit целое число | changed | Новый предел подключений для члена пула Пример: 1000 |
| description строка | changed | Новое описание члена пула. Пример: Мой член пула |
| fqdn строка | changed | FQDN члена пула. Пример: foo.bar.com |
| fqdn_auto_populate булево | changed | Установлено ли автоматическое заполнение FQDN для члена или нет. Пример: True |
| monitors список | changed | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] |
| priority_group целое число | changed | Новая группа приоритетов. Пример: 3 |
| rate_limit целое число | changed | Новый предел скорости для члена пула в соединениях в секунду. Пример: 100 |
| ratio целое число | changed | Новый вес коэффициента члена пула. Пример: 50 |
| replace_all_with булево | changed | Очищает всех членов пула, не являющихся агрегированными, с устройства Пример: True |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/bigip_pool_member_module.html