ansible.netcommon.net_user – (устаревший, удален после 2022-06-01) Управление совокупностью локальных пользователей на сетевом устройстве

Примечание

Этот плагин входит в коллекцию ansible.netcommon (версия 1.4.1).

Для его установки используйте: ansible-galaxy collection install ansible.netcommon.

Для использования в книге задач укажите: ansible.netcommon.net_user.

Новое в версии 1.0.0: из ansible.netcommon

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

УСТАРЕЛО

Удалено в: главной версии после 2022-06-01
Почему: Выпущены обновленные модули с более широким функционалом
Альтернатива: Используйте платформоспецифичный модуль “[netos]_user”

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

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

Примечания

Примечание

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

Примеры

- name: create a new user
  ansible.netcommon.net_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: remove all users except admin
  ansible.netcommon.net_user:
    purge: yes

- name: set multiple users to privilege level 15
  ansible.netcommon.net_user:
    aggregate:
    - {name: netop}
    - {name: netend}
    privilege: 15
    state: present

- name: Change Password for User netop
  ansible.netcommon.net_user:
    name: netop
    configured_password: '{{ new_password }}'
    update_password: always
    state: present

Возвращаемые значения

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

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

Статус

Этот модуль будет удалён в следующей основной версии после 2022-06-01. [устаревший]
Дополнительную информацию см. в УСТАРЕЛО.

Авторы

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.10/collections/ansible/netcommon/net_user_module.html