f5networks.f5_modules.bigip_device_trust 模块 – 管理 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.bigip_device_trust

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 系统之间的信任关系。一旦对等,设备就无法更新。如果需要更新,必须先删除对等方,然后才能将其重新添加到信任中。

参数

参数

注释

peer_hostname

字符串

您想要与设备关联的主机名。此值用于在 BIG-IP 配置中轻松区分此设备。

在信任新设备时,如果未指定此参数,则使用 peer_server 的值作为默认值。

peer_password

字符串

您正在信任的远程对等设备的 API 用户名的密码。如果未指定此值,则使用 password 的值或环境变量 F5_PASSWORD

peer_server

字符串 / 必需

要连接并信任以同步配置的对等地址。这通常是远程设备的管理地址,但也可能是一个自 IP 地址。

peer_user

字符串

您正在信任的远程对等设备的 API 用户名。请注意,除非 CLI 用户也拥有 API 帐户,否则不能使用 CLI 用户。如果未指定此值,则使用 user 的值或环境变量 F5_USER

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" ← (默认)

type

字符串

指定您要添加的设备是 Peer 还是 Subordinate。默认值为 peer

两者之间的区别在于降低受损的风险。

从属设备不能为另一设备签名证书。

在信任域中的授权设备的安全性受到威胁的情况下,任何从属设备的受损风险都会降到最低。

建议将设备指定为从属设备,用于成员设备数量较多、受损风险较高的设备组。

选项

  • "peer" ← (默认)

  • "subordinate"

说明

注意

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

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

  • F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久化到磁盘,请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块的任务来保存运行配置。请参阅该模块的文档,了解如何正确使用该模块保存您的运行配置。

示例

- name: Add trusts for all peer devices to Active device
  bigip_device_trust:
    peer_server: "{{ item.ansible_host }}"
    peer_hostname: "{{ item.inventory_hostname }}"
    peer_user: "{{ item.bigip_username }}"
    peer_password: "{{ item.bigip_password }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  loop: hostvars
  when: inventory_hostname in groups['master']
  delegate_to: localhost

返回值

常见的返回值已在此处记录 此处,以下是此模块特有的字段

描述

peer_hostname

字符串

用于标识受信任对等方的远程主机名。

返回: changed

示例: "test-bigip-02.localhost.localdomain"

peer_server

字符串

受信任对等方的远程 IP 地址。

返回: changed

示例: "10.0.2.15"

作者

  • Tim Rupp (@caphrim007)