bigip_virtual_server - Управление виртуальными серверами LTM на BIG-IP
Новая версия 2.1.
Обзор
- Управление виртуальными серверами LTM на BIG-IP.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
- netaddr
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| default_persistence_profile | Профиль по умолчанию, управляющий сохранением сессии. Если вы хотите удалить существующий профиль сохранения по умолчанию, укажите пустое значение; "". См. документацию для примера. | ||
| description | Описание виртуального сервера. | ||
| destination обязательно | IP-адрес назначения виртуального сервера. Обязательно, когда state является present и виртуальный сервер не существует.псевдонимы: address, ip | ||
| disabled_vlans (добавлено в 2.5) | Список VLAN, которые необходимо отключить. Если сегмент не указан в VLAN, тогда используется опция partition этого модуля.Этот параметр взаимоисключающий с параметрами enabled_vlans. | ||
| enabled_vlans (добавлено в 2.2) | Список VLAN, которые необходимо включить. При использовании VLAN с именем all, разрешаются все VLAN. VLAN могут быть указаны с или без ведущего сегмента. Если сегмент не указан в VLAN, тогда используется опция partition этого модуля.Этот параметр взаимоисключающий с параметром disabled_vlans. | ||
| fallback_persistence_profile (добавлено в 2.3) | Указывает профиль сохранения, который система должна использовать, если не может использовать указанный профиль сохранения по умолчанию. Если вы хотите удалить существующий резервный профиль сохранения, укажите пустое значение; "". См. документацию для примера. | ||
| irules (добавлено в 2.2) | Список правил, которые должны быть применены в порядке приоритета. Если вы хотите удалить существующие правила iRules, укажите единственное пустое значение; "". См. документацию для примера.псевдонимы: all_rules | ||
| metadata (добавлено в 2.5) | Произвольные пары ключ/значение, которые вы можете добавить к пулу. Это полезно в ситуациях, когда вам нужно добавить аннотацию к виртуальному серверу, управляемому Ansible. Имена ключей будут храниться как строки; это включает имена, которые являются числами. Значения для всех ключей будут храниться как строки; это включает значения, которые являются числами. Данные будут сохраняться, а не временными. | ||
| name обязательно | Имя виртуального сервера. псевдонимы: vs | ||
| partition (добавлено в 2.5) | По умолчанию: Common | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| policies | Указывает политики для виртуального сервера псевдонимы: all_policies | ||
| pool | Пул по умолчанию для виртуального сервера. Если вы хотите удалить существующий пул, укажите пустое значение; "". См. документацию для примера. | ||
| port | Порт виртуального сервера. Требуется, когда state равно present и виртуальный сервер не существует.Если вы не хотите указывать конкретный порт, используйте значение 0. Результатом будет то, что виртуальный сервер будет слушать на любом порте. | ||
| profiles | Список профилей (HTTP, ClientSSL, ServerSSL и т.д.) для применения к обеим сторонам соединения (сторона клиента и сервера). Если вы хотите применить определенный профиль только к стороне клиента соединения, укажите client-side для context профиля.Если вы хотите применить определенный профиль только к стороне сервера соединения, укажите server-side для context профиля.Если context не указано, по умолчанию используется all. псевдонимы: all_profiles | ||
| name | Имя профиля. Если это не указано, предполагается, что элемент профиля — это только имя профиля. Это должно быть указано, если указан контекст. | ||
| context |
| Сторона соединения, на которой должен применяться профиль. | |
| provider (добавлено в 2.5) | По умолчанию: None | Объект словаря, содержащий сведения о подключении. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| snat |
| Политика адреса источника сети. | |
| source (добавлено в 2.5) | Указывает IP-адрес или сеть, из которой виртуальный сервер принимает трафик. Виртуальный сервер принимает клиентов только с одного из этих IP-адресов. Для эффективной работы этого параметра укажите значение, отличное от 0.0.0.0/0 или ::/0 (то есть любой/0, любой6/0). Для максимальной полезности этого параметра, укажите наиболее точные префиксы адресов, охватывающие все клиентские адреса и не другие. Укажите IP-адрес в формате CIDR; address/prefix, где длина префикса в битах. Например, для IPv4, 10.0.0.1/32 или 10.0.0.0/24, а для IPv6, ffe1::0020/64 или 2001:ed8:77b5:2:10:10:100:42/64. | ||
| state |
| Состояние виртуального сервера. Если absent, удалить виртуальный сервер, если он существует. present создаёт виртуальный сервер и включает его. Если enabled, включить виртуальный сервер, если он существует. Если disabled, создать виртуальный сервер при необходимости и установить состояние на disabled. | |
| Пользователь обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER задана. | ||
| validate_certs (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, управляемых лично, с использованием самозаверяющих сертификатов. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS задана. | |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 11
- Требуется пакет netaddr Python на хосте. Это так же просто, как pip install netaddr.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Modify Port of the Virtual Server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
state: present
partition: Common
name: my-virtual-server
port: 8080
delegate_to: localhost
- name: Delete virtual server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
state: absent
partition: Common
name: my-virtual-server
delegate_to: localhost
- name: Add virtual server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
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
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
- name: Add iRules to the Virtual Server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
name: my-virtual-server
irules:
- irule1
- irule2
delegate_to: localhost
- name: Remove one iRule from the Virtual Server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
name: my-virtual-server
irules:
- irule2
delegate_to: localhost
- name: Remove all iRules from the Virtual Server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
name: my-virtual-server
irules: ""
delegate_to: localhost
- name: Remove pool from the Virtual Server
bigip_virtual_server:
server: lb.mydomain.net
user: admin
password: secret
name: my-virtual-server
pool: ""
delegate_to: localhost
- name: Add metadata to virtual
bigip_pool:
server: lb.mydomain.com
user: admin
password: secret
state: absent
name: my-pool
partition: Common
metadata:
ansible: 2.4
updated_at: 2017-12-20T17:50:46Z
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| default_persistence_profile строка | изменено | Профиль персистентности по умолчанию, установленный на виртуальном сервере. Пример: /Common/dest_addr |
| description строка | изменено | Новое описание виртуального сервера. Пример: Это моё описание |
| destination строка | изменено | Цель виртуального сервера. Пример: 1.1.1.1 |
| disabled логическое значение | изменено | Отключён ли виртуальный сервер или нет. Пример: True |
| disabled_vlans список | изменено | Список VLAN, для которых виртуальный сервер отключён. Пример: ['/Common/vlan1', '/Common/vlan2'] |
| enabled логическое значение | изменено | Включён ли виртуальный сервер или нет. |
| enabled_vlans список | изменено | Список VLAN, для которых виртуальный сервер включён. Пример: ['/Common/vlan5', '/Common/vlan6'] |
| fallback_persistence_profile строка | изменено | Профиль персистентности по умолчанию, установленный на виртуальном сервере. Пример: /Common/source_addr |
| irules список | изменено | iRules, установленные на виртуальном сервере. Пример: ['/Common/irule1', '/Common/irule2'] |
| metadata словарь | изменено | Новое значение виртуального сервера. Пример: {'key2': 'bar', 'key1': 'foo'} |
| policies список | изменено | Список политик, прикреплённых к виртуальному серверу. Пример: ['/Common/policy1', '/Common/policy2'] |
| pool строка | изменено | Пул, к которому прикреплён виртуальный сервер. Пример: /Common/my-pool |
| port целое число | изменено | Порт, на котором виртуальный сервер настроен для прослушивания. Пример: 80 |
| profiles список | изменено | Список профилей, установленных на виртуальном сервере. Пример: [{'name': 'tcp', 'context': 'server-side'}, {'name': 'tcp-legacy', 'context': 'client-side'}] |
| snat строка | изменено | Настройка SNAT виртуального сервера. Пример: Automap |
| source строка | изменено | Исходный адрес в формате CIDR, установленный на виртуальном сервере. Пример: 1.2.3.4/32 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Автор
- 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.5/modules/bigip_virtual_server_module.html