f5networks.f5_modules.bigip_device_httpd 模块 – 管理 BIG-IP 系统上的 HTTPD 相关设置

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP 上的 HTTPD 相关设置。当您想要设置 GUI 超时和其他 TMUI 相关设置时，这些设置非常有用。

要求 

执行此模块的主机需要以下要求。

requests

参数 

参数	注释
allow 列表 / 元素=字符串	如果启用了 HTTPD 访问，则指定可以与此系统通信的其他系统的 IP 地址或地址范围。要指定所有地址，请使用值 `all`。可以指定 IP 地址，例如 172.27.1.10。可以指定 IP 范围，例如 172.27.. 或 172.27.0.0/255.255.0.0。
auth_name 字符串	设置 BIG-IP 身份验证领域名称。
auth_pam_dashboard_timeout 布尔值	设置是否使 BIG-IP 仪表板超时。选择 `false` `true`
auth_pam_idle_timeout 整数	设置 GUI 自动注销的超时时间，以秒为单位。
auth_pam_validate_ip 布尔值	设置 authPamValidateIp 设置。选择 `false` `true`
fast_cgi_timeout 整数	设置 FastCGI 的超时时间。
hostname_lookup 布尔值	设置是否显示主机名（如果可能）。选择 `false` `true`
log_level 字符串	设置最小 HTTPD 日志级别。选择 `"alert"` `"crit"` `"debug"` `"emerg"` `"error"` `"info"` `"notice"` `"warn"`
max_clients 整数	设置一次可以连接到 GUI 的最大客户端数。
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` ← （默认）
redirect_http_to_https 布尔值	是否将对 GUI 的 HTTP 请求重定向到 HTTPS。选择 `false` `true`
ssl_cipher_suite 任意	指定系统使用的密码。套件中的值用冒号 (:) 分隔。可以字符串或列表形式指定。列表形式是提供密码套件的推荐方法。有关用法，请参见示例。使用值 `default` 将密码套件设置为系统默认值。此值等效于指定列表 `ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES128-SHA,ECDHE-RSA-AES256-SHA, ECDHE-RSA-AES128-SHA256,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-SHA,ECDHE-ECDSA-AES256-SHA, ECDHE-ECDSA-AES128-SHA256,ECDHE-ECDSA-AES256-SHA384,AES128-GCM-SHA256, AES256-GCM-SHA384,AES128-SHA,AES256-SHA,AES128-SHA256,AES256-SHA256, ECDHE-RSA-DES-CBC3-SHA,ECDHE-ECDSA-DES-CBC3-SHA,DES-CBC3-SHA`。
ssl_port 整数	系统应在其上侦听的 HTTPS 端口。
ssl_protocols 任意	在管理控制台上接受的 SSL 协议列表。以 Apache mod_ssl SSLProtocol 指令接受的格式表示的以空格分隔的令牌列表。可以字符串或列表形式指定。列表形式是提供密码套件的推荐方法。有关用法，请参见示例。使用值 `default` 将 SSL 协议设置为系统默认值。此值等效于指定列表 `all,-SSLv2,-SSLv3`。

说明 

注意

主机上需要 requests Python 包。这就像运行 pip install requests 一样简单。
有关使用 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 BIG-IP authentication realm name
  bigip_device_httpd:
    auth_name: BIG-IP
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set the auth pam timeout to 3600 seconds
  bigip_device_httpd:
    auth_pam_idle_timeout: 1200
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set the validate IP settings
  bigip_device_httpd:
    auth_pam_validate_ip: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set SSL cipher suite by list
  bigip_device_httpd:
    ssl_cipher_suite:
      - ECDHE-RSA-AES128-GCM-SHA256
      - ECDHE-RSA-AES256-GCM-SHA384
      - ECDHE-RSA-AES128-SHA
      - AES256-SHA256
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set SSL cipher suite by string
  bigip_device_httpd:
    ssl_cipher_suite: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA:AES256-SHA256
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set SSL protocols by list
  bigip_device_httpd:
    ssl_protocols:
      - all
      - -SSLv2
      - -SSLv3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set SSL protocols by string
  bigip_device_httpd:
    ssl_protocols: all -SSLv2 -SSLv3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
auth_name 字符串	新的身份验证领域名称。返回: changed 示例: `"foo"`
auth_pam_dashboard_timeout 布尔值	BIG-IP 仪表板是否会超时。返回: changed 示例: `false`
auth_pam_idle_timeout 字符串	GUI 超时的新秒数。返回: changed 示例: `"1200"`
auth_pam_validate_ip 布尔值	新的 authPamValidateIp 设置。返回: changed 示例: `true`
fast_cgi_timeout 整数	FastCGI 的新超时时间。返回: changed 示例: `500`
hostname_lookup 布尔值	是否显示主机名（如果可能）。返回: changed 示例: `true`
log_level 字符串	新的最低 HTTPD 日志级别。返回: changed 示例: `"crit"`
max_clients 整数	可同时连接到 GUI 的最大客户端数。返回: changed 示例: `20`
redirect_http_to_https 布尔值	是否将对 GUI 的 HTTP 请求重定向到 HTTPS。返回: changed 示例: `true`
ssl_cipher_suite 字符串	系统使用的新密码。返回: changed 示例: `"ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA"`
ssl_cipher_suite_list 字符串	系统使用的新密码列表。返回: changed 示例: `"['ECDHE-RSA-AES256-GCM-SHA384', 'ECDHE-RSA-AES128-SHA']"`
ssl_port 整数	要监听的新 HTTPS 端口。返回: changed 示例: `10443`
ssl_protocols 字符串	管理控制台上要接受的新 SSL 协议列表。返回: changed 示例: `"all -SSLv2 -SSLv3"`

作者

Joe Reifel (@JoeReifel)
Tim Rupp (@caphrim007)