net_user - Управление совокупностью локальных пользователей на сетевом устройстве

Новое в версии 2.4.

Описание
Параметры
Примеры
Значения возврата
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aggregate		Набор объектов имен пользователей, которые должны быть настроены на удалённом сетевом устройстве. Элементы списка могут представлять собой имя пользователя или хеш, содержащий имя пользователя и свойства. Этот аргумент взаимоисключающий с аргументом `name`.
configured_password		Пароль, который должен быть настроен на удалённом сетевом устройстве. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от `provider password`.
name		Имя пользователя, которое должно быть настроено на удалённом сетевом устройстве. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`. Обратите внимание, что этот параметр отличается от `provider username`.
nopassword bool	Варианты: no yes	Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем.
privilege		Аргумент `privilege` настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15.
purge bool	Варианты: no ← yes	Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит любые ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий набор определённых пользователей).
role		Настраивает роль для имени пользователя в активной конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey		Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает действительное значение ключа SSH.
state	Варианты: present ← absent	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в значение present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при установке в значение absent имя пользователя(ей) не должно быть в активной конфигурации устройства.
update_password	Варианты: on_create always ←	Поскольку пароли шифруются в активной конфигурации устройства, этот аргумент указывает, когда необходимо изменить пароль. При установке в значение `always`, пароль всегда будет обновлён на устройстве, а при установке в значение `on_create`, пароль будет обновлён только в случае создания имени пользователя.

Примеры

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

- name: remove all users except admin
  net_user:
    purge: yes

- name: set multiple users to privilege level 15
  net_user:
    aggregate:
      - { name: netop }
      - { name: netend }
    privilege: 15
    state: present

- name: Change Password for User netop
  net_user:
    name: netop
    password: "{{ new_password }}"
    update_password: always
    state: present

Значения возврата

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

Ключ	Возвращаемое значение	Описание
commands list	всегда	Список команд конфигурации для отправки на устройство Пример: ['username ansible secret password', 'username admin secret admin']

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible по работе с сетями. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются командой Ansible по работе с сетями, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний

Автор

Trishna Guha (@trishnaguha)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/net_user_module.html