net_user - Управление агрегированными локальными пользователями на сетевом устройстве
Новая версия 2.4.
Обзор
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на сетевых устройствах. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо совокупностью имён пользователей в текущей рабочей конфигурации. Он также поддерживает удаление имён пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aggregate | Набор объектов имён пользователей, которые должны быть настроены на удалённом сетевом устройстве. Элементы списка могут быть либо именем пользователя, либо хэшем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name. | |
| configured_password | Пароль, который должен быть настроен на удалённом сетевом устройстве. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | |
| name | Имя пользователя, которое должно быть настроено на удалённом сетевом устройстве. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. Обратите внимание, что этот параметр отличается от provider username. | |
| nopassword |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. |
| privilege | Аргумент privilege настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15. | |
| purge |
| Инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит любые ранее настроенные имена пользователей на устройстве за исключением пользователя `admin` (текущий набор определённых пользователей). |
| role | Настраивает роль для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве. | |
| sshkey | Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает действительное значение ключа SSH. | |
| state |
| Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При значении наличие имя(а) пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении отсутствует имя(а) пользователя(ей) не должно быть в активной конфигурации устройства. |
| update_password |
| Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент будет указывать, когда необходимо изменить пароль. При значении 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 список | всегда | Список команд режима конфигурации, которые необходимо отправить на устройство Пример: ['username ansible secret password', 'username admin secret admin'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.5/modules/net_user_module.html
