bigip_policy_rule - Управление правилами политики LTM на BIG-IP
Новое в версии 2.5.
Обзор
- Этот модуль управляет правилами политики LTM на BIG-IP.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- BIG-IP >= v12.1.0
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| actions | Действия, которые вы хотите, чтобы выполняло правило политики. Доступные атрибуты различаются в зависимости от действия, однако для каждого действия требуется указать type. Эти условия могут быть указаны в любом порядке. Несмотря на то, что они представляют собой список, BIG-IP не рассматривает их порядок как что-то особенное. | ||
| type обязательно |
| Тип действия. Это значение определяет, какие параметры ниже являются обязательными. Когда type равен forward, будет ассоциировано заданное pool, или virtual с этим правилом.Когда type равен enable, будет ассоциировано заданное asm_policy с этим правилом.Когда type равен ignore, все существующие действия будут удалены из этого правила. | |
| pool | Пул, которому вы хотите направить трафик. Этот параметр допустим только для типа forward. | ||
| virtual | Виртуальный сервер, которому вы хотите направить трафик. Этот параметр допустим только для типа forward. | ||
| asm_policy | Политика ASM для включения. Этот параметр допустим только для типа enable. | ||
| conditions | Список атрибутов, описывающих условие. См. подпараметры для получения подробной информации о том, как построить каждую запись списка. Порядок этого списка важен, модуль будет гарантировать, что порядок сохраняется при изменении задания. Ниже перечисленные подпараметры не являются обязательными для всех типов условий, ознакомьтесь с описанием для получения дополнительных сведений. Эти условия могут быть указаны в любом порядке. Несмотря на то, что они представляют собой список, BIG-IP не рассматривает их порядок как что-то особенное. | ||
| type обязательно |
| Тип условия. Это значение определяет, какие параметры ниже являются обязательными. Когда type равен http_uri, будет связан список строк path_begins_with_any, с которыми должна начинаться строка HTTP URI. Любой элемент в списке обеспечит соответствие.Когда type равен all_traffic, будут удалены все существующие условия из этого правила. | |
| path_begins_with_any | Список строк символов, с которых должна начинаться строка HTTP URI. Этот параметр допустим только для типа http_uri. | ||
| description | Описание правила политики. | ||
| name обязательно | Имя правила. | ||
| partition | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| policy обязательно | Имя политики, с которой вы хотите ассоциировать это правило. | ||
| provider (добавлено в 2.5) | Объект словаря, содержащий сведения о подключении. | ||
| 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 обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| state |
| При значении present, гарантирует, что ключ загружен на устройство. При значении absent, гарантирует, что ключ удалён с устройства. Если ключ в настоящее время используется, модуль не сможет удалить ключ. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool (добавлено в 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: Create policies
bigip_policy:
name: Policy-Foo
state: present
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
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 }}"
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 confitions from the rule
bigip_policy_rule:
policy: Policy-Foo
name: rule1
conditions:
- type: all_traffic
actions:
- type: ignore
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| actions complex | изменённое | Новый список действий, применённых к правилу Пример: хеш/словарь значений | |
| type строка | изменённое | Тип действия Пример: forward | |
| pool строка | изменённое | Пул для forward Пример: foo-pool | |
| conditions complex | изменённое | Новый список условий, применённых к правилу. Пример: хеш/словарь значений | |
| type строка | изменённое | Тип условия. Пример: http_uri | |
| path_begins_with_any список | изменённое | Список строк, с которыми URI начинается. Пример: ['foo', 'bar'] | |
| description строка | изменённое | Новое описание правила. Пример: Моё правило | |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантирует обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество 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_policy_rule_module.html
