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` — `forward`.
	type обязательно	Варианты: forward enable ignore	Тип действия. Это значение управляет тем, какие параметры ниже являются обязательными. Когда `type` равен `forward`, будет связано заданное `pool` с этим правилом. Когда `type` равен `enable`, будет связано заданное `asm_policy` с этим правилом. Когда `type` равен `ignore`, будут удалены все существующие действия из этого правила.
	asm_policy		Политика ASM для включения. Этот параметр действителен только для типа `enable`.
	pool		Пул, в который вы хотите направить трафик. Этот параметр действителен только для типа `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)		По умолчанию: 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 yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, которые используют самозаверяющие сертификаты. Этот параметр можно опустить, если переменная окружения `F5_VALIDATE_CERTS` установлена.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
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 (добавлено в 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.

Примеры

- 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

- name: Add multiple rules to the new policy
  bigip_policy_rule:
    policy: Policy-Foo
    name: "{{ item.name }}"
    conditions: "{{ item.conditions }}"
    actions: "{{ item.actions }}"
  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

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие — поля, уникальные для этого модуля:

Ключ		Возвращаемое значение	Описание
действия сложный		изменённое	Новый список действий, применённых к правилу Пример: словарь значений
	тип строка	изменённое	Тип действия Пример: forward
	пул строка	изменённое	Пул для перенаправления Пример: foo-pool
условия сложный		изменённое	Новый список условий, применённых к правилу. Пример: словарь значений
	path_begins_with_any список	изменённое	Список строк, с которыми URI начинается. Пример: ['foo', 'bar']
	тип строка	изменённое	Тип условия Пример: http_uri
описание строка		изменённое	Новое описание правила. Пример: Моё правило

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

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_policy_rule_module.html