f5networks.f5_modules.bigip_wait 模块 – 在继续之前等待 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_wait。

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 使用此模块，您可以等待 BIG-IP 处于“就绪”状态，这意味着 BIG-IP 已准备好接受配置。

  • 此模块可以考虑由于配置更改而导致设备正在重新启动的情况。

参数

参数

注释

delay

整数

开始轮询之前等待的秒数。

默认值： 0

msg

字符串

这会覆盖无法满足所需条件时发生的正常错误消息。

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 的用户帐户的密码。

您可以通过设置环境变量 F5_PASSWORD 来省略此选项。

server

字符串 / 必需

BIG-IP 主机。

您可以通过设置环境变量 F5_SERVER 来省略此选项。

server_port

整数

BIG-IP 服务器端口。

您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。

默认值： 443

ssh_keyfile

路径

指定用于验证与远程设备连接的 SSH 密钥文件。此参数仅用于 *cli* 传输。

您可以通过设置环境变量 ANSIBLE_NET_SSH_KEYFILE 来省略此选项。

timeout

整数

当 transport 设置为 rest 时生效的参数

指定与网络设备通信（连接或发送命令）的超时时间（秒）。如果在操作完成之前超时，模块将出错。

transport

字符串

配置连接到远程设备时使用的传输连接。

选项

  • "cli"

  • "rest" ← (默认)

user

字符串 / 必需

用于连接到 BIG-IP 的用户名。此用户必须拥有设备上的管理员权限。

您可以通过设置环境变量 F5_USER 来省略此选项。

validate_certs

布尔值

如果为 no，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。

您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。

选项

  • false

  • true ← (默认)

sleep

整数

检查之间休眠的秒数。2.3 版之前，此值硬编码为 1 秒。

默认值： 1

timeout

整数

最大等待秒数。

在不使用其他条件的情况下，它等同于只休眠。

默认超时时间故意设置为 2 小时，因为没有单独的 REST API。

默认值： 7200

type

字符串

BIG-IP 的类型。

默认为 standard，另一个选项是 vcmp。

此选项定义 Ansible 用于确定设备已恢复的模块或服务，因此请确保指定正确的选项，尤其是在针对 VCMP 运行此操作时。

选项

  • "standard" ← (默认)

  • "vcmp"

备注

注意

示例

- name: Wait for BIG-IP to be ready to take configuration
  bigip_wait:
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Wait a maximum of 300 seconds for BIG-IP to be ready to take configuration
  bigip_wait:
    timeout: 300
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Wait for BIG-IP to be ready, don't start checking for 10 seconds
  bigip_wait:
    delay: 10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)