bigip_policy_rule – Управление правилами политик LTM на BIG-IP

Новая версия с 2.5.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Этот модуль будет управлять правилами политик LTM на BIG-IP.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

BIG-IP >= v12.1.0
f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
actions -			Действия, которые должен выполнить правило политики. Доступные атрибуты зависят от действия, однако каждое действие требует указания `type`. Эти условия могут быть указаны в любом порядке. Несмотря на то, что они представлены списком, BIG-IP не рассматривает их порядок как значимый.
	asm_policy -		Политика ASM для включения. Этот параметр действителен только для типа `enable`.
	pool -		Пул, в который нужно перенаправлять трафик. Этот параметр действителен только для типа `forward`.
	type - / обязательно	Варианты: forward enable ignore	Тип действия. Это значение определяет, какие нижеперечисленные параметры обязательны. Когда `type` равно `forward`, будет ассоциирована заданная `pool`, или `virtual` с этим правилом. Когда `type` равно `enable`, будет ассоциирована заданная `asm_policy` с этим правилом. Когда `type` равно `ignore`, все существующие действия из этого правила будут удалены.
	virtual -		Виртуальный сервер, на который нужно перенаправлять трафик. Этот параметр действителен только для типа `forward`.
conditions -			Список атрибутов, описывающих условие. См. подпараметры для получения подробностей о построении каждой записи списка. Порядок этого списка важен; модуль обеспечит сохранение порядка при модификации задачи. Нижеперечисленные подпараметры не требуются для всех типов условий; см. описание для получения подробностей. Эти условия могут быть указаны в любом порядке. Несмотря на то, что они представлены списком, BIG-IP не рассматривает их порядок как значимый.
	path_begins_with_any -		Список строк символов, с которых должен начинаться HTTP URI. Этот параметр действителен только для типа `http_uri`.
	type - / обязательно	Варианты: http_uri all_traffic	Тип условия. Это значение определяет, какие нижеперечисленные параметры обязательны. Когда `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		Значение по умолчанию: null	Объект словаря, содержащий данные подключения.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: 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`, гарантирует, что ключ удалён с устройства. Если ключ используется в настоящий момент, модуль не сможет удалить ключ.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
На хосте требуется пакет f5-sdk Python. Это так же просто, как pip install f5-sdk.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- 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 сложное		changed	Новый список действий, примененных к правилу Пример: хеш/словарь значений
	pool строка	changed	Пул для переадресации Пример: foo-pool
	type строка	changed	Тип действия Пример: forward
conditions сложное		changed	Новый список условий, примененных к правилу. Пример: хеш/словарь значений
	path_begins_with_any список	changed	Список строк, с которых начинается URI. Пример: ['foo', 'bar']
	type строка	changed	Тип условия. Пример: http_uri
description строка		changed	Новое описание правила. Пример: Моё правило

Статус

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