Модуль f5networks.f5_modules.bigip_apm_acl — управление пользовательскими ACL APM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_apm_acl.

Добавлено в f5networks.f5_modules 1.0.0

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

Обзор

Управление пользовательскими ACL APM.

Параметры

Параметр	Комментарии
acl_order целое число	Задаёт число, определяющее порядок этой ACL относительно других ACL. Если значение не задано, устройство всегда помещает 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 строка	Этот параметр применяется только к записям контроля доступа уровня 4. Задаёт протокол: протоколы `tcp`, `udp`, `icmp` или `all`, к которым применяется запись контроля доступа. Варианты: `"tcp"` `"icmp"` `"udp"` `"all"`
scheme строка	Этот параметр применяется только к записям контроля доступа уровня 7. Задаёт схему URI: `http`, `https` или `any`, для которой действует запись контроля доступа. Варианты: `"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 логическое значение	Определяет, учитывается ли регистр букв при сопоставлении путей в записи контроля доступа. Варианты: `false` `true`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, так как её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server строка / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs логическое значение	Если задано значение `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на сайтах под вашим личным контролем, использующих самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
state строка	Если `state` имеет значение `present`, обеспечивает наличие ACL. Если `state` имеет значение `absent`, обеспечивает удаление ACL. Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка	Задаёт тип создаваемой ACL. После установки тип нельзя изменить. Варианты: `"static"` `"dynamic"`

Примечания

Примечание

Дополнительные сведения об использовании 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: false
    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: false
    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 integer	Порядок этого ACL относительно других ACL. Возвращается: изменено Пример: `10`
description string	Новое описание ACL. Возвращается: изменено Пример: `"My ACL"`
entries complex	Записи управления доступом, определяющие правила сопоставления ACL и соответствующее поведение. Возвращается: изменено Пример: `"hash/dictionary of values"`
action string	Действие, выполняемое записью управления доступом при обнаружении соответствия этой записи управления доступом. Возвращается: изменено Пример: `"allow"`
dst_addr string	IP-адрес назначения для записи управления доступом. Возвращается: изменено Пример: `"192.168.0.1"`
dst_mask string	Маска сети назначения для записи управления доступом. Возвращается: изменено Пример: `"255.255.255.128"`
dst_port string	Порт назначения для записи управления доступом. Возвращается: изменено Пример: `"80"`
dst_port_range string	Диапазон портов назначения для записи управления доступом. Возвращается: изменено Пример: `"80-81"`
host_name string	Узел, к которому применяется запись управления доступом. Возвращается: изменено Пример: `"foobar.com"`
log string	Уровень журналирования для событий этого типа. Возвращается: изменено Пример: `"packet"`
paths string	Путь или пути, к которым применяется запись управления доступом. Возвращается: изменено Пример: `"/fooshop"`
protocol string	Протокол, к которому применяется запись управления доступом. Возвращается: изменено Пример: `"tcp"`
scheme string	Схема URI, с которой работает запись управления доступом. Возвращается: изменено Пример: `"https"`
src_addr string	IP-адрес источника для записи управления доступом. Возвращается: изменено Пример: `"192.168.0.1"`
src_mask string	Маска сети источника для записи управления доступом. Возвращается: изменено Пример: `"255.255.255.128"`
src_port string	Порт источника для записи управления доступом. Возвращается: изменено Пример: `"80"`
src_port_range string	Диапазон портов источника для записи управления доступом. Возвращается: изменено Пример: `"80-81"`
path_match_case boolean	Определяет, учитывается ли регистр букв при сопоставлении путей в записи управления доступом. Возвращается: изменено Пример: `true`
type string	Тип создаваемого ACL. Возвращается: изменено Пример: `"static"`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_apm_acl_module.html