Модуль f5networks.f5_modules.bigip_apm_network_access — управление ресурсом сетевого доступа 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_network_access.

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Описание
allow_local_dns boolean	Разрешает локальный доступ к DNS-серверам, настроенным на клиенте до установления соединения сетевого доступа. Варианты: `false` `true`
allow_local_subnet boolean	Разрешает доступ к локальной подсети и локальный доступ к любому узлу или подсети из маршрутов, указанных в таблице маршрутизации клиента. Когда `true`, система не поддерживает интегрированную фильтрацию IP-трафика. Варианты: `false` `true`
description string	Описание сетевого доступа, заданное пользователем.
dns_address_space list / элементы=string	Задает список доменных имен, описывающих DNS-адреса целевой локальной сети.
dtls boolean	Если `true`, соединение сетевого доступа использует протокол безопасности транспортного уровня датаграмм вместо TCP, что обеспечивает более высокую пропускную способность для требовательных приложений, таких как VoIP или потоковое видео. Варианты: `false` `true`
dtls_port integer	Задает номер порта, который ресурс сетевого доступа использует для защищенного UDP-трафика с DTLS.
excluded_dns_addresses list / элементы=string	Задает пространства DNS-адресов, трафик которых не направляется через туннель.
excluded_ipv4_adresses list / элементы=dictionary	Задает пространства IPv4-адресов, трафик которых не направляется через туннель.
subnet string	Адрес подсети в формате CIDR, например `192.168.1.0/24` Адреса узлов можно указывать без маски CIDR.
excluded_ipv6_adresses list / элементы=dictionary	Задает пространства IPv6-адресов, трафик которых не направляется через туннель.
subnet string	Адрес подсети в формате CIDR, например `2001:db8:abcd:8000::/52` Адреса узлов можно указывать без маски CIDR.
ip_version string	Поддерживаемая версия IP для ресурса сетевого доступа. Варианты: `"ipv4"` `"ipv4-ipv6"`
ipv4_address_space list / элементы=dictionary	Задает список узлов или сетей IPv4, описывающих целевую локальную сеть. Этот параметр обязателен при создании нового ресурса, если `split_tunnel` имеет значение `true`.
subnet string	Адрес подсети в формате CIDR, например `192.168.1.0/24` Адреса узлов можно указывать без маски CIDR.
ipv4_lease_pool string	Задает ресурс пула аренды IPv4 для использования с сетевым доступом. На пул аренды можно ссылаться, указав полный путь, например `/Common/pool_name`. Если пул аренды указан с полным путем, параметр `partition` игнорируется.
ipv6_address_space list / элементы=dictionary	Задает список узлов или сетей IPv6, описывающих целевую локальную сеть. Этот параметр обязателен при создании нового ресурса, если `split_tunnel` имеет значение `true`.
subnet string	Адрес подсети в формате CIDR, например `2001:db8:abcd:8000::/52` Адреса узлов можно указывать без маски CIDR.
ipv6_lease_pool string	Задает ресурс пула аренды IPv6 для использования с сетевым доступом. На пул аренды можно ссылаться, указав полный путь, например `/Common/pool_name`. Если пул аренды указан с полным путем, параметр `partition` игнорируется.
name string / обязательный	Задает имя ресурса сетевого доступа APM, которым нужно управлять или который нужно создать.
partition string	Раздел устройства, в котором нужно управлять ресурсами. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с параметрами подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, так как ее имя было неясным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Имя узла BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на сайтах, которыми вы управляете лично и на которых используются самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
snat_pool string	Задает имя пула SNAT, используемого для реализации выборочного и интеллектуального SNAT. Когда `none`, система не использует пул SNAT для этого сетевого ресурса. Когда `automap`, система использует все собственные IP-адреса в качестве адресов трансляции для пула.
split_tunnel boolean	Указывает, что через туннель сетевого доступа передается только трафик, направленный в заданное адресное пространство. Варианты: `false` `true`
state string	Если `state` имеет значение `present`, гарантирует, что ACL существует. Если `state` имеет значение `absent`, гарантирует удаление ACL. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Дополнительные сведения об использовании 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 split tunnel IPV4 Network Access
  bigip_apm_network_access:
    name: foobar
    ip_version: ipv4
    split_tunnel: true
    snat_pool: "none"
    ipv4_lease_pool: leasefoo
    ipv4_address_space:
      - subnet: 10.10.1.1
      - subnet: 10.10.2.0/24
    excluded_ipv4_adresses:
      - subnet: 192.168.1.0/24
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a split tunnel IPV4 Network Access
  bigip_apm_network_access:
    name: foobar
    snat_pool: /Common/poolsnat
    ipv4_address_space:
      - subnet: 172.16.23.0/24
    excluded_ipv4_adresses:
      - subnet: 10.10.2.0/24
    allow_local_subnet: true
    allow_local_dns: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove Network Access
  bigip_apm_network_access:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
allow_local_dns boolean	Включает локальный доступ к DNS-серверам, настроенным на клиенте. Возвращается: changed Пример: `true`
allow_local_subnet boolean	Включает доступ к локальной подсети. Возвращается: changed Пример: `true`
description string	Новое описание сетевого доступа. Возвращается: changed Пример: `"My Access"`
dns_address_space list / elements=string	Указывает список доменных имен, описывающих DNS-адреса целевой локальной сети. Возвращается: changed Пример: `["internal.net", "*.engnet.org"]`
dtls boolean	Включает использование DTLS для сетевого доступа. Возвращается: changed Пример: `false`
dtls_port integer	Указывает номер порта, используемого ресурсом сетевого доступа для DTLS. Возвращается: changed Пример: `4433`
excluded_dns_addresses list / elements=string	Указывает DNS-пространства адресов, для которых трафик не направляется через туннель. Возвращается: changed Пример: `["foobar.com", "bazbar.org"]`
excluded_ipv4_adresses complex	Указывает пространства IPv4-адресов, для которых трафик не направляется через туннель. Возвращается: changed Пример: `"hash/dictionary of values"`
subnet string	Адрес узла или сети. Возвращается: changed Пример: `"192.168.10.1"`
excluded_ipv6_adresses complex	Указывает пространства IPv6-адресов, для которых трафик не направляется через туннель. Возвращается: changed Пример: `"hash/dictionary of values"`
subnet string	Адрес узла или сети. Возвращается: changed Пример: `"2001:DB8:ABCD:0012::0"`
ip_version string	Поддерживаемая версия IP для ресурса сетевого доступа. Возвращается: changed Пример: `"ipv4-ipv6"`
ipv4_address_space complex	Указывает список узлов или сетей IPv4, описывающих целевую локальную сеть. Возвращается: changed Пример: `"hash/dictionary of values"`
subnet string	Адрес узла или сети. Возвращается: changed Пример: `"192.168.10.1"`
ipv4_lease_pool string	Указывает ресурс пула аренды IPv4-адресов для использования с сетевым доступом. Возвращается: changed Пример: `"/Common/leasepoolv4"`
ipv6_address_space complex	Указывает список узлов или сетей IPv6, описывающих целевую локальную сеть. Возвращается: changed Пример: `"hash/dictionary of values"`
subnet string	Адрес узла или сети. Возвращается: changed Пример: `"2001:DB8:ABCD:0012::0"`
ipv6_lease_pool string	Указывает ресурс пула аренды IPv6-адресов для использования с сетевым доступом. Возвращается: changed Пример: `"/Common/leasepoolv6"`
snat_pool string	Имя пула SNAT, используемого ресурсом сетевого доступа. Возвращается: changed Пример: `"/Common/my-pool"`
split_tunnel boolean	Включает раздельное туннелирование для ресурса сетевого доступа. Возвращается: changed Пример: `true`

Авторы

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_network_access_module.html