f5networks.f5_modules.bigip_selfip 模块 – 管理 BIG-IP 系统上的 Self-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_selfip。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP 系统上的 Self-IP 地址。

参数 

参数	注释
address 字符串	新 self IP 的 IP 地址。此值在更新时会被忽略，因为地址本身在创建后无法更改。创建新的 self IP 时，此值是必需的。支持 IPv4 和 IPv6。
allow_service 列表 / 元素=字符串	配置 self IP 的端口锁定。默认情况下，self IP 具有“默认拒绝”策略。可以将其更改为允许 TCP 和 UDP 端口，以及特定协议。此列表应包含 `协议`:`端口` 值。
description 字符串	流量选择器的描述。
fw_enforced_policy 字符串在 f5networks.f5_modules 1.1.0 中添加	指定要附加到 Self IP 的 AFM 策略。
name 字符串 / 必需	要创建的 self IP 的名称。如果未指定此参数，则默认值为 `address` 参数中提供的值。
netmask 字符串	self IP 的网络掩码。创建新的 self IP 时，此值是必需的。
partition 字符串	要在其上管理资源的设备分区。您可以为 self IP 设置不同的分区，但所使用的地址可能与 self IP 使用的任何其他地址都不匹配。因此，self IP 不像 BIG-IP 上的其他资源那样按分区隔离。默认值： `"Common"`
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` ← (默认)
route_domain 整数	系统的路由域 ID。创建新的 self IP 时，如果未指定此值，则默认值为 `0`。此值在设置后无法更改。
state 字符串	当为 `present` 时，保证 self IP 存在并具有提供的属性。当为 `absent` 时，从系统中删除 self IP。选项 `"absent"` `"present"` ← (默认)
traffic_group 字符串	用于活动-活动冗余负载均衡配置中自 IP 地址的流量组。创建新的自 IP 时，如果未指定此值，则默认为 `/Common/traffic-group-local-only`。
vlan 字符串	新自 IP 的 VLAN。创建新的自 IP 时，此值是必需的。

说明 

注意

有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久保存到磁盘，请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块来保存运行配置的任务。请参阅该模块的文档，了解如何正确使用该模块保存运行配置。

示例 

- name: Create Self IP
  bigip_selfip:
    address: 10.10.10.10
    name: self1
    netmask: 255.255.255.0
    vlan: vlan1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create Self IPv6
  bigip_selfip:
    address: fe80::10
    name: self2
    netmask: "ffff:ffff:ffff:ffff::"
    vlan: vlan1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    delegate_to: localhost

- name: Create Self IP with a Route Domain
  bigip_selfip:
    name: self1
    address: 10.10.10.10
    netmask: 255.255.255.0
    vlan: vlan1
    route_domain: 10
    allow_service: default
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete Self IP
  bigip_selfip:
    name: self1
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Allow management web UI to be accessed on this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:443
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow HTTPS and SSH access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:443
      - tcp:22
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow all services access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - all
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Allow only GRE and IGMP protocols access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - gre:0
      - igmp:0
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Allow all TCP, but no other protocols access to this Self IP
  bigip_selfip:
    name: self1
    state: absent
    allow_service:
      - tcp:0
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

常见的返回值记录在这里，以下是此模块特有的字段

键	描述
address 字符串	自 IP 的地址。返回： changed 示例： `"192.0.2.10"`
allow_service 列表 / 元素=字符串	允许通过此自 IP 访问的服务。返回： changed 示例： `["igmp:0", "tcp:22", "udp:53"]`
fw_enforced_policy 字符串	指定要附加到自 IP 的 AFM 策略。返回： changed 示例： `"/Common/afm-blocking-policy"`
name 字符串	自 IP 的名称。返回： created 示例： `"self1"`
netmask 字符串	自 IP 的网络掩码。返回： changed 示例： `"255.255.255.0"`
traffic_group 字符串	自 IP 所属的流量组。返回： changed 示例： `"traffic-group-local-only"`
vlan 字符串	在自 IP 上设置的 VLAN。返回： changed 示例： `"vlan1"`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)