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

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

Описание
Параметры
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aggregate -		Набор объектов имен пользователей, которые должны быть настроены на удаленном сетевом устройстве. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом `name`.
configured_password -		Пароль, который должен быть настроен на удаленном сетевом устройстве. Пароль должен быть предоставлен в явном виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не эквивалентен `provider password`.
name -		Имя пользователя, которое должно быть настроено на удаленном сетевом устройстве. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`. Обратите внимание, что этот параметр не эквивалентен `provider username`.
nopassword boolean	Варианты: no yes	Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без проверки пароля.
privilege -		Аргумент `privilege` настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15.
purge boolean	Варианты: 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']

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается командой Ansible Network. [network]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний 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.7/modules/net_user_module.html