cisco.nxos.nxos_user 模块 – 管理 Nexus 设备上的本地用户集合

注意

此模块是 cisco.nxos 集合 (版本 9.2.1) 的一部分。

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

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

要在 playbook 中使用它，请指定： cisco.nxos.nxos_user。

cisco.nxos 1.0.0 中的新增功能

概要 

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

参数 

参数	注释
aggregate 别名：users, collection 列表 / 元素=字典	要在远程 Cisco Nexus 设备上配置的用户名对象集。列表项可以是用户名或用户名和属性的哈希值。此参数与 `name` 参数互斥。
configured_password 字符串	要在网络设备上配置的密码。密码需要以明文形式提供，并在设备上进行加密。
hashed_password 字符串	要在网络设备上配置的哈希密码。密码需要已经加密。
name 字符串	要在远程 Cisco Nexus 设备上配置的用户名。此参数接受字符串值，并与 `aggregate` 参数互斥。
roles 别名：role 列表 / 元素=字符串	`role` 参数配置设备运行配置中用户名的角色。该参数接受定义角色名称的字符串值。此参数不检查角色是否已在设备上配置。
sshkey 字符串	`sshkey` 参数定义要为用户名配置的 SSH 公钥。此参数接受有效的 SSH 密钥值。
state 字符串	`state` 参数配置用户名称定义与其相关的设备操作配置的状态。设置为 present 时，用户名应配置在设备活动配置中；设置为 absent 时，用户名不应在设备活动配置中。选项 `"present"` `"absent"`
update_password 字符串	由于密码在设备运行配置中已加密，因此此参数将指示模块何时更改密码。设置为 `always` 时，密码将始终在设备中更新；设置为 `on_create` 时，只有在创建用户名时才会更新密码。选项 `"on_create"` `"always"`
configured_password 字符串	要在网络设备上配置的密码。密码需要以明文形式提供，并在设备上进行加密。
hashed_password 字符串	要在网络设备上配置的哈希密码。密码需要已经加密。
name 字符串	要在远程 Cisco Nexus 设备上配置的用户名。此参数接受字符串值，并与 `aggregate` 参数互斥。
purge 布尔值	`purge` 参数指示模块将资源定义视为绝对的。它将删除设备上以前配置的任何用户名，但 `admin` 用户除外，因为根据 nxos 约束，该用户无法删除。选项 `false` ← (默认) `true`
roles 别名：role 列表 / 元素=字符串	`role` 参数配置设备运行配置中用户名的角色。该参数接受定义角色名称的字符串值。此参数不检查角色是否已在设备上配置。
sshkey 字符串	`sshkey` 参数定义要为用户名配置的 SSH 公钥。此参数接受有效的 SSH 密钥值。
state 字符串	`state` 参数配置用户名称定义与其相关的设备操作配置的状态。设置为 present 时，用户名应配置在设备活动配置中；设置为 absent 时，用户名不应在设备活动配置中。选项 `"present"` ← (默认) `"absent"`
update_password 字符串	由于密码在设备运行配置中已加密，因此此参数将指示模块何时更改密码。设置为 `always` 时，密码将始终在设备中更新；设置为 `on_create` 时，只有在创建用户名时才会更新密码。选项 `"on_create"` `"always"` ← (默认)

注释 

注意

对 Cisco MDS 的有限支持
有关使用 CLI 和 NX-API 的信息，请参阅：ref:`NXOS 平台选项指南 <nxos_platform_options>`
有关使用 Ansible 管理网络设备的更多信息，请参阅：ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息，请参阅 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例 

- name: create a new user
  cisco.nxos.nxos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: remove all users except admin
  cisco.nxos.nxos_user:
    purge: true

- name: set multiple users role
  cisco.nxos.nxos_user:
    aggregate:
      - name: netop
      - name: netend
    role: network-operator
  state: present

返回值 

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

键	描述
命令列表 / 元素=字符串	要发送到设备的配置模式命令列表返回：始终示例： `["name ansible", "name ansible password password"]`

作者

Peter Sprygada (@privateip)