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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_policy.

Добавлено в f5networks.f5_modules 1.0.0

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

Краткое описание

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

Параметры

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

Авторы

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

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

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