f5networks.f5_modules.bigip_sys_global 模块 – 管理 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_global

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 全局设置。

参数

参数

注释

banner_text

字符串

指定在咨询横幅中显示的文本。

console_timeout

整数

指定系统在注销已登录用户之前的空闲秒数。

gui_audit

布尔值

f5networks.f5_modules 1.23.0 中新增

truefalse,指定系统 GUI 是否记录审核消息。

选项

  • false

  • true

gui_setup

布尔值

truefalse,浏览器中基于配置实用程序的设置实用程序。

选项

  • false

  • true

lcd_display

布尔值

true 时,指定系统菜单在设备正面的 LCD 屏幕上显示。此设置在 VE 平台上使用时无效。

选项

  • false

  • true

mgmt_dhcp

布尔值

指定是否在管理接口上启用 DHCP 客户端。

选项

  • false

  • true

net_reboot

布尔值

true 时,指定下次重新启动系统时,系统启动到网络上的 ISO 映像,而不是内部媒体驱动器。

选项

  • false

  • true

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 ← (默认)

quiet_boot

布尔值

true 时,指定系统在引导周期中抑制控制台上的信息文本。当 no 时,系统在引导周期中在控制台上显示消息和信息文本。

选项

  • false

  • true

security_banner

布尔值

指定系统是否在登录屏幕上显示咨询消息。

选项

  • false

  • true

state

字符串

系统上变量的状态。当 present 时,保证现有变量设置为 value

选项

  • "present" ← (默认)

备注

注意

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

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

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

示例

- name: Disable the setup utility
  bigip_sys_global:
    gui_setup: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

描述

banner_text

字符串

在告警横幅中显示的新文本。

返回:已更改

示例: "这是一个公司设备。请勿触摸。"

console_timeout

整数

系统注销已登录用户的非活动新秒数。

返回:已更改

示例: 600

gui_audit

布尔值

GUI审计的新设置。

返回:已更改

示例: true

gui_setup

布尔值

安装程序实用程序的新设置。

返回:已更改

示例: true

lcd_display

布尔值

在LCD上显示系统菜单的新设置。

返回:已更改

示例: true

mgmt_dhcp

布尔值

mgmt接口是否应使用DHCP的新设置。

返回:已更改

示例: true

net_reboot

布尔值

系统是否应启动到网络上的ISO的新设置。

返回:已更改

示例: true

quiet_boot

布尔值

系统是否应在启动期间抑制向控制台的信息的新设置。

返回:已更改

示例: true

security_banner

布尔值

系统是否应在登录屏幕上显示告警消息的新设置。

返回:已更改

示例: true

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)