community.network.icx_user 模块 – 管理 Ruckus ICX 7000 系列交换机上的用户帐户。

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.network。

要在 playbook 中使用它，请指定： community.network.icx_user。

注意

community.network 集合已弃用，并将从 Ansible 12 中移除。请参阅 讨论主题 以了解更多信息。

已弃用

在以下版本中移除：

6.0.0 版本

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

  • 此模块创建或更新网络设备上的用户帐户。它允许 playbook 管理单个用户名或当前运行配置中用户名的集合。它还支持从配置中清除未明确定义的用户名。

别名：network.icx.icx_user

参数

参数

注释

access_time

字符串

此参数指示应将文件的访问时间设置为多少。如果不需要修改，则应保留；使用默认时间格式时为 YYYYMMDDHHMM.SS，或 now。默认为 None，这意味着对于 state=[file,directory,link,hard]，默认值为 preserve，而对于 state=touch，默认值为 now。

aggregate

别名：users, collection

列表 / 元素=字典

要在远程 ICX 设备上配置的用户名对象集。列表项可以是用户名，也可以是用户名和属性的哈希值。此参数与 name 参数互斥。

access_time

字符串

此参数指示应将文件的访问时间设置为多少。如果不需要修改，则应保留；使用默认时间格式时为 YYYYMMDDHHMM.SS，或 now。默认为 None，这意味着对于 state=[file,directory,link,hard]，默认值为 preserve，而对于 state=touch，默认值为 now。

check_running_config

布尔值

检查运行配置。这可以设置为环境变量。模块将使用环境变量值（默认为 True），除非通过将其指定为模块参数来覆盖它。

选项

  • false

  • true

configured_password

字符串

要在 ICX 设备上配置的密码。

name

字符串 / 必需

要在 ICX 设备上配置的用户名。

nopassword

布尔值

定义用户名而不分配密码。这将允许用户登录系统而无需密码验证。

选项

  • false

  • true

privilege

字符串

要授予用户的权限级别

选项

  • "0"

  • "4"

  • "5"

state

字符串

配置用户名定义与其相关的设备操作配置的状态。设置为 *present* 时，用户名应配置在设备活动配置中；设置为 *absent* 时，用户名不应在设备活动配置中。

选项

  • "present"

  • "absent"

update_password

字符串

此参数指示何时更改密码。设置为 always 时，将始终更新设备中的密码；设置为 on_create 时，只有在创建用户名时才会更新密码。

选项

  • "on_create"

  • "always"

check_running_config

布尔值

检查运行配置。这可以设置为环境变量。模块将使用环境变量值（默认为 True），除非通过将其指定为模块参数来覆盖它。

选项

  • false

  • true ← (默认)

configured_password

字符串

要在 ICX 设备上配置的密码。

name

字符串 / 必需

要在 ICX 设备上配置的用户名。

nopassword

布尔值

定义用户名而不分配密码。这将允许用户登录系统而无需密码验证。

选项

  • false ← (默认)

  • true

privilege

字符串

要授予用户的权限级别

选项

  • "0"

  • "4"

  • "5"

purge

布尔值

如果设置为 true，模块将删除设备上先前配置的任何用户名，除了当前定义的用户集。

选项

  • false ← (默认)

  • true

state

字符串

配置用户名定义与其相关的设备操作配置的状态。设置为 *present* 时，用户名应配置在设备活动配置中；设置为 *absent* 时，用户名不应在设备活动配置中。

选项

  • "present" ← (默认)

  • "absent"

update_password

字符串

此参数指示何时更改密码。设置为 always 时，将始终更新设备中的密码；设置为 on_create 时，只有在创建用户名时才会更新密码。

选项

  • "on_create"

  • "always" ← (默认)

注释

注意

示例

- name: Create a new user without password
  community.network.icx_user:
    name: user1
    nopassword: true

- name: Create a new user with password
  community.network.icx_user:
    name: user1
    configured_password: 'newpassword'

- name: Remove users
  community.network.icx_user:
    name: user1
    state: absent

- name: Set user privilege level to 5
  community.network.icx_user:
    name: user1
    privilege: 5

返回值

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

键

描述

命令

列表 / 元素=字符串

要发送到设备的配置模式命令列表

返回： 始终

示例： ["username ansible nopassword", "username ansible password-string alethea123", "no username ansible", "username ansible privilege 5", "username ansible enable"]

状态

  • 此模块将在 6.0.0 版本中移除。[已弃用]

  • 更多信息请参见 已弃用。

作者

  • Ruckus Wireless (@Commscope)