f5networks.f5_modules.bigip_gtm_datacenter 模块 – 在 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_gtm_datacenter

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 数据中心配置。数据中心定义了物理网络组件所在的位置,例如在网络上共享相同子网的服务器和链路对象。此模块能够操作 BIG-IP 中的数据中心定义。

参数

参数

注释

contact

字符串

数据中心的联系人姓名。

description

字符串

数据中心的描述。

location

字符串

数据中心的位置。

name

字符串 / 必需

数据中心的名称。

partition

字符串

用于管理资源的设备分区。

默认值: "Common"

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

字符串

虚拟地址状态。如果为 absent,则会尝试删除虚拟地址。只有在虚拟服务器未使用此虚拟地址的情况下,此操作才会成功。present 创建虚拟地址并启用它。如果为 enabled,则如果虚拟地址存在,则启用它。如果为 disabled,则根据需要创建虚拟地址,并将状态设置为 disabled

选项

  • "present" ← (默认)

  • "absent"

  • "enabled"

  • "disabled"

备注

注意

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

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

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

示例

- name: Create data center "New York"
  bigip_gtm_datacenter:
    name: New York
    location: 222 West 23rd
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

密钥

描述

contact

字符串

在数据中心设置的联系人。

返回值:changed

示例: "[email protected]"

description

字符串

数据中心的描述。

返回值:changed

示例: "纽约的数据中心"

disabled

布尔值

数据中心是否被禁用。

返回值:changed

示例: true

enabled

布尔值

数据中心是否被启用。

返回值:changed

示例: true

location

字符串

数据中心的位置。

返回值:changed

示例: "西23街222号"

state

字符串

数据中心的状态。

返回值:changed

示例: "disabled"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)