bigip_pool_member - Управляет членами пула F5 BIG-IP LTM
Новая версия с 1.4.
Обзор
- Управляет членами пула F5 BIG-IP LTM через iControl SOAP API.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address (добавлено в 2.2) | IP-адрес члена пула. Может быть IPv4 или IPv6. При создании нового члена пула необходимо указать либо address, либо fqdn. Этот параметр нельзя изменить после его установки.Псевдонимы: ip, host | ||
| connection_limit | Предел подключений для члена пула. Установка значения 0 отключает ограничение. | ||
| description | Описание члена пула. | ||
| fqdn (добавлено в 2.6) | FQDN-имя члена пула. Может быть любым именем, соответствующим требованиям RFC 1123 для DNS-имен. Допускаются символы от "A" до "Z", от "a" до "z", от "0" до "9", дефис ("-") и точка (".") . FQDN-имена должны содержать хотя бы одну точку; отделяя имя хоста от домена. Например: host.domain.FQDN-имена должны заканчиваться буквой или цифрой. При создании нового члена пула необходимо указать либо address, либо fqdn. Этот параметр нельзя изменить после его установки.Псевдонимы: hostname | ||
| fqdn_auto_populate bool (добавлено в 2.6) |
| Определяет, автоматически ли система создает временные узлы, используя IP-адреса, возвращённые в результате разрешения DNS-запроса для узла, определённого FQDN. Если enabled, система генерирует временный узел для каждого IP-адреса, возвращенного в ответе на DNS-запрос для FQDN узла. Кроме того, когда DNS-ответ указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел.Если disabled, система разрешает DNS-запрос для FQDN узла с единственным IP-адресом, связанным с FQDN.При создании нового члена пула значение по умолчанию для этого параметра равно yes.Этот параметр игнорируется, когда reuse_nodes имеет значение yes. | |
| monitor_state (добавлено в 2.0) |
| Устанавливает состояние доступности мониторинга для члена пула. Этот параметр устарел и будет удален в Ansible 2.7. Используйте state enabled или disabled. | |
| name (добавлено в 2.6) | Имя узла для создания или повторного использования при создании нового члена пула. Этот параметр необязателен и, если он не указан, имя узла будет создано автоматически из указанного address или fqdn. | ||
| partition | Значение по умолчанию: "Common" | Раздел | |
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная среды F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| pool обязательно | Имя пула. Этот пул должен существовать. | ||
| port обязательно | Порт члена пула. Это значение нельзя изменить после его установки. | ||
| preserve_node bool (добавлено в 2.1) |
| Когда состояние равно absent, попытка удалить узел, на который ссылается член пула.Узел не будет удален, если он по-прежнему ссылается на другие члены пула. В этом случае модуль не выдаст ошибку. Установка значения yes отключает это поведение. | |
| priority_group (добавлено в 2.5) | Указывает число, представляющее группу приоритетов для члена пула. При добавлении нового члена значение по умолчанию равно 0, что означает отсутствие приоритета. Для указания приоритета необходимо активировать использование группы приоритетов при создании нового пула или при добавлении или удалении членов пула. При активации система распределяет трафик в соответствии с номером группы приоритета, назначенной члену пула. Чем больше число, тем выше приоритет, поэтому член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1. | ||
| provider (добавлено в 2.5) | Объект типа dict, содержащий данные подключения. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная среды F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER установлена. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная среды F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Этот параметр можно опустить, если переменная среды F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| rate_limit | Ограничение скорости члена пула (подключений в секунду). Установка значения 0 отключает ограничение. | ||
| ratio | Вес коэффициента распределения для члена пула. Допустимые значения от 1 до 100. Новые члены пула (если не переопределено) по умолчанию имеют значение 1. | ||
| reuse_nodes bool (добавлено в 2.6) |
| Использует предварительно определённые узлы если запрошено. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER_PORT установлена. | |
| session_state (добавлено в 2.0) |
| Устанавливает состояние новых сессий для члена пула. Этот параметр устарел и будет удален в Ansible 2.7. Используйте state enabled или disabled. | |
| state обязательно |
| Состояние члена пула. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная среды F5_USER установлена. | ||
| validate_certs bool (added in 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте это только на сайтах, контролируемых вами лично, с использованием самозаверенных сертификатов. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Add pool member
bigip_pool_member:
server: lb.mydomain.com
user: admin
password: secret
state: present
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
description: web server
connection_limit: 100
rate_limit: 50
ratio: 2
delegate_to: localhost
- name: Modify pool member ratio and description
bigip_pool_member:
server: lb.mydomain.com
user: admin
password: secret
state: present
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
ratio: 1
description: nginx server
delegate_to: localhost
- name: Remove pool member from pool
bigip_pool_member:
server: lb.mydomain.com
user: admin
password: secret
state: absent
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
delegate_to: localhost
- name: Force pool member offline
bigip_pool_member:
server: lb.mydomain.com
user: admin
password: secret
state: forced_offline
pool: my-pool
partition: Common
host: "{{ ansible_default_ipv4['address'] }}"
port: 80
delegate_to: localhost
- name: Create members with priority groups
bigip_pool_member:
server: lb.mydomain.com
user: admin
password: secret
pool: my-pool
partition: Common
host: "{{ item.address }}"
name: "{{ item.name }}"
priority_group: "{{ item.priority_group }}"
port: 80
delegate_to: localhost
loop:
- host: 1.1.1.1
name: web1
priority_group: 4
- host: 2.2.2.2
name: web2
priority_group: 3
- host: 3.3.3.3
name: web3
priority_group: 2
- host: 4.4.4.4
name: web4
priority_group: 1
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address string | changed | Адрес члена пула. Пример: 1.2.3.4 |
| connection_limit int | changed | Новый лимит подключений для члена пула Пример: 1000 |
| description string | changed | Новое описание члена пула. Пример: Мой член пула |
| fqdn string | changed | FQDN члена пула. Пример: foo.bar.com |
| fqdn_auto_populate bool | changed | Была ли включена автоматическая генерация FQDN для члена или нет. Пример: True |
| priority_group int | changed | Новая группа приоритетов. Пример: 3 |
| rate_limit int | changed | Новый лимит скорости, в подключениях в секунду, для члена пула. Пример: 100 |
| ratio int | changed | Новый весовой коэффициент члена пула. Пример: 50 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительная информация см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_pool_member_module.html