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`. Дополнительную информацию см. в Руководстве по сети. Объект dict, содержащий данные подключения.
	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 логическое значение		Варианты: нет ← да	Указывает модулю считать определение ресурса абсолютным. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий определенный набор пользователей).
state -		Варианты: present ← absent	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При значении present имя(на) пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя(на) пользователя(ей) не должно быть в активной конфигурации устройства.
update_password -		Варианты: при создании всегда ←	Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда изменить пароль. При значении `always`, пароль всегда обновляется на устройстве, а при значении `on_create` пароль обновляется только при создании имени пользователя.

Примечания

Примечание

Проверено на VyOS 1.1.8 (helium).
Этот модуль работает с подключением network_cli. См. параметры платформы VyOS.
Дополнительную информацию об использовании 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. [сеть]

Поддержка 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.9/modules/vyos_user_module.html