community.network.cnos_user 模块 – 管理联想 CNOS 设备上的本地用户集合

注意

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

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

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

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

注意

community.network 集合已被弃用，并将从 Ansible 12 中移除。有关更多信息，请参见 讨论主题。

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

  • 此模块提供对联想 CNOS 设备上配置的本地用户名进行声明式管理。它允许 playbook 管理单个用户名或当前运行配置中的用户名集合。它还支持从配置中清除未明确定义的用户名。

别名：network.cnos.cnos_user

参数

参数

注释

aggregate

别名：users, collection

字符串

要在远程联想 CNOS 设备上配置的一组用户名对象。列表条目可以是用户名或用户名和属性的哈希值。此参数与 name 参数互斥。

configured_password

字符串

要在网络设备上配置的密码。密码需要以明文形式提供，并在设备上加密。请注意，此选项与 provider password 不同。

name

字符串

要在远程联想 CNOS 设备上配置的用户名。此参数接受字符串值，并与 aggregate 参数互斥。

purge

布尔值

purge 参数指示模块将资源定义视为绝对的。它将删除设备上以前配置的任何用户名，但根据 cnos 约束无法删除的 `admin` 用户除外。

选项

  • false ← (默认)

  • true

role

别名：roles

字符串

role 参数在设备运行配置中为用户名配置角色。此参数接受定义角色名称的字符串值。此参数不检查角色是否已在设备上配置。

sshkey

字符串

sshkey 参数定义要为用户名配置的 SSH 公钥。此参数接受有效的 SSH 密钥值。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

update_password

字符串

由于密码在设备运行配置中已加密，因此此参数将指示模块何时更改密码。设置为 always 时，密码将始终在设备中更新；设置为 on_create 时，只有在创建用户名时才会更新密码。

选项

  • "on_create"

  • "always" ← (默认)

示例

- name: Create a new user
  community.network.cnos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: Remove all users except admin
  community.network.cnos_user:
    purge: true

- name: Set multiple users role
  aggregate:
    - name: Netop
    - name: Netend
  role: network-operator
  state: present

返回值

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

键

描述

commands

列表 / 元素=字符串

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

返回值：始终

示例： ["name ansible", "name ansible password password"]

delta

字符串

执行所有操作所花费的时间

返回值：始终

示例： "0:00:10.469466"

end

字符串

作业结束时间

返回值：始终

示例： "2016-11-16 10:38:25.595612"

start

字符串

作业开始时间

返回值：始终

示例： "2016-11-16 10:38:15.126146"

状态

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

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

作者

  • Anil Kumar Muraleedharan (@amuraleedhar)