f5networks.f5_modules.bigip_policy – Управление общей конфигурацией политики на BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_policy.

Новое в версии 1.0.0: of f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет общей конфигурацией политики на BIG-IP. Этот модуль лучше всего использовать совместно с модулем bigip_policy_rule. Этот модуль может обрабатывать общую конфигурацию, например, установку состояния черновика политики, описание и элементы, не связанные с самими правилами политики. Это также первый модуль, который следует использовать при создании правил, так как модуль bigip_policy_rule требует параметр политики.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание, которое нужно прикрепить к политике. Этот параметр поддерживается только на версиях BIG-IP >= 12.1.0. В более ранних версиях он просто игнорируется.
name строка / обязательный			Имя создаваемой политики.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 of f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются на F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательный		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение, которое будет использоваться при подключении к удаленному устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
rules список / элементы=строка			Указывает список правил, которые вы хотите связать с этой политикой. Порядок в этом списке — порядок их оценки BIG-IP. Если указанные правила не существуют (например, при создании новой политики), они будут созданы. Значения по умолчанию для правила по умолчанию — `all`. Значения по умолчанию для правила по умолчанию — `ignore`. Модуль `bigip_policy_rule` можно использовать для создания и изменения существующих и новых правил.
state строка		Варианты: present ← absent draft	Когда `state` равен `present`, гарантирует, что политика существует и опубликована. Когда `state` равен `absent`, гарантирует удаление политики, даже если она сейчас в состоянии черновика. Когда `state` равен `draft`, гарантирует, что политика существует и находится в состоянии черновика. При изменении правил необходимо, чтобы политики сначала были в состоянии черновика. Создание черновика поддерживается только в версиях BIG-IP >= 12.1.0. В версиях до этого указание `state` в состоянии `draft` приведет к ошибке.
strategy строка		Варианты: first all best	Указывает метод определения, какие действия выполняются, когда существует несколько правил, которые соответствуют. При создании новых политик значение по умолчанию — `first`. В этом модуле вы не можете указать используемую стратегию `best`. Вместо этого будет выбран системный параметр по умолчанию (`/Common/best-match`).

Примечания

Примечание

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

Примеры

- name: Create policy which is immediately published
  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 - Immediately published
  bigip_policy_rule:
    policy: Policy-Foo
    name: ABC
    conditions:
      - type: http_uri
        path_starts_with:
          - /ABC
          - foo
          - bar
        path_ends_with:
          - baz
    actions:
      - forward: yes
        select: yes
        pool: pool-svrs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add multiple rules to the new policy - Added in the order they are specified
  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: HomePage
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_starts_with: /HomePage/

- name: Create policy specify default rules - Immediately published
  bigip_policy:
    name: Policy-Bar
    state: present
    rules:
      - rule1
      - rule2
      - rule3
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create policy specify default rules - Left in a draft
  bigip_policy:
    name: Policy-Baz
    state: draft
    rules:
      - rule1
      - rule2
      - rule3
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
description строка	changed и success	Новое описание политики. Это значение возвращается только для устройств BIG-IP >= 12.1.0. Пример: Это мое описание
rules список / элементы=строка	changed и success	Список правил и их порядок, примененные к политике. Пример: ['/Common/rule1', '/Common/rule2']
strategy целое число	changed и success	Новая стратегия, установленная для политики. Пример: first-match

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_policy_module.html