bigip_policy_rule – Управление правилами политики LTM на BIG-IP
Новая версия с 2.5.
Обзор
- Этот модуль будет управлять правилами политики LTM на BIG-IP.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- BIG-IP >= v12.1.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| actions список | Действия, которые должна выполнять политика. Доступные атрибуты различаются в зависимости от действия, однако для каждого действия необходимо указать type. Эти условия могут быть указаны в любом порядке. Несмотря на то, что это список, BIG-IP не рассматривает порядок их расположения как важный. | ||
| asm_policy строка | Политика ASM для включения. Этот параметр действителен только с типом enable. | ||
| location строка | Новый URL, для которого будет отправлен ответ перенаправления. Для этого поля можно использовать подстановку Tcl-команд. | ||
| pool строка | Пул, которому будет перенаправляться трафик. Этот параметр действителен только с типом forward. | ||
| type строка / обязательно |
| Тип действия. Это значение определяет, какие нижеперечисленные опции являются обязательными. Когда type имеет значение forward, будет ассоциирован данный pool, или virtual с этим правилом.Когда type имеет значение enable, будет ассоциирован данный asm_policy с этим правилом.Когда type имеет значение ignore, будут удалены все существующие действия из этого правила.Когда type имеет значение redirect, будет перенаправлен HTTP-запрос на другой URL. | |
| virtual строка | Виртуальный сервер, которому будет перенаправляться трафик. Этот параметр действителен только с типом forward. | ||
| conditions список | Список атрибутов, описывающих условие. См. подопции для получения подробной информации о построении каждой записи списка. Порядок этого списка важен, модуль будет поддерживать порядок при модификации задачи. Перечисленные ниже подопции не являются обязательными для всех типов условий, см. описание для получения более подробной информации. Эти условия могут быть указаны в любом порядке. Несмотря на то, что это список, BIG-IP не рассматривает порядок их расположения как важный. | ||
| host_begins_with_any строка | Список строк символов, с которых должен начинаться HTTP-заголовок Host. Этот параметр действителен только с типом http_host. | ||
| host_is_any строка | Список строк символов, которым должен соответствовать HTTP-заголовок Host. Этот параметр действителен только с типом http_host. | ||
| path_begins_with_any строка | Список строк символов, с которых должна начинаться HTTP-строка URI. Этот параметр действителен только с типом http_uri. | ||
| type строка / обязательно |
| Тип условия. Это значение определяет, какие нижеперечисленные опции являются обязательными. Когда type имеет значение http_uri, будет ассоциирован данный список path_begins_with_any строк, с которых должна начинаться HTTP-строка URI. Любой элемент списка обеспечит соответствие.Когда type имеет значение all_traffic, будут удалены все существующие условия из этого правила. | |
| description строка | Описание правила политики. | ||
| name строка / обязательно | Имя правила. | ||
| partition строка | По умолчанию: "Общее" | Раздел устройства для управления ресурсами. | |
| policy строка / обязательно | Имя политики, с которой вы хотите ассоциировать это правило. | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщик аутентификации для получения токенов аутентификации с удаленного устройства. Эта опция действительно используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить эту опцию, задав переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Можно опустить эту опцию, задав переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, гарантирует загрузку ключа на устройство. Когда absent, гарантирует удаление ключа с устройства. Если ключ в настоящее время используется, модуль не сможет удалить ключ. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks можно найти на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, убедитесь, что включён хотя бы один шаг, использующий модуль bigip_config для сохранения текущей конфигурации. См. документацию модуля для правильного использования модуля для сохранения рабочей конфигурации.
Примеры
- name: Create policies
bigip_policy:
name: Policy-Foo
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add a rule to the new policy
bigip_policy_rule:
policy: Policy-Foo
name: rule3
conditions:
- type: http_uri
path_begins_with_any: /ABC
actions:
- type: forward
pool: pool-svrs
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add multiple rules to the new policy
bigip_policy_rule:
policy: Policy-Foo
name: "{{ item.name }}"
conditions: "{{ item.conditions }}"
actions: "{{ item.actions }}"
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
loop:
- name: rule1
actions:
- type: forward
pool: pool-svrs
conditions:
- type: http_uri
path_starts_with: /euro
- name: rule2
actions:
- type: forward
pool: pool-svrs
conditions:
- type: http_uri
path_starts_with: /HomePage/
- name: Remove all rules and conditions from the rule
bigip_policy_rule:
policy: Policy-Foo
name: rule1
conditions:
- type: all_traffic
actions:
- type: ignore
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| actions сложное | изменённое | Новый список действий, применённых к правилу Пример: хеш/словарь значений | |
| pool строка | изменённое | Пул для перенаправления Пример: foo-pool | |
| type строка | изменённое | Тип действия Пример: forward | |
| conditions сложное | изменённое | Новый список условий, применённых к правилу. Пример: хеш/словарь значений | |
| path_begins_with_any список | изменённое | Список строк, с которых начинается URI. Пример: ['foo', 'bar'] | |
| type строка | изменённое | Тип условия. Пример: http_uri | |
| description строка | изменённое | Новое описание правила. Пример: Моё правило | |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается партнером 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.9/modules/bigip_policy_rule_module.html
