f5networks.f5_modules.bigip_remote_user 模块 – 管理 BIG-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_remote_user。

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理 BIG-IP 系统上远程用户帐户的默认设置。

参数 

参数	注释
console_access 布尔值	启用或禁用所有远程用户帐户的默认控制台访问。默认系统值为 `disabled`。选项 `false` `true`
default_partition 字符串	指定所有远程用户帐户的默认分区。默认系统值为 `all`，表示所有分区。
default_role 字符串	指定所有远程用户帐户的默认角色。默认系统值为 `no-access`。选项 `"acceleration-policy-editor"` `"admin"` `"application-editor"` `"auditor"` `"certificate-manager"` `"firewall-manager"` `"fraud-protection-manager"` `"guest"` `"irule-manager"` `"manager"` `"no-access"` `"operator"` `"resource-admin"` `"user-manager"` `"web-application-security-administrator"` `"web-application-security-editor"`
description 字符串	用户定义的描述。
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` ← (默认)

说明 

注意

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

示例 

- name: Modify default partition and console access
  bigip_remote_user:
    default_partition: Common
    console_access: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify default role, partition and console access
  bigip_remote_user:
    default_partition: Common
    default_role: manager
    console_access: true
    description: "Changed new settings"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Revert to default settings
  bigip_remote_user:
    default_partition: all
    default_role: "no-access"
    console_access: false
    description: ""
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
console_access 布尔值	所有远程用户帐户的默认控制台访问权限。返回: changed 示例: `false`
default_partition 字符串	所有远程用户帐户的默认分区。返回: changed 示例: `"Common"`
default_role 字符串	所有远程用户帐户的默认角色。返回: changed 示例: `"auditor"`
description 字符串	用户定义的描述。返回: changed 示例: `"Foo is bar"`

作者

Wojciech Wypior (@wojtek0806)