vyos_user — Управление коллекцией локальных пользователей на устройстве VyOS

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

Описание
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус
- Информация о техническом обслуживании

Описание

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

Параметры

Параметр	Обязательный	По умолчанию	Варианты	Комментарии
aggregate	нет			Набор объектов имен пользователей, которые должны быть настроены на удалённом устройстве VyOS. Элементы списка могут быть либо именем пользователя, либо словарем из имени пользователя и свойств. Этот аргумент взаимоисключает с аргументом `name`. Псевдоним `users`.
configured_password	нет			Пароль, который должен быть настроен на устройстве VyOS. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не такой же, как `provider password`.
full_name	нет			Аргумент `full_name` предоставляет полное имя учётной записи пользователя, которая должна быть создана на удалённом устройстве. Этот аргумент принимает любое текстовое значение.
level	нет			Аргумент `level` настраивает уровень пользователя при входе в систему. Этот аргумент принимает строковые значения admin или operator.
name	нет			Имя пользователя, которое должно быть настроено на устройстве VyOS. Этот аргумент принимает строковое значение и взаимоисключает с аргументом `aggregate`. Обратите внимание, что этот параметр не такой же, как `provider username`.
purge	нет		да нет	Инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий набор определённых пользователей).
state	нет	present	present absent	Настраивает состояние определения имени пользователя в отношении рабочей конфигурации устройства. При установке в present имя(на) пользователя(ей) должно быть настроено в активной конфигурации устройства, а при установке в absent имя(на) пользователя(ей) не должно быть в активной конфигурации устройства
update_password	нет	always	on_create always	Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент укажет, когда необходимо изменить пароль. При установке в `always`, пароль всегда будет обновлён на устройстве, а при установке в `on_create`, пароль будет обновлён только в том случае, если пользователь создан.

Примеры

- name: create a new user
  vyos_user:
    name: ansible
    configured_password: password
    state: present
- name: remove all users except admin
  vyos_user:
    purge: yes
- name: set multiple users to level operator
  vyos_user:
    aggregate:
      - name: netop
      - name: netend
    level: operator
    state: present
- name: Change Password for User netop
  vyos_user:
    name: netop
    configured_password: "{{ new_password }}"
    update_password: always
    state: present

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

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

Имя	Описание	Возвращается	Тип	Пример
commands	Список команд режима конфигурации, которые необходимо отправить на устройство	всегда	список	['set system login user test level operator', 'set system login user authentication plaintext-password password']

Примечания

Примечание

Проверено на VYOS 1.1.7

Статус

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

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

Дополнительную информацию о поддержке этого модуля компанией 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/vyos_user_module.html