модуль cisco.nxos.nxos_user — управление набором локальных пользователей на устройствах Nexus

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать модуль в плейбуке, укажите: cisco.nxos.nxos_user.

Добавлено в cisco.nxos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять отдельными именами пользователей или набором имен пользователей в текущей активной конфигурации. Кроме того, он поддерживает удаление из конфигурации имен пользователей, которые не были заданы явно.

Примечание

Для этого модуля предусмотрен соответствующий плагин действий.

Псевдонимы: user

Параметры

Параметр	Комментарии
aggregate псевдонимы: users, collection list / elements=dictionary	Набор объектов пользователей, которые необходимо настроить на удаленном устройстве Cisco Nexus. Элементы списка могут содержать либо имя пользователя, либо хеш с именем пользователя и свойствами. Этот аргумент взаимоисключающий с аргументом `name`.
configured_password string	Пароль, который необходимо настроить на сетевом устройстве. Пароль необходимо указать в открытом виде; на устройстве он будет зашифрован.
hashed_password string	Хешированный пароль, который необходимо настроить на сетевом устройстве. Пароль уже должен быть зашифрован.
name string	Имя пользователя, которое необходимо настроить на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`.
roles псевдонимы: role list / elements=string	Аргумент `role` задает роль пользователя в активной конфигурации устройства. Аргумент принимает строковое значение с именем роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey string	Аргумент `sshkey` задает открытый ключ SSH для настройки пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state string	Аргумент `state` задает состояние определения пользователя относительно рабочей конфигурации устройства. Если задано значение present, имена пользователей должны присутствовать в активной конфигурации устройства, а если задано значение absent, имена пользователей не должны присутствовать в активной конфигурации устройства. Варианты: `"present"` `"absent"`
update_password string	Поскольку пароли в активной конфигурации устройства зашифрованы, этот аргумент указывает модулю, когда следует менять пароль. Если задано значение `always`, пароль будет обновляться на устройстве всегда, а если задано значение `on_create` — только при создании имени пользователя. Варианты: `"on_create"` `"always"`
configured_password string	Пароль, который необходимо настроить на сетевом устройстве. Пароль необходимо указать в открытом виде; на устройстве он будет зашифрован.
hashed_password string	Хешированный пароль, который необходимо настроить на сетевом устройстве. Пароль уже должен быть зашифрован.
name string	Имя пользователя, которое необходимо настроить на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`.
purge boolean	Аргумент `purge` указывает модулю считать определение ресурса исчерпывающим. Он удалит все ранее настроенные на устройстве имена пользователей, кроме пользователя `admin`, которого нельзя удалить из-за ограничений nxos. Варианты: `false` ← (по умолчанию) `true`
roles псевдонимы: role list / elements=string	Аргумент `role` задает роль пользователя в активной конфигурации устройства. Аргумент принимает строковое значение с именем роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey string	Аргумент `sshkey` задает открытый ключ SSH для настройки пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state string	Аргумент `state` задает состояние определения пользователя относительно рабочей конфигурации устройства. Если задано значение present, имена пользователей должны присутствовать в активной конфигурации устройства, а если задано значение absent, имена пользователей не должны присутствовать в активной конфигурации устройства. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_password string	Поскольку пароли в активной конфигурации устройства зашифрованы, этот аргумент указывает модулю, когда следует менять пароль. Если задано значение `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://www.ansible.com/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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
commands list / elements=string	Список команд режима конфигурации, отправляемых устройству Возвращается: всегда Пример: `["name ansible", "name ansible password password"]`

Авторы

Peter Sprygada (@privateip)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_user_module.html