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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание, которое нужно прикрепить к политике. Этот параметр поддерживается только на версиях BIG-IP >= 12.1.0. В более ранних версиях он просто будет проигнорирован.
name строка / обязательно			Имя политики для создания.
partition строка		Значение по умолчанию: "Общие"	Раздел устройства для управления ресурсами.
provider словарь добавлено в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	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 целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
rules список			Указывает список правил, которые вы хотите связать с этой политикой. Порядок в этом списке - порядок их оценки BIG-IP. Если указанные правила не существуют (например, при создании новой политики), они будут созданы. `conditions` для правила по умолчанию - `all`. `actions` для правила по умолчанию - `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 сохранится на диске, убедитесь, что вы включили как минимум одну задачу, использующую модуль 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 строка	изменен и успех	Новое описание политики. Это значение возвращается только для устройств BIG-IP >= 12.1.0. Пример: Это моё описание
rules список	изменен и успех	Список правил и их порядок, применённых к политике. Пример: ['/Общие/правило1', '/Общие/правило2']
strategy целое число	изменен и успех	Новая стратегия, установленная на политике. Пример: первое_соответствие

Статус

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