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 строка / обязательно	Варианты: forward enable ignore redirect	Тип действия. Это значение определяет, какие нижеперечисленные опции обязательны. Когда `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 строка / обязательно	Варианты: http_uri all_traffic http_host	Тип условия. Это значение определяет, какие нижеперечисленные опции обязательны. Когда `type` равно `http_uri`, будет ассоциирован заданный список строк `path_begins_with_any`, с которыми должен начинаться HTTP URI. Любой элемент в списке обеспечит соответствие. Когда `type` равно `all_traffic`, все существующие условия будут удалены из этого правила.
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`.
	ssh_keyfile путь		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, задав переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, задав переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на управляемых вами сайтах с самозаверяющими сертификатами. Этот параметр можно опустить, задав переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Этот параметр можно опустить, задав переменную среды `F5_SERVER`.
server_port целое число добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, задав переменную среды `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует загрузку ключа на устройство. Когда `absent`, гарантирует удаление ключа с устройства. Если ключ используется в настоящее время, модуль не сможет удалить ключ.

пользователь строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs булево добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включён хотя бы один task, использующий модуль 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 строка	изменено	Тип действия Пример: перенаправление
conditions сложное		изменено	Новый список условий, применённых к правилу. Пример: словарь значений
	path_begins_with_any список	изменено	Список строк, с которыми URI начинается. Пример: ['foo', 'bar']
	type строка	изменено	Тип условия. Пример: http_uri
описание строка		изменено	Новое описание правила. Пример: Моё правило

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром 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.8/modules/bigip_policy_rule_module.html