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，或现在。默认值为 None，表示 state=[file,directory,link,hard] 的默认值为 preserve，state=touch 的默认值为 now

aggregate

别名：users, collection

列表 / 元素=字典

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

access_time

字符串

此参数指示应将文件的访问时间设置为的时间。当不需要修改时应保留，使用默认时间格式时为 YYYYMMDDHHMM.SS，或现在。默认值为 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"

更新密码

字符串

此参数将指示模块何时更改密码。当设置为 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)