f5networks.f5_modules.bigip_gtm_topology_region 模块 – 管理 GTM 拓扑区域

注意

此模块是 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_gtm_topology_region。

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理 GTM（现在为 BIG-IP DNS）拓扑区域。

参数 

参数	注释
名称字符串 / 必需	指定区域的名称。
分区字符串	用于管理资源的设备分区。当与 `pool`、`data_center` 和 `region` 参数结合使用时，也会考虑分区参数。默认值： `"Common"`
提供程序字典在 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` 来省略此选项。
服务器字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。您可以通过设置环境变量 `F5_SERVER` 来省略此选项。
server_port 整数	BIG-IP 服务器端口。您可以通过设置环境变量 `F5_SERVER_PORT` 来省略此选项。默认值： `443`
超时整数	指定与网络设备通信以进行连接或发送命令的超时时间（以秒为单位）。如果在操作完成之前超过超时时间，模块将出错。
传输字符串	配置连接到远程设备时要使用的传输连接。选项 `"rest"` ←（默认）
用户字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理权限。您可以通过设置环境变量 `F5_USER` 来省略此选项。
validate_certs 布尔值	如果为 `no`，则不会验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此选项。您可以通过设置环境变量 `F5_VALIDATE_CERTS` 来省略此选项。选项 `false` `true` ←（默认）
region_members 列表 / elements=dictionary	指定区域成员的列表。此成员列表是全部或全部，为了添加或删除成员，您必须指定整个成员列表。如果不同，则该列表将覆盖设备上的内容。如果指定空列表，则会删除区域成员列表。
大陆字符串	指定七大洲之一，以及 `Unknown` 设置。指定 `Unknown` 会强制系统在使用请求的本地 DNS 无法确定其位置时使用默认解析。支持完整的大陆名称及其缩写形式。
country 字符串	要使用的国家/地区的名称或代码。除了国家/地区的完整名称外，您还可以指定其缩写形式，例如使用 `US` 而不是 `United States`。有效的国家/地区代码可以在这里找到：https://countrycode.org/。
datacenter 字符串	指定配置中已定义的 GTM 数据中心的名称。
geo_isp 字符串	指定地理位置 ISP。
isp 字符串	指定 Internet 服务提供商。选项 `"AOL"` `"BeijingCNC"` `"CNC"` `"ChinaEducationNetwork"` `"ChinaMobilNetwork"` `"ChinaRailwayTelcom"` `"ChinaTelecom"` `"ChinaUnicom"` `"Comcast"` `"Earthlink"` `"ShanghaiCNC"` `"ShanghaiTelecom"`
negate 布尔值	当设置为 c(true) 时，如果请求源不匹配，系统会选择此拓扑区域。只能与 negate 一起指定一个列表条目。选项 `false` ←（默认） `true`
pool 字符串	指定配置中已定义的 GTM 池的名称。
region 字符串	指定配置中已定义的区域的名称。
state 字符串	指定给定国家/地区的州/省。
subnet 字符串	CIDR 格式的 IP 地址和网络掩码。
state 字符串	当 `state` 为 `present` 时，确保该区域存在。当 `state` 为 `absent` 时，确保该区域被移除。选项 `"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 topology region
  bigip_gtm_topology_region:
    name: foobar
    region_members:
      - country: CN
        negate: true
      - datacenter: baz
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify topology region
  bigip_gtm_topology_region:
    name: foobar
    region_members:
      - continent: EU
      - country: PL
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

Key	描述
名称字符串	GTM 区域的名称值。 Returned: changed 示例: `"foobar"`
region_members list / elements=string	GTM 区域的成员列表。 Returned: changed 示例: `[{"continent": "EU"}, {"country": "PL"}]`

作者

Wojciech Wypior (@wojtek0806)