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	нет	present	present absent	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(ей) не должно быть в активной конфигурации устройства.
update_password	нет	always	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	Список команд режима конфигурации, которые необходимо отправить на устройство	всегда	список	['username ansible secret password', 'username admin secret admin']

Статус

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке этого модуля Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочтите Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

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