bigip_policy – Управление общей конфигурацией политики на BIG-IP
Новое в версии 2.5.
Обзор
- Управляет общей конфигурацией политики на BIG-IP. Данный модуль лучше всего использовать совместно с модулем
bigip_policy_rule. Этот модуль может обрабатывать общую конфигурацию, такую как установку черновика состояния политики, описание и параметры, не связанные с правилами политики. Также этот модуль должен быть первым при создании правил, так как модулюbigip_policy_ruleтребуется параметр политики.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Описание, которое необходимо добавить к политике. Этот параметр поддерживается только на версиях BIG-IP >= 12.1.0. В более ранних версиях он будет просто проигнорирован. | ||
| name строка / обязательно | Имя политики, которую необходимо создать. | ||
| partition строка | Значение по умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| 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 булево |
| Если 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 булево добавлено в 2.0 |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, управляемых лично, с самозаверенными сертификатами.Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 список | изменён и успех | Список правил и их порядок, применённые к политике. Пример: ['/Common/rule1', '/Common/rule2'] |
| strategy целое число | изменён и успех | Новая стратегия, установленная для политики. Пример: first-match |
Статус
- Для этого модуля не гарантируется обратная совместимость. [превью]
- Этот модуль поддерживается партнёром 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.8/modules/bigip_policy_module.html