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

要在剧本中使用它,请指定: 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

字符串

配置 auth 提供程序以从远程设备获取身份验证令牌。

此选项在与 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

两者之间的区别在于降低安全风险。

下级设备无法为其他设备签名证书。

如果信任域中的权威设备的安全受到威胁,则任何下级设备的受威胁风险都将降到最低。

对于成员设备数量众多、安全风险较高的设备组,建议将其指定为下级设备。

选项

  • "peer" ← (默认)

  • "subordinate"

备注

注意

  • 有关使用 Ansible 管理 F5 网络设备的更多信息,请参见 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

字符串

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

返回:已更改

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

peer_server

字符串

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

返回:已更改

示例: "10.0.2.15"

作者

  • Tim Rupp (@caphrim007)