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 -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в Руководстве по сети. Объект словаря, содержащий данные подключения.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт, который используется при построении подключения к удаленному устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку.
	username -		Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
purge boolean		Варианты: нет ← да	Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий набор определенных пользователей).
state -		Варианты: present ← absent	Настраивает состояние определения имени пользователя в отношении конфигурации работы устройства. При значении present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя(на) пользователя(ей) не должно быть в активной конфигурации устройства.
update_password -		Варианты: при создании всегда ←	Поскольку пароли шифруются в рабочей конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При значении `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']

Статус

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

Поддержка Red Hat

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