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

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.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 список / элементы=словарь	Набор объектов имен пользователей, которые должны быть настроены на удалённом устройстве Cisco Nexus. Элементы списка могут представлять собой имя пользователя или хеш-таблицу с именем пользователя и свойствами. Этот аргумент взаимоисключающий с аргументом `name`.
configured_password строка	Пароль, который должен быть настроен на сетевом устройстве. Пароль должен быть предоставлен в виде открытого текста, и он будет зашифрован на устройстве.
hashed_password строка	Хешированный пароль, который должен быть настроен на сетевом устройстве. Пароль должен быть уже зашифрован.
name строка	Имя пользователя, которое должно быть настроено на удалённом устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`.
roles алиасы: роль список / элементы=строка	Аргумент `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` настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, была ли роль настроена на устройстве.
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 Platform Options <nxos_platform_options>`
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами обратитесь к руководству :ref:`Ansible Network Guide <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 список / элементы=строка	Список команд режима конфигурации для отправки на устройство Возвращается: всегда Пример: `["name ansible", "name ansible password password"]`

Авторы

Peter Sprygada (@privateip)

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

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