f5networks.f5_modules.bigip_sys_db 模块 – 管理 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_sys_db。

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理 BIG-IP 系统数据库变量。

参数 

参数	注释
key 字符串 / 必需	要操作的数据库变量。
provider 字典在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
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` ←（默认）
state 字符串	系统上变量的状态。当为 `present` 时，保证现有变量设置为 `value`。当为 `reset` 时，将变量设置回默认值。value 和 state `reset` 中至少需要一个。选择 `"present"` ←（默认） `"reset"`
value 字符串	要将 key 设置为的值。value 和 state `reset` 中至少需要一个。

注释 

注意

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

示例 

- name: Set the boot.quiet DB variable on the BIG-IP
  bigip_sys_db:
    key: boot.quiet
    value: disable
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Disable the initial setup screen
  bigip_sys_db:
    key: setup.run
    value: false
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Reset the initial setup screen
  bigip_sys_db:
    key: setup.run
    state: reset
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

Key	描述
default_value 字符串	key 的默认值。已返回：已更改且成功示例： `"True"`
name 字符串	系统数据库中的 key。已返回：已更改且成功示例： `"setup.run"`
value 字符串	您将 key 设置为的值。已返回：已更改且成功示例： `"False"`

作者

Tim Rupp (@caphrim007)