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。
要在剧本中使用它,请指定:f5networks.f5_modules.bigip_remote_user。
f5networks.f5_modules 1.0.0 中的新增功能
概要
- 管理 BIG-IP 系统上远程用户帐户的默认设置。 
参数
| 参数 | 注释 | 
|---|---|
| 启用或禁用所有远程用户帐户的默认控制台访问。 默认系统值为  选项 
 | |
| 指定所有远程用户帐户的默认分区。 默认系统值为  | |
| 指定所有远程用户帐户的默认角色。 默认系统值为  选项 
 | |
| 用户定义的描述。 | |
| 包含连接详细信息的字典对象。 | |
| 配置 auth provider 以从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时才会真正使用。 | |
| 如果为  您可以通过设置环境变量  先前使用的变量  选项 
 | |
| 用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量  | |
| BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量  | |
| BIG-IP 服务器端口。 您可以通过设置环境变量  默认:  | |
| 指定与网络设备通信的超时时间(秒),用于连接或发送命令。如果在操作完成之前超时,模块将报错。 | |
| 配置连接到远程设备时要使用的传输连接。 选项 
 | |
| 连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理员权限。 您可以通过设置环境变量  | |
| 如果为  您可以通过设置环境变量  选项 
 | 
备注
注意
- 有关使用 Ansible 管理 F5 网络设备的更多信息,请参见 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
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 所有远程用户帐户的默认控制台访问。 返回:已更改 示例:  | |
| 所有远程用户帐户的默认分区。 返回:已更改 示例:  | |
| 所有远程用户帐户的默认角色。 返回:已更改 示例:  | |
| 用户自定义描述。 返回:已更改 示例:  | 
