f5networks.f5_modules.bigip_virtual_server модуль — Управление виртуальными серверами LTM на BIG-IP
Примечание
Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 / обязательно |
Параметр контекста для пула клона для репликации трафика со стороны клиента или сервера. Варианты:
|
|
pool_name string / обязательно |
Имя пула, в который сервер реплицирует трафик. Можно использовать только пулы, созданные в общем разделе или в том же разделе, что и виртуальный сервер. Ссылка на пул в общем разделе должна быть в полном формате пути, например, |
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-адресов, применяемую к виртуальному серверу. Для этого параметра требуется наличие настроенного модуля безопасности BIG-IP, например ASM или AFM. |
ip_protocol string | Указывает имя сетевого протокола, который система должна использовать для направления трафика на этот виртуальный сервер. При создании нового виртуального сервера, если этот параметр не указан, используется значение по умолчанию Настройка протокола недоступна, если в качестве Значение этого аргумента может быть указано либо в его числовом значении, либо в одном из нескольких именованных значений. См. Для получения списка допустимых номеров IP-протоколов см. https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers. Когда Варианты:
|
irules псевдонимы: all_rules list / элементы=string | Указывает список правил, которые будут применяться в порядке приоритета. Если вы хотите удалить существующие iRules, укажите одно пустое значение; Порядок, в котором указываются iRules, имеет значение, поэтому список, содержащий те же элементы списка, но в другом порядке в playbook, внесет изменения на устройстве. Когда |
mask string | Указывает сетевую маску целевого адреса. Этот параметр работает с IPv4 и IPv6 адресами. Это необязательный параметр, который можно указать при создании или обновлении виртуального сервера. Если Если вы укажете универсальный целевой адрес (например, Когда Когда Когда |
metadata any | Произвольные пары ключ/значение, которые можно прикрепить к виртуальному серверу. Это полезно в ситуациях, когда вы хотите аннотировать виртуальный сервер, управляемый Ansible. Имена ключей хранятся как строки; это включает в себя имена, которые являются числами. Значения для всех ключей хранятся как строки; это включает в себя значения, которые являются числами. Данные сохраняются постоянно, а не временно. |
mirror boolean | Указывает, что система дублирует соединения на каждом члене избыточной пары. При создании нового виртуального сервера, если этот параметр не указан, значение по умолчанию — Варианты:
|
name псевдонимы: vs string / обязательно | Имя виртуального сервера. |
partition string | Раздел устройства для управления ресурсами. По умолчанию: |
per_flow_request_access_policy string | Указывает политику доступа на каждый запрос для виртуального сервера. |
policies псевдонимы: all_policies list / элементы=string | Указывает политики для виртуального сервера. Когда |
pool string | Базовый пул для виртуального сервера. Если вы хотите удалить существующий пул, укажите пустое значение; При создании нового виртуального сервера и Если |
port string | Порт виртуального сервера. Требуется, когда Если вы не хотите указывать конкретный порт, используйте значение Когда Когда Помимо указания номера порта, можно также указать ряд имён служб. Строка Строка Строка Строка Строка Строка Строка Строка Строка Строка Строка Строка |
port_translation boolean | При При При создании нового виртуального сервера значение по умолчанию Варианты:
|
profiles aliases: all_profiles any | Список профилей (HTTP, ClientSSL, ServerSSL и т.д.) для применения к обеим сторонам соединения (сторона клиента и сервера). Если вы хотите применить определённый профиль только к стороне клиента соединения, укажите Если вы хотите применить определённый профиль только к стороне сервера соединения, укажите Если Чтобы удалить профиль из списка активных профилей виртуального сервера, просто удалите его из списка Чтобы добавить профиль в список активных профилей виртуального сервера, просто добавьте его в список Профили важны. Этот модуль не сможет настроить BIG-IP, если вы неправильно смешали профили или попытались установить протокол IP, который не поддерживают текущие или новые профили. И этот модуль, и BIG-IP сообщат об ошибке, если это не так, что-то вроде Если вы не уверены в правильных сочетаниях профилей, рекомендуется использовать доступный BIG-IP, в котором вы можете вносить изменения и копировать правильные сочетания. Чтобы использовать |
|
context string |
Сторона соединения, на которой должен быть применён профиль. Варианты:
|
|
name string |
Имя профиля. Это необходимо, если указан контекст. Если это не указано, предполагается, что элемент профиля — это только имя профиля. |
provider dictionary added in f5networks.f5_modules 1.0.0 | Объект типа dict, содержащий данные подключения. |
|
auth_provider string |
Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. |
|
no_f5_teem boolean |
Если Вы можете опустить этот параметр, установив переменную среды Предыдущая переменная Варианты:
|
|
password aliases: pass, pwd string / обязательно |
Пароль для учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды |
|
server string / обязательно |
Хост 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 словарь | Укажите политики Firewall NAT для виртуального сервера. Можно указать одну или несколько политик NAT. Используется наиболее конкретная политика. Например, если вы укажете, что виртуальный сервер должен использовать политику устройства и политику домена маршрутизации, политика домена маршрутизации переопределяет политику устройства. |
|
policy строка |
Указывает политику для непосредственного применения политики NAT к виртуальному серверу. Политика NAT виртуального сервера самая конкретная и переопределяет политику домена маршрутизации и политику устройства, если они указаны. Для удаления политики укажите пустое значение. |
|
use_device_policy булево |
Указывает, что виртуальный сервер использует политику NAT устройства, как указано в настройках параметров брандмауэра. Политика устройства используется, если не указаны политика домена маршрутизации или настройка NAT виртуального сервера. Варианты:
|
|
use_route_domain_policy булево |
Указывает, что виртуальный сервер использует политику домена маршрутизации, как указано в настройках безопасности домена маршрутизации. При указании политика домена маршрутизации переопределяет политику устройства и переопределяется политикой виртуального сервера. Варианты:
|
service_down_immediate_action строка добавлено в f5networks.f5_modules 1.16.0 | Указывает немедленное действие, которое следует предпринять при получении начального SYN-пакета, если состояние доступности виртуального сервера — «Офлайн» или «Недоступен». Поддерживается для виртуальных серверов с типом Варианты:
|
snat string | Политика адресов источника. Когда Можно указать имя пула SNAT (например, «/Common/snat_pool_name»), чтобы включить SNAT с использованием этого конкретного пула. Для удаления SNAT укажите слово Для указания автосопоставления используйте слово |
source string | Указывает IP-адрес или сеть, с которой виртуальный сервер принимает трафик. Виртуальный сервер принимает клиенты только с одного из этих IP-адресов. Для эффективной работы этого параметра укажите значение, отличное от 0.0.0.0/0 или ::/0 (то есть any/0, any6/0). Для максимальной эффективности укажите наиболее специфичные префиксы адресов, охватывающие все адреса клиентов и не включающие другие. Укажите IP-адрес в формате CIDR (Classless Inter-Domain Routing); адрес/префикс, где длина префикса в битах. Например, для 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 string | Указывает, сохраняется ли система исходного порта соединения. При создании нового виртуального сервера, если этот параметр не указан, значение по умолчанию — Выбор:
|
state string | Состояние виртуального сервера. Если Попытка изменить Выбор:
|
type string | Указывает сетевую услугу, предоставляемую этим виртуальным сервером. При создании нового виртуального сервера, если этот параметр не указан, по умолчанию используется Это значение нельзя изменить после установки. Когда Когда Когда Когда Когда Когда Когда Когда Когда Когда Когда Выбор:
|
Примечания
Примечание
- Дополнительную информацию об использовании 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 | Новое значение, указывающее, включена или выключена трансляция адресов. Возвращено: changed Пример: |
auto_last_hop string | Указывает значение autoLasthop виртуального сервера Возвращено: changed Пример: |
clone_pools list / elements=string | Пулы, в которые виртуальный сервер копирует трафик. Возвращено: changed Пример: |
default_persistence_profile string | Профиль постоянства по умолчанию, установленный на виртуальном сервере. Возвращено: changed Пример: |
description string | Новое описание виртуального сервера. Возвращено: changed Пример: |
destination string | Назначение виртуального сервера. Возвращено: changed Пример: |
disabled boolean | Отключен ли виртуальный сервер или нет. Возвращено: changed Пример: |
disabled_vlans list / elements=string | Список VLAN, для которых виртуальный сервер отключен. Возвращено: changed Пример: |
enabled boolean | Включен ли виртуальный сервер или нет. Возвращено: changed Пример: |
enabled_vlans list / elements=string | Список VLAN, для которых виртуальный сервер включен. Возвращено: changed Пример: |
fallback_persistence_profile string | Резервный профиль постоянства, установленный на виртуальном сервере. Возвращено: changed Пример: |
firewall_enforced_policy string | Новая политика брандмауэра, которая применяется. Возвращено: changed Пример: |
firewall_staged_policy string | Новая политика брандмауэра, которая находится в стадии подготовки. Возвращено: changed Пример: |
ip_intelligence_policy string | Новая политика IP Intelligence, назначенная виртуальному серверу. Возвращено: changed Пример: |
ip_protocol integer | Новое значение IP-протокола. Возвращено: changed Пример: |
irules list / elements=string | iRules, установленные на виртуальном сервере. Возвращено: changed Пример: |
metadata dictionary | Новое значение виртуального сервера. Возвращено: changed Пример: |
mirror boolean | Указывает, что система зеркалит соединения на каждом члене избыточной пары. Возвращено: changed Пример: |
per_flow_request_access_policy string | Политика на каждый запрос, прикрепленная к виртуальному серверу. Возвращено: changed Пример: |
policies list / elements=string | Список политик, прикрепленных к виртуальному серверу. Возвращено: changed Пример: |
pool string | Пул, к которому прикреплен виртуальный сервер. Возвращено: changed Пример: |
port integer | Порт, на котором настроен виртуальный сервер для прослушивания. Возвращено: changed Пример: |
port_translation boolean | Новое значение, указывающее, включена или выключена трансляция портов. Возвращено: changed Пример: |
profiles list / elements=string | Список профилей, установленных на виртуальном сервере. Возвращено: changed Пример: |
rate_limit integer | Максимальное количество соединений в секунду, разрешенных для виртуального сервера. Возвращено: changed Пример: |
rate_limit_dst_mask integer | Указывает маску, в битах, которая должна применяться к адресу назначения в рамках ограничения скорости. Возвращено: changed Пример: |
rate_limit_mode string | Устанавливает тип ограничения скорости, который будет использоваться на виртуальном сервере. Возвращено: changed Пример: |
rate_limit_src_mask integer | Указывает маску, в битах, которая должна применяться к адресу источника в рамках ограничения скорости. Возвращено: changed Пример: |
security_log_profiles list / elements=string | Новый список профилей журнала безопасности. Возвращено: changed Пример: |
service_down_immediate_action string | Действие, которое нужно предпринять при получении первого пакета SYN, если сервер находится в автономном режиме или недоступен. Возвращено: changed Пример: |
snat string | Настройка SNAT виртуального сервера. Возвращено: changed Пример: |
source string | Исходный адрес, установленный на виртуальном сервере, в формате CIDR. Возвращено: changed Пример: |
source_port string | Указывает, сохраняет ли система исходный порт соединения. Возвращено: changed Пример: |
Справочные ссылки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_virtual_server_module.html