f5networks.f5_modules.bigiq_device_discovery 模块 – 通过 BIG-IQ 管理 BIG-IP 设备

注意

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

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

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

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

f5networks.f5_modules 1.0.0 中的新功能

概要

• 发现并导入 BIG-IQ 上的 BIG-IP 设备配置。

参数

参数	注释
access_conflict_policy 字符串	设置访问模块 apm 对象的冲突解决策略。仅当指定 apm 模块时使用。 选择 "use_bigiq" "use_bigip" "keep_version"
access_group_first_device 布尔值	指定导入的设备是否为访问组中的第一个设备，用于导入该访问组的共享配置。 选择 false true ← (默认)
access_group_name 字符串	用于导入设备访问配置的访问组名称。设置后无法更改。
conflict_policy 字符串	设置 BIG-IP 设备之间共享对象的冲突解决策略，LTM 配置文件和监视器除外。 选择 "use_bigiq" ← (默认) "use_bigip"
device_address 字符串 / 必填	要导入/管理的 BIG-IP 设备的 IP 地址。 对于此模块，provider 块应指向 BIG-IQ 凭据
device_conflict_policy 字符串	设置特定于 BIG-IP 设备且不在 BIG-IP 设备之间共享的对象的冲突解决策略。 选择 "use_bigiq" ← (默认) "use_bigip"
device_password 字符串	BIG-IP 设备的管理员密码。 仅当添加要管理的新 BIG-IP 设备时才需要此参数。
device_port 整数	BIG-IQ 和 BIG-IP 之间应进行设备信任设置的端口。 默认值： 443
device_username 字符串	BIG-IP 设备的管理员用户名。 仅当添加要管理的新 BIG-IP 设备时才需要此参数。
force 布尔值	强制重新发现和导入托管 BIG-IP 上现有的模块。 选择 false ← (默认) true
ha_name 字符串	要管理的 BIG-IP 设备的 DSC 集群名称。 如果托管设备不是集群组的一部分，则此参数是可选的。 当 use_bigiq_sync 设置为 true 时，此参数是必需的。
modules 列表 / 元素=字符串	要发现并导入到设备中的模块列表。 这些模块必须在目标设备上配置，否则操作将失败。 在执行设备的发现或重新发现时，必须始终指定 ltm 模块。 当指定 asm 或 afm 时，还需要声明 shared_security 模块。 选择 "ltm" "asm" "apm" "afm" "dns" "websafe" "security_shared"
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 ← (默认)
state 字符串	系统上托管设备的状态。 当设置为 present 时，启用新设备的添加以及设备重新发现/导入。 当设置为 absent 时，将设备从系统中完全移除。 选择 "absent" "present" ← (默认)
statistics 字典	指定已发现设备的统计信息收集。
enable 布尔值	启用设备上的统计信息收集。 选择 false ← (默认) true
interval 整数	指定从已发现设备收集数据的间隔，以秒为单位。 选择 30 60 ← (默认) 120 500
stat_modules 列表 / 元素=字符串	指定要收集数据的模块。 选择 "device" ← (默认) "ltm" ← (默认) "dns" 默认: ["device", "ltm"]
zone 字符串	指定 DCD 区域从设备收集数据。 默认: "default"
use_bigiq_sync 布尔值	设置为 false 时，在部署配置更改时启动 BIG-IP DSC 同步。 设置为 true 时，在部署配置更改时忽略 BIG-IP DSC 同步。 选择 false ← (默认) true
versioned_conflict_policy 字符串	为特定于 BIG-IP 软件版本的 LTM 配置文件和监视器对象设置冲突解决策略。 选择 "use_bigiq" "use_bigip" "keep_version"

注释

注意

• BIG-IQ >= 6.1.0.

• 此模块不支持原子性删除设备上已发现的模块。

• Provider 应指向 BIG-IQ 凭据

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为确保特定于 BIG-IP 的配置保留到磁盘，请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块来保存运行配置的任务。有关正确使用该模块保存运行配置的方法，请参阅模块的文档。

示例

- name: Discover a new device and import config, use default conflict policy.
  bigiq_device_discovery:
    device_address: 192.168.1.1
    device_username: bigipadmin
    device_password: bigipsecret
    modules:
      - ltm
      - afm
      - shared_security
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Discover a new device and import config, use non- default conflict policy.
  bigiq_device_discovery:
    device_address: 192.168.1.1
    modules:
      - ltm
      - dns
    conflict_policy: use_bigip
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Force full device rediscovery
  bigiq_device_discovery:
    device_address: 192.168.1.1
    modules:
      - ltm
      - afm
      - dns
      - shared_security
    force: true
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove discovered device and its config
  bigiq_device_discovery:
    device_address: 192.168.1.1
    state: absent
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

返回值

通用返回值在此处有文档记录：此处，以下是此模块特有的字段

Key	描述
access_conflict_policy 字符串	设置 Access 模块 apm 对象的冲突解决策略。 返回值: changed 示例: "keep_version"
access_group_first_device 布尔值	访问组中第一个为该访问组导入共享配置的设备。 返回值: changed 示例: true
access_group_name 字符串	用于为设备导入 Access 配置的访问组名称。 返回值: changed 示例: "foo_group"
conflict_policy 字符串	设置跨 BIG-IP 设备的共享对象的冲突解决策略。 返回值: changed 示例: "use_bigip"
device_address 字符串	要导入/管理的 BIG-IP 设备的 IP 地址。 返回值: changed 示例: "192.168.1.1"
device_conflict_policy 字符串	设置特定于 BIG-IP 设备的对象冲突解决策略。 返回值: changed 示例: "use_bigip"
device_port 整数	BIG-IQ 和 BIG-IP 之间应进行设备信任设置的端口。 返回值: changed 示例: 10443
ha_name 字符串	要管理的 BIG-IP 设备的 DSC 集群名称。 返回值: changed 示例: "GROUP_1"
modules 列表 / 元素=字符串	要发现并导入到设备中的模块列表。 返回值: changed 示例: ["ltm", "dns"]
use_bigiq_sync 布尔值	指示 BIG-IQ 是否应手动同步 DSC 配置。 返回值: changed 示例: true
versioned_conflict_policy 字符串	设置 LTM 配置文件和监视器对象的冲突解决策略。 返回值: changed 示例: "keep_version"

作者

• Wojciech Wypior (@wojtek0806)

集合链接

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