bigip_policy - Управление общей политикой на BIG-IP
Новая в версии 2.5.
Обзор
- Управляет общей политикой на BIG-IP. Данный модуль лучше всего использовать совместно с модулем
bigip_policy_rule. Этот модуль может обрабатывать общие настройки, такие как установку черновика состояния политики, описание и другие параметры, не связанные с правилами политики самими по себе. Это также первый модуль, который следует использовать при создании правил, поскольку модульbigip_policy_ruleтребует параметр политики.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description | Описание, которое необходимо добавить к политике. Этот параметр поддерживается только на версиях BIG-IP >= 12.1.0. В более ранних версиях он будет просто проигнорирован. | ||
| name обязательно | Имя политики, которую нужно создать. | ||
| partition | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| 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 задана. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER задана. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS задана. | |
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации соединения с удаленным устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| rules | Указывает список правил, которые вы хотите связать с этой политикой. Порядок в этом списке - это порядок, в котором они будут оцениваться BIG-IP. Если указанные правила не существуют (например, при создании новой политики), они будут созданы. Значения по умолчанию для правила по умолчанию - all. Значения по умолчанию для правила по умолчанию - 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 bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS задана. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks можно найти по адресу https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- 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. См. Поддержка и техническое обслуживание модулей для получения дополнительной информации.
Для списка других модулей, также поддерживаемых сообществом 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.6/modules/bigip_policy_module.html