bigip_policy – Управление общей конфигурацией политики на BIG-IP
Новая в версии 2.5.
Описание
- Управляет общей конфигурацией политики на BIG-IP. Этот модуль лучше всего использовать совместно с модулем
bigip_policy_rule. Этот модуль может обрабатывать общую конфигурацию, такую как установка состояния черновика политики, описание и элементы, не связанные с самими правилами политики. Это также первый модуль, который следует использовать при создании правил, так как модулюbigip_policy_ruleтребуется параметр политики.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description - | Описание, которое нужно добавить к политике. Этот параметр поддерживается только в версиях BIG-IP >= 12.1.0. В более ранних версиях он будет просто проигнорирован. | ||
| name - / обязательно | Имя политики, которую нужно создать. | ||
| partition - | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. Псевдонимы: pass, pwd | ||
| provider - добавлен в 2.5 | Значение по умолчанию: null | Объект словаря с данными подключения. | |
| 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 - | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| rules - | Указывает список правил, которые вы хотите связать с этой политикой. Порядок в этом списке — порядок их оценки BIG-IP. Если указанных правил не существует (например, при создании новой политики), они будут созданы. Значения по умолчанию для правила по умолчанию conditions all. Значения по умолчанию для правила по умолчанию actions ignore. Модуль bigip_policy_rule может быть использован для создания и редактирования существующих и новых правил. | ||
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state - |
| Когда state present, гарантирует, что политика существует и опубликована. Когда state absent, гарантирует удаление политики, даже если она сейчас в черновике.Когда state draft, гарантирует, что политика существует и находится в черновике. При изменении правил необходимо, чтобы политики сначала были в черновике.Создание черновиков поддерживается только в версиях BIG-IP >= 12.1.0. В версиях, предшествующих этому, указание state draft вызовет ошибку. | |
| strategy - |
| Определяет метод определения, какие действия выполняются в случае, если несколько правил соответствуют условиям. При создании новых политик значение по умолчанию first. Этот модуль не позволяет вам указать best стратегию для использования. Вместо этого он выберет системный параметр по умолчанию (/Common/best-match). | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите как минимум одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create policy which is immediately published
bigip_policy:
name: Policy-Foo
state: present
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
- 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 }}"
with_items:
- 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
- name: Create policy specify default rules - Left in a draft
bigip_policy:
name: Policy-Baz
state: draft
rules:
- rule1
- rule2
- rule3
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменено и успешно | Новое описание политики. Это значение возвращается только для устройств BIG-IP >= 12.1.0. Пример: Это моё описание |
| rules список | изменено и успешно | Список правил и их порядок, применяемых к политике. Пример: ['/Common/rule1', '/Common/rule2'] |
| strategy целое число | изменено и успешно | Новая стратегия, установленная для политики. Пример: first-match |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается партнёром Ansible. [сертифицировано]
Авторы
- 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.7/modules/bigip_policy_module.html