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 булево		Варианты: нет ← да	Инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит всех ранее настроенных пользователей на устройстве, за исключением пользователя `admin` (текущий определенный набор пользователей).
state -		Варианты: настроен ← отсутствует	Настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При значении настроен, имя(а) пользователя(ей) должны быть настроены в активной конфигурации устройства, а при значении отсутствует — имя(а) пользователя(ей) не должно быть в активной конфигурации устройства.
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 по сетям. [сетевой]

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