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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate			Набор объектов имен пользователей, которые должны быть настроены на удаленном устройстве VyOS. Элементы списка могут быть либо именем пользователя, либо словарем с именем пользователя и свойствами. Этот аргумент взаимоисключает аргумент `name`. Псевдонимы: users, collection
configured_password			Пароль, который должен быть настроен на устройстве VyOS. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от `provider password`.
full_name			Аргумент `full_name` предоставляет полное имя учетной записи пользователя, которое должно быть создано на удаленном устройстве. Этот аргумент принимает любое текстовое значение.
level			Аргумент `level` настраивает уровень пользователя при входе в систему. Этот аргумент принимает строковые значения admin или operator. Псевдонимы: role
name			Имя пользователя, которое должно быть настроено на устройстве VyOS. Этот аргумент принимает строковое значение и взаимоисключает аргумент `aggregate`. Обратите внимание, что этот параметр отличается от `provider username`.
provider		Значение по умолчанию: None	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации, см. Руководство по сети. Объект словаря, содержащий данные подключения.
	username		Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port	Значение по умолчанию: 22	Указывает порт для подключения к удаленному устройству.
purge		Варианты: no ← yes	Указывает модулю считать определение ресурса абсолютным. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий набор определенных пользователей).
state		Варианты: present ← absent	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При значении present имя(на) пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя(на) пользователя(ей) не должно быть в активной конфигурации устройства.
update_password		Варианты: on_create always ←	Так как пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При значении `always`, пароль всегда будет обновлен на устройстве, а при значении `on_create` пароль будет обновлен только в случае создания имени пользователя.

Примечания

Примечание

Проверено на VYOS 1.1.7
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. Руководство по Ansible для сетей

Примеры

- 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']

Статус

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

Поддержка

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

Автор

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.5/modules/vyos_user_module.html