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

Примечание

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

Для его установки используйте: 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 строка	Варианты: on_create always ←	Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент укажет модулю, когда менять пароль. При установке в `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/net_user_module.html