f5networks.f5_modules.bigip_apm_network_access 模块 – 管理 APM 网络访问资源

注意

此模块是 f5networks.f5_modules 集合（版本 1.32.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定： f5networks.f5_modules.bigip_apm_network_access。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 APM 网络访问资源。

参数

参数	注释
allow_local_dns 布尔值	启用对客户端在建立网络访问连接之前配置的 DNS 服务器的本地访问。 选择 false true
allow_local_subnet 布尔值	启用本地子网访问以及对客户端路由表中指定的任何主机或子网的本地访问。 当 true 时，系统不支持集成的 IP 过滤。 选择 false true
description 字符串	用户创建的网络访问描述。
dns_address_space 列表 / 元素=字符串	指定描述目标 LAN DNS 地址的域名列表。
dtls 布尔值	当 true 时，网络访问连接使用数据报传输层安全协议而不是 TCP，从而为 VoIP 或流视频等高需求应用程序提供更好的吞吐量。 选择 false true
dtls_port 整数	指定网络访问资源用于通过 DTLS 进行安全 UDP 通信的端口号。
excluded_dns_addresses 列表 / 元素=字符串	指定不强制通过隧道传输的 DNS 地址空间。
excluded_ipv4_adresses 列表 / 元素=字典	指定不强制通过隧道传输的 IPV4 地址空间。
subnet 字符串	子网的 CIDR 格式地址，例如 192.168.1.0/24 可以在不使用 CIDR 掩码表示法的情况下指定主机地址。
excluded_ipv6_adresses 列表 / 元素=字典	指定不强制通过隧道传输的 IPV6 地址空间。
subnet 字符串	子网的 CIDR 格式地址，例如 2001:db8:abcd:8000::/52 可以在不使用 CIDR 掩码表示法的情况下指定主机地址。
ip_version 字符串	网络访问资源上支持的 IP 版本。 选择 "ipv4" "ipv4-ipv6"
ipv4_address_space 列表 / 元素=字典	指定描述目标 LAN 的 IPv4 主机或网络列表。 当创建新资源且 split_tunnel 设置为 true 时，此选项是必需的。
subnet 字符串	子网的 CIDR 格式地址，例如 192.168.1.0/24 可以在不使用 CIDR 掩码表示法的情况下指定主机地址。
ipv4_lease_pool 字符串	指定要与网络访问一起使用的 IPV4 租用池资源。 可以使用完整路径格式引用租用池，例如 /Common/pool_name。 当使用完整路径格式引用租用池时，partition 参数将被忽略。
ipv6_address_space 列表 / 元素=字典	指定描述目标 LAN 的 IPv6 主机或网络列表。 当创建新资源且 split_tunnel 设置为 true 时，此选项是必需的。
subnet 字符串	子网的 CIDR 格式地址，例如 2001:db8:abcd:8000::/52 可以在不使用 CIDR 掩码表示法的情况下指定主机地址。
ipv6_lease_pool 字符串	指定要与网络访问一起使用的 IPV6 租用池资源。 可以使用完整路径格式引用租用池，例如 /Common/pool_name。 当使用完整路径格式引用租用池时，partition 参数将被忽略。
name 字符串 / 必需	指定要管理/创建的 APM 网络访问的名称。
partition 字符串	设备分区，用于管理资源。 默认值： "Common"
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
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 ←（默认）
snat_pool 字符串	指定用于实现选择性和智能 SNAT 的 SNAT 池的名称。 当 none 时，系统不会为此网络资源使用 SNAT 池。 当 automap 时，系统使用所有自 IP 地址作为池的转换地址。
split_tunnel 布尔值	指定只有目标为指定地址空间的流量才通过网络访问隧道发送。 选择 false true
state 字符串	当 state 为 present 时，确保 ACL 存在。 当 state 为 absent 时，确保 ACL 被删除。 选择 "present" ← (默认) "absent"

注释

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/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 布尔值	启用对客户端上配置的 DNS 服务器的本地访问。 已返回: changed 示例: true
allow_local_subnet 布尔值	启用本地子网访问。 已返回: changed 示例: true
description 字符串	网络访问的新描述。 已返回: changed 示例: "My Access"
dns_address_space 列表 / 元素=字符串	指定描述目标 LAN DNS 地址的域名列表。 已返回: changed 示例: ["internal.net", "*.engnet.org"]
dtls 布尔值	启用网络访问使用 DTLS。 已返回: changed 示例: false
dtls_port 整数	指定网络访问资源用于 DTLS 的端口号。 已返回: changed 示例: 4433
excluded_dns_addresses 列表 / 元素=字符串	指定不强制通过隧道传输的 DNS 地址空间。 已返回: changed 示例: ["foobar.com", "bazbar.org"]
excluded_ipv4_adresses 复杂	指定不强制通过隧道传输的 IPV4 地址空间。 已返回: changed 示例: "值的哈希/字典"
subnet 字符串	主机或网络地址。 已返回: changed 示例: "192.168.10.1"
excluded_ipv6_adresses 复杂	指定不强制通过隧道传输的 IPV6 地址空间。 已返回: changed 示例: "值的哈希/字典"
subnet 字符串	主机或网络地址。 已返回: changed 示例: "2001:DB8:ABCD:0012::0"
ip_version 字符串	网络访问资源上支持的 IP 版本。 已返回: changed 示例: "ipv4-ipv6"
ipv4_address_space 复杂	指定描述目标 LAN 的 IPv4 主机或网络列表。 已返回: changed 示例: "值的哈希/字典"
subnet 字符串	主机或网络地址。 已返回: changed 示例: "192.168.10.1"
ipv4_lease_pool 字符串	指定用于网络访问的 IPv4 租用池资源。 已返回: changed 示例: "/Common/leasepoolv4"
ipv6_address_space 复杂	指定描述目标 LAN 的 IPv6 主机或网络列表。 已返回: changed 示例: "值的哈希/字典"
subnet 字符串	主机或网络地址。 已返回: changed 示例: "2001:DB8:ABCD:0012::0"
ipv6_lease_pool 字符串	指定用于网络访问的 IPv6 租用池资源。 已返回: changed 示例: "/Common/leasepoolv6"
snat_pool 字符串	网络访问资源使用的 SNAT 池的名称。 已返回: changed 示例: "/Common/my-pool"
split_tunnel 布尔值	启用网络访问资源上的拆分隧道。 已返回: changed 示例: true

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）