f5networks.f5_modules.bigip_apm_acl – Управление настраиваемыми правилами доступа APM

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_apm_acl.

Новое в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление настраиваемыми правилами доступа APM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
acl_order целое число			Указывает число, которое определяет порядок этого ACL относительно других ACL. Если не задано, устройство всегда разместит ACL после последнего созданного. Чем меньше число, тем выше ACL в общем порядке, причём наименьшее число `0` является самым верхним. Допустимый диапазон значений — от `0` до `65535` включительно.
description строка			Описание ACL, созданное пользователем.
entries список / элементы=словарь			Правила управления доступом, которые определяют соответствие ACL и соответствующее поведение. Порядок, в котором правила размещаются в качестве аргументов этого параметра, определяет их порядок в ACL; другими словами, изменение порядка одних и тех же элементов вызовет изменение на устройстве.
	action строка / обязательно	Варианты: allow reject discard continue	Указывает действие, которое выполняет запись управления доступом при обнаружении соответствия этой записи.
	dst_addr строка		Указывает целевой IP-адрес для записи управления доступом. Если установлено значение `any`, ACL будет соответствовать любому целевому адресу; `dst_mask` в этом случае игнорируется.
	dst_mask строка		Необязательный параметр, который указывает целевую маску сети для записи управления доступом. Если не указано и `dst_addr` не `any`, `dst_addr` считается адресом хоста.
	dst_port строка		Указывает целевой порт для записи управления доступом. Может быть установлено значение `*`, чтобы указать все порты. Параметр взаимоисключающий с `dst_port_range`.
	dst_port_range строка		Указывает диапазон целевых портов для записи управления доступом. Параметр взаимоисключающий с `dst_port_range`. Чтобы указать все порты, необходимо использовать параметр `dst_port` и установить его в значение `*`.
	host_name строка		Этот параметр применим только к записям управления доступом уровня 7. Указывает хост, к которому относится запись управления доступом.
	log строка	Варианты: none packet	Указывает уровень логов, которые регистрируются при выполнении действий этого типа. При значении `none` ничего не регистрируется, что является значением по умолчанию. При значении `packet` регистрируется сопоставленный пакет.
	paths строка		Этот параметр применим только к записям управления доступом уровня 7. Указывает путь или пути, к которым относится запись управления доступом.
	protocol строка	Варианты: tcp icmp udp all	Этот параметр применим только к записям управления доступом уровня 4. Указывает протокол: `tcp`, `udp`, `icmp` или `all`, к которому относится запись управления доступом.
	scheme строка	Варианты: http https any	Этот параметр применим только к записям управления доступом уровня 7. Указывает схему URI: `http`, `https` или `any`, на которой работает запись управления доступом.
	src_addr строка		Указывает исходный IP-адрес для записи управления доступом. Если установлено значение `any`, ACL будет соответствовать любому исходному адресу; `src_mask` в этом случае игнорируется.
	src_mask строка		Необязательный параметр, который указывает исходную маску сети для записи управления доступом. Если не указано и `src_addr` не `any`, `src_addr` считается адресом хоста.
	src_port строка		Указывает исходный порт для записи управления доступом. Может быть установлено значение `*`, чтобы указать все порты. Параметр взаимоисключающий с `src_port_range`.
	src_port_range строка		Указывает диапазон исходных портов для записи управления доступом. Параметр взаимоисключающий с `src_port_range`. Чтобы указать все порты, необходимо использовать параметр `src_port` и установить его в значение `*`.
name строка / обязательно			Указывает имя ACL для управления.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
path_match_case логическое значение		Варианты: no yes	Указывает, учитывается ли регистр букв при сопоставлении путей в записи управления доступом.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные соединения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, задав переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Когда `state` равно `present`, гарантирует, что ACL существует. Когда `state` равно `absent`, гарантирует, что ACL удаляется.
type строка		Варианты: static dynamic	Указывает тип создаваемого ACL. После установки типа его нельзя изменить.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, необходимо включить хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения рабочей конфигурации.

Примеры

- name: Create a static ACL with L4 entries
  bigip_apm_acl:
    name: L4foo
    acl_order: 0
    type: static
    entries:
      - action: allow
        dst_port: '80'
        dst_addr: '192.168.1.1'
        src_port: '443'
        src_addr: '10.10.10.0'
        src_mask: '255.255.255.128'
        protocol: tcp
      - action: reject
        dst_port: '*'
        dst_addr: '192.168.1.1'
        src_port: '*'
        src_addr: '10.10.10.0'
        src_mask: '255.255.255.128'
        protocol: tcp
        log: packet
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a static ACL with L7 entries
  bigip_apm_acl:
    name: L7foo
    acl_order: 1
    type: static
    path_match_case: no
    entries:
      - action: allow
        host_name: 'foobar.com'
        paths: '/shopfront'
        scheme: https
      - action: reject
        host_name: 'internal_foobar.com'
        paths: '/admin'
        scheme: any
        log: packet
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a static ACL with L7/L4 entries
  bigip_apm_acl:
    name: L7L4foo
    acl_order: 2
    type: static
    path_match_case: no
    entries:
      - action: allow
        host_name: 'foobar.com'
        paths: '/shopfront'
        scheme: https
        dst_port: '8181'
        dst_addr: '192.168.1.1'
        protocol: tcp
      - action: reject
        dst_addr: '192.168.1.1'
        host_name: 'internal_foobar.com'
        paths: '/admin'
        scheme: any
        protocol: all
        log: packet
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a static ACL entries
  bigip_apm_acl:
    name: L4foo
    entries:
      - action: allow
        dst_port: '80'
        dst_addr: '192.168.1.1'
        src_port: '443'
        src_addr: '10.10.10.0'
        src_mask: '255.255.255.128'
        protocol: tcp
      - action: discard
        dst_port: '*'
        dst_addr: 192.168.1.1
        src_port: '*'
        src_addr: '10.10.10.0'
        src_mask: '255.2155.255.128'
        protocol: all
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove static ACL
  bigip_apm_acl:
    name: L4foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, а ниже приведены поля, уникальные для данного модуля:

Ключ		Возвращаемое	Описание
acl_order целое число		изменено	Порядок данного ACL относительно других ACL. Пример: 10
description строка		изменено	Новое описание ACL. Пример: Мой ACL
entries сложное		изменено	Элементы управления доступом, определяющие сопоставление ACL и соответствующее поведение. Пример: хэш/словарь значений
	action строка	изменено	Действие, выполняемое элементом управления доступом при обнаружении совпадения с данным элементом управления доступом. Пример: разрешить
	dst_addr строка	изменено	IP-адрес назначения для элемента управления доступом. Пример: 192.168.0.1
	dst_mask строка	изменено	Маска сети назначения для элемента управления доступом. Пример: 255.255.255.128
	dst_port строка	изменено	Порт назначения для элемента управления доступом. Пример: 80
	dst_port_range строка	изменено	Диапазон портов назначения для элемента управления доступом. Пример: 80-81
	host_name строка	изменено	Хост, к которому применяется элемент управления доступом. Пример: foobar.com
	log строка	изменено	Уровень логирования, который регистрируется при возникновении действий этого типа. Пример: пакет
	paths строка	изменено	Путь или пути, к которым применяется элемент управления доступом. Пример: /fooshop
	protocol строка	изменено	Протокол, к которому применяется элемент управления доступом. Пример: tcp
	scheme строка	изменено	Схема URI, на которой работает элемент управления доступом. Пример: https
	src_addr строка	изменено	IP-адрес источника для элемента управления доступом. Пример: 192.168.0.1
	src_mask строка	изменено	Маска сети источника для элемента управления доступом. Пример: 255.255.255.128
	src_port строка	изменено	Порт источника для элемента управления доступом. Пример: 80
	src_port_range строка	изменено	Диапазон портов источника для элемента управления доступом. Пример: 80-81
path_match_case булево		изменено	Указывает, учитывается ли регистр букв при сопоставлении путей в элементе управления доступом. Пример: True
type строка		изменено	Тип создаваемого ACL. Пример: статический

Авторы

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.10/collections/f5networks/f5_modules/bigip_apm_acl_module.html