Модуль f5networks.f5_modules.bigip_virtual_server — управление виртуальными серверами LTM на BIG-IP
Примечание
Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_virtual_server.
Добавлено в f5networks.f5_modules 1.0.0
Краткое описание
- Управление виртуальными серверами LTM в системе BIG-IP.
Параметры
Параметр | Комментарии |
|---|---|
address_translation boolean | Если установлено значение Если установлено значение Этот параметр полезен, когда система распределяет нагрузку между устройствами с одинаковым IP-адресом. При создании нового виртуального сервера значение по умолчанию — Варианты:
|
auto_last_hop string добавлено в f5networks.f5_modules 1.13.0 | Позволяет системе BIG-IP отслеживать MAC-адрес источника входящих соединений и отправлять ответный трафик из пулов на MAC-адрес источника независимо от таблицы маршрутизации. Варианты:
|
bypass_module_checks boolean добавлено в f5networks.f5_modules 1.3.0 | Отключает все встроенные проверки модуля, требующие обращений к устройству BIG-IP. Использование этого параметра сокращает количество REST-вызовов, выполняемых модулем. Компромисс заключается в том, что большинство параметров передаются без изменений, поэтому при их задании требуется особая осторожность. Окончательным источником истины для таких конфигураций является устройство; этот режим подходит для случаев, когда скорость важнее точности. Если задано значение Этот параметр можно использовать при создании ресурсов или обновлении существующих. Варианты:
|
check_profiles boolean добавлено в f5networks.f5_modules 1.2.0 | Указывает, следует ли проверять соответствие указанных пользователем профилей SSL клиента и сервера существующим профилям. Это полезно, когда одновременно добавляется большое количество профилей. Не рекомендуется для обычного использования. При наличии дублирующихся или ошибочных профилей BIG-IP выдаст ошибку. Варианты:
|
clone_pools list / elements=dictionary | Указывает пул или список пулов, которые виртуальный сервер использует для репликации трафика на стороне клиента или сервера. Обычно этот параметр используется для обнаружения вторжений. |
|
context string / обязательный |
Параметр context для пула клонирования, используемого для репликации трафика на стороне клиента или сервера. Варианты:
|
|
pool_name string / обязательный |
Имя пула, в который сервер реплицирует трафик. Можно использовать только пулы, созданные в разделе Common или в том же разделе, что и виртуальный сервер. На пул в разделе Common необходимо ссылаться, указывая полный путь, например |
default_persistence_profile string | Профиль по умолчанию, управляющий сохранением сеанса. Чтобы удалить существующий профиль сохранения сеанса по умолчанию, укажите пустое значение: Если |
description string | Описание виртуального сервера. |
destination псевдонимы: address, ip string | IP-адрес назначения виртуального сервера. Обязателен, если Если В качестве назначения также можно указать имя существующего виртуального адреса. |
disabled_vlans list / elements=string | Список VLAN, которые необходимо отключить. Если в VLAN не указан раздел, используется параметр Этот параметр взаимоисключающий с параметрами |
enabled_vlans list / elements=string | Список VLAN, которые необходимо включить. При использовании VLAN с именем Этот параметр взаимоисключающий с параметром |
fallback_persistence_profile string | Указывает профиль сохранения сеанса, который система должна использовать, если не удается использовать указанный профиль сохранения сеанса по умолчанию. Чтобы удалить существующий резервный профиль сохранения сеанса, укажите пустое значение: Если |
firewall_enforced_policy string | Применяет указанную политику AFM к виртуальному серверу в режиме принудительного применения. При создании нового виртуального сервера, если этот параметр не указан, принудительное применение политики отключено. |
firewall_staged_policy string | Применяет указанную политику AFM к виртуальному серверу в режиме принудительного применения. Промежуточная политика отображает результаты выполнения правил политики в журнале, не применяя сами правила к трафику. При создании нового виртуального сервера, если этот параметр не указан, промежуточная политика отключена. |
insert_metadata boolean | Если задано значение В настоящее время пользователи без прав администратора не могут задавать метаданные объекта, хотя могут создавать и изменять объекты виртуальных серверов. Установка для этого параметра значения Попытка изменить Варианты:
|
ip_intelligence_policy string | Указывает политику IP Intelligence, применяемую к виртуальному серверу. Для этого параметра требуется, чтобы был предоставлен действующий модуль безопасности BIG-IP, например ASM или AFM. |
ip_protocol string | Указывает имя сетевого протокола, который система будет использовать для направления трафика на этот виртуальный сервер. При создании нового виртуального сервера, если этот параметр не указан, используется значение по умолчанию Настройка Protocol недоступна, если для параметра Значение этого аргумента можно указать числом или одним из ограниченного набора именованных значений. Примеры см. в Список допустимых номеров IP-протоколов см. по адресу https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers. Если Варианты:
|
irules псевдонимы: all_rules list / elements=string | Указывает список правил, применяемых в порядке приоритета. Чтобы удалить существующие iRules, укажите одно пустое значение: Порядок указания iRules имеет значение, поэтому список с теми же элементами, но в другом порядке в playbook, приведет к изменениям на устройстве. Если |
mask string | Указывает маску сети адреса назначения. Этот параметр работает с адресами IPv4 и IPv6. Необязательный параметр, который можно указать при создании или обновлении виртуального сервера. Если Если указано назначение catchall (например, Если Если Если |
metadata any | Произвольные пары «ключ/значение», которые можно прикрепить к виртуальному серверу. Это полезно, когда требуется добавить к виртуальному серверу аннотацию о том, что им управляет Ansible. Имена ключей сохраняются как строки, включая имена, состоящие из чисел. Значения всех ключей сохраняются как строки, включая значения, состоящие из чисел. Данные сохраняются постоянно, а не временно. |
mirror boolean | Указывает, что система зеркально отражает соединения на каждом узле пары с резервированием. При создании нового виртуального сервера, если этот параметр не указан, используется значение по умолчанию Варианты:
|
name псевдонимы: vs string / обязательный | Имя виртуального сервера. |
partition string | Раздел устройства, в котором будут управляться ресурсы. По умолчанию: |
per_flow_request_access_policy string | Указывает политику доступа Per-Request для виртуального сервера. |
policies псевдонимы: all_policies list / elements=string | Указывает политики для виртуального сервера. Если |
pool string | Пул виртуального сервера по умолчанию. Чтобы удалить существующий пул, укажите пустое значение: При создании нового виртуального сервера, если Если |
port string | Порт виртуального сервера. Обязателен, если Если не требуется указывать конкретный порт, используйте значение Если Если В дополнение к номеру порта можно указать некоторые имена служб. Строку Строку Строку Строку Строку Строку Строку Строку Строку Строку Строку Строку |
port_translation boolean | Если задано значение Если задано значение При создании нового виртуального сервера значение по умолчанию — Варианты:
|
profiles псевдонимы: all_profiles any | Список профилей (HTTP, ClientSSL, ServerSSL и т. д.), применяемых к обеим сторонам соединения (клиентской и серверной). Чтобы применить профиль только к клиентской стороне соединения, укажите Чтобы применить профиль только к серверной стороне соединения, укажите Если Чтобы удалить профиль из списка профилей, активных в данный момент на виртуальном сервере, просто удалите его из списка Чтобы добавить профиль в список профилей, активных в данный момент на виртуальном сервере, просто добавьте его в список Профили важны. Модуль не сможет настроить BIG-IP, если вы перепутаете профили или попытаетесь задать IP-протокол, который не поддерживается текущими или новыми профилями. Если конфигурация неверна, этот модуль и BIG-IP сообщат об ошибке, например Если вы не уверены в правильных сочетаниях профилей, рекомендуем использовать BIG-IP, на котором можно внести изменения и проверить правильные сочетания. Чтобы использовать |
|
context string |
Сторона соединения, к которой следует применить профиль. Варианты:
|
|
name string |
Имя профиля. Это значение необходимо указать, если задан context. Если значение не указано, предполагается, что элемент профиля содержит только имя профиля. |
provider dictionary добавлено в f5networks.f5_modules 1.0.0 | Объект dict, содержащий сведения о подключении. |
|
auth_provider string |
Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ. |
|
no_f5_teem логический |
Если Эту опцию можно не указывать, задав переменную среды Ранее использовавшаяся переменная Варианты:
|
|
password псевдонимы: pass, pwd строка / обязательно |
Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Эту опцию можно не указывать, задав переменную среды |
|
server строка / обязательно |
Имя хоста BIG-IP или BIG-IQ. Эту опцию можно не указывать, задав переменную среды |
|
server_port целое число |
Порт сервера BIG-IP. Эту опцию можно не указывать, задав переменную среды По умолчанию: |
|
timeout целое число |
Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку. |
|
transport строка |
Настраивает транспортное подключение для связи с удаленным устройством. Варианты:
|
|
user строка / обязательно |
Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Эту опцию можно не указывать, задав переменную среды |
|
validate_certs логический |
Если Эту опцию можно не указывать, задав переменную среды Варианты:
|
rate_limit целое число | Ограничение скорости для виртуального сервера (количество подключений в секунду). Значение Допустимый диапазон значений: от |
rate_limit_dst_mask целое число | Задает маску в битах, применяемую к адресу назначения при ограничении скорости. Значение по умолчанию — Допустимый диапазон значений: от |
rate_limit_mode строка | Указывает, применяется ли ограничение скорости отдельно к виртуальному объекту, адресу источника, адресу назначения или к их комбинации. Значение по умолчанию — Варианты:
|
rate_limit_src_mask целое число | Задает маску в битах, применяемую к адресу источника при ограничении скорости. Значение по умолчанию — Допустимый диапазон значений: от |
security_log_profiles список / элементы=строка | Задает профиль ведения журнала, применяемый к виртуальному серверу. Для использования этой функции модуль AFM должен быть лицензирован и подготовлен. Параметры |
security_nat_policy словарь | Задает политики NAT брандмауэра для виртуального сервера. Можно указать одну или несколько политик NAT. Используется наиболее специфичная политика. Например, если указать для виртуального сервера политику устройства и политику домена маршрутизации, политика домена маршрутизации переопределит политику устройства. |
|
policy строка |
Задает политику NAT, применяемую непосредственно к виртуальному серверу. Политика NAT виртуального сервера является наиболее специфичной и переопределяет политику домена маршрутизации и устройства, если они заданы. Чтобы удалить политику, укажите пустую строку. |
|
use_device_policy логический |
Указывает, что виртуальный сервер использует политику NAT устройства, заданную в параметрах брандмауэра. Политика устройства используется, если не задана политика домена маршрутизации или настройка NAT виртуального сервера. Варианты:
|
|
use_route_domain_policy логический |
Указывает, что виртуальный сервер использует политику домена маршрутизации, заданную в параметрах безопасности домена маршрутизации. Если этот параметр указан, политика домена маршрутизации переопределяет политику устройства, но сама переопределяется политикой виртуального сервера. Варианты:
|
serverssl_use_sni логический | Если Если При создании виртуального сервера по умолчанию используется значение Варианты:
|
service_down_immediate_action строка добавлено в f5networks.f5_modules 1.16.0 | Задает немедленное действие при получении начального пакета SYN, если виртуальный сервер имеет статус доступности Offline или Unavailable. Поддерживается для виртуальных серверов с типом Варианты:
|
snat строка | Политика трансляции сетевого адреса источника. Если для Чтобы включить SNAT с определенным пулом, можно указать имя пула SNAT (например, «/Common/snat_pool_name»). Чтобы удалить SNAT, укажите слово Чтобы указать automap, используйте слово |
source строка | Задает IP-адрес или сеть, с которых виртуальный сервер принимает трафик. Виртуальный сервер принимает подключения только с одного из этих IP-адресов. Чтобы этот параметр работал эффективно, укажите значение, отличное от 0.0.0.0/0 или ::/0 (то есть any/0, any6/0). Для максимальной эффективности этого параметра укажите наиболее специфичные префиксы адресов, охватывающие все адреса клиентов и не содержащие другие адреса. Укажите IP-адрес в формате бесклассовой междоменной маршрутизации (CIDR): адрес/префикс, где длина префикса задается в битах. Например, для IPv4: 10.0.0.1/32 или 10.0.0.0/24, а для IPv6: ffe1::0020/64 или 2001:ed8:77b5:2:10:10:100:42/64. |
source_port строка | Указывает, сохраняет ли система исходный порт подключения. При создании виртуального сервера, если этот параметр не указан, по умолчанию используется значение Варианты:
|
state строка | Состояние виртуального сервера. Если Попытка изменить Варианты:
|
type строка | Задает сетевую службу, предоставляемую этим виртуальным сервером. При создании виртуального сервера, если этот параметр не указан, по умолчанию используется значение После установки это значение изменить нельзя. Если Если Если Если Если Если Если Если Если Если Варианты:
|
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диске, включите как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в документации модуля.
Примеры
- name: Modify Port of the Virtual Server
bigip_virtual_server:
state: present
partition: Common
name: my-virtual-server
port: 8080
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Delete virtual server
bigip_virtual_server:
state: absent
partition: Common
name: my-virtual-server
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add virtual server
bigip_virtual_server:
state: present
partition: Common
name: my-virtual-server
destination: 10.10.10.10
port: 443
pool: my-pool
snat: Automap
description: Test Virtual Server
profiles:
- http
- fix
- name: clientssl
context: server-side
- name: ilx
context: client-side
policies:
- my-ltm-policy-for-asm
- ltm-uri-policy
- ltm-policy-2
- ltm-policy-3
enabled_vlans:
- /Common/vlan2
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add FastL4 virtual server
bigip_virtual_server:
destination: 1.1.1.1
name: fastl4_vs
port: 80
profiles:
- fastL4
state: present
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add iRules to the Virtual Server
bigip_virtual_server:
name: my-virtual-server
irules:
- irule1
- irule2
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Remove one iRule from the Virtual Server
bigip_virtual_server:
name: my-virtual-server
irules:
- irule2
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Remove all iRules from the Virtual Server
bigip_virtual_server:
name: my-virtual-server
irules: ""
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Remove pool from the Virtual Server
bigip_virtual_server:
name: my-virtual-server
pool: ""
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add metadata to virtual
bigip_virtual_server:
name: my-virtual-server
partition: Common
metadata:
ansible: 2.4
updated_at: 2017-12-20T17:50:46Z
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add virtual with two profiles
bigip_virtual_server:
name: my-virtual-server
partition: Common
profiles:
- http
- tcp
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove HTTP profile from previous virtual
bigip_virtual_server:
name: my-virtual-server
partition: Common
profiles:
- tcp
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add the HTTP profile back to the previous virtual
bigip_virtual_server:
name: my-virtual-server
partition: Common
profiles:
- http
- tcp
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add virtual server with rate limit
bigip_virtual_server:
state: present
partition: Common
name: my-virtual-server
destination: 10.10.10.10
port: 443
pool: my-pool
snat: Automap
description: Test Virtual Server
profiles:
- http
- fix
- name: clientssl
context: server-side
- name: ilx
context: client-side
policies:
- my-ltm-policy-for-asm
- ltm-uri-policy
- ltm-policy-2
- ltm-policy-3
enabled_vlans:
- /Common/vlan2
rate_limit: 400
rate_limit_mode: destination
rate_limit_dst_mask: 32
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add FastL4 virtual server with clone_pools
bigip_virtual_server:
destination: 1.1.1.1
name: fastl4_vs
port: 80
profiles:
- fastL4
state: present
clone_pools:
- pool_name: FooPool
context: clientside
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Add virtual with MRF router option set
bigip_virtual_server:
name: my-virtual-server
destination: 10.10.10.10
port: 443
partition: Common
profiles:
- http
- tcp
- name: noneg-ssl
context: client-side
- name: http2
context: client-side
- name: httprouter
context: all
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
address_translation boolean | Новое значение, указывающее, включена или отключена трансляция адресов. Возвращается: при изменении Пример: |
auto_last_hop string | Задает значение autoLasthop виртуального сервера. Возвращается: при изменении Пример: |
clone_pools list / elements=string | Пулы, в которые виртуальный сервер копирует трафик. Возвращается: при изменении Пример: |
default_persistence_profile string | Профиль сохранения состояния по умолчанию, настроенный на виртуальном сервере. Возвращается: при изменении Пример: |
description string | Новое описание виртуального сервера. Возвращается: при изменении Пример: |
destination string | Назначение виртуального сервера. Возвращается: при изменении Пример: |
disabled boolean | Указывает, отключен ли виртуальный сервер. Возвращается: при изменении Пример: |
disabled_vlans list / elements=string | Список VLAN, для которых виртуальный сервер отключен. Возвращается: при изменении Пример: |
enabled boolean | Указывает, включен ли виртуальный сервер. Возвращается: при изменении Пример: |
enabled_vlans list / elements=string | Список VLAN, для которых виртуальный сервер включен. Возвращается: при изменении Пример: |
fallback_persistence_profile string | Резервный профиль сохранения состояния, настроенный на виртуальном сервере. Возвращается: при изменении Пример: |
firewall_enforced_policy string | Новая применяемая политика межсетевого экрана. Возвращается: при изменении Пример: |
firewall_staged_policy string | Новая тестовая политика межсетевого экрана. Возвращается: при изменении Пример: |
ip_intelligence_policy string | Новая политика IP Intelligence, назначенная виртуальному серверу. Возвращается: при изменении Пример: |
ip_protocol integer | Новое значение протокола IP. Возвращается: при изменении Пример: |
irules list / elements=string | iRules, настроенные на виртуальном сервере. Возвращается: при изменении Пример: |
metadata dictionary | Новое значение виртуального сервера. Возвращается: при изменении Пример: |
mirror boolean | Указывает, зеркалирует ли система соединения на каждом узле резервной пары. Возвращается: при изменении Пример: |
per_flow_request_access_policy string | Политика для каждого запроса, привязанная к виртуальному серверу. Возвращается: при изменении Пример: |
policies list / elements=string | Список политик, привязанных к виртуальному серверу. Возвращается: при изменении Пример: |
pool string | Пул, к которому привязан виртуальный сервер. Возвращается: при изменении Пример: |
port integer | Порт, на котором настроен прослушивающий режим виртуального сервера. Возвращается: при изменении Пример: |
port_translation boolean | Новое значение, указывающее, включена или отключена трансляция портов. Возвращается: при изменении Пример: |
profiles list / elements=string | Список профилей, настроенных на виртуальном сервере. Возвращается: при изменении Пример: |
rate_limit integer | Максимальное число соединений в секунду, разрешенное для виртуального сервера. Возвращается: при изменении Пример: |
rate_limit_dst_mask integer | Задает маску в битах, применяемую к адресу назначения при ограничении скорости. Возвращается: при изменении Пример: |
rate_limit_mode string | Задает тип ограничения скорости, используемый на виртуальном сервере. Возвращается: при изменении Пример: |
rate_limit_src_mask integer | Задает маску в битах, применяемую к адресу источника при ограничении скорости. Возвращается: при изменении Пример: |
security_log_profiles list / elements=string | Новый список профилей журналирования безопасности. Возвращается: при изменении Пример: |
serverssl_use_sni boolean | Указывает, включен или отключен SNI для SSL-соединения на стороне сервера. Возвращается: при изменении Пример: |
service_down_immediate_action string | Действие, выполняемое при получении начального SYN-пакета, если сервер находится в состоянии Offline или Unavailable. Возвращается: при изменении Пример: |
snat string | Настройка SNAT виртуального сервера. Возвращается: при изменении Пример: |
source string | Адрес источника, заданный для виртуального сервера в формате CIDR. Возвращается: при изменении Пример: |
source_port string | Указывает, сохраняет ли система исходный порт соединения. Возвращается: при изменении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_virtual_server_module.html