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` пароль будет обновлён только в случае создания имени пользователя.

Примечания

Примечание

Этот модуль поддерживается на 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
    password: "{{ new_password }}"
    update_password: always
    state: present

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

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

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

Статус

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

Поддержка Red Hat

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

Авторы

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