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) | По умолчанию: None | Объект словаря, содержащий данные подключения. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверяться. Используйте это только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| 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.
- Требуется пакет 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 |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/bigip_policy_module.html