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

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Новая функция в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

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

Примечания

Примечание

Дополнительную информацию об использовании 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: true
        select: true
        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. Возвращается: changed и success Пример: `"This is my description"`
rules список / элементы=строка	Список правил и их порядок, применяемых к политике. Возвращается: changed и success Пример: `["/Common/rule1", "/Common/rule2"]`
strategy целое число	Новая стратегия, установленная для политики. Возвращается: changed и success Пример: `"first-match"`

Авторы

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

Ссылки на коллекцию

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