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

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

УСТАРЕЛО
Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТАРЕЛО

Удалено в Ansible:
	версия: 2.13
Почему:	Обновленные модули выпущены с большей функциональностью
Альтернатива:	Используйте модуль “[netos]_user” специфичный для платформы

Обзор

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

Параметры

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

Примечания

Примечание

Этот модуль поддерживается на сетевых платформах ansible_network_os. Подробности см. в Параметрах сетевой платформы.

Примеры

- 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
    configured_password: "{{ new_password }}"
    update_password: always
    state: present

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

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

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

Статус

Этот модуль будет удалён в версии 2.13. [устарел]
Дополнительная информация см. в УСТАРЕЛО.

Авторы

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.9/modules/net_user_module.html