vyos_user - Управление коллекцией локальных пользователей на устройстве VyOS
Новая версия с 2.4.
Обзор
- Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на сетевых устройствах. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо коллекцией имён пользователей в текущей рабочей конфигурации. Он также поддерживает очистку имён пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве VyOS. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name. Псевдонимы: пользователи, коллекция | ||
| configured_password | Пароль, который необходимо настроить на устройстве VyOS. Пароль должен быть предоставлен открытым текстом, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не такой же, как provider password. | ||
| full_name | Аргумент full_name предоставляет полное имя учётной записи пользователя, которое нужно создать на удалённом устройстве. Этот аргумент принимает любое текстовое значение. | ||
| level | Аргумент level настраивает уровень пользователя при входе в систему. Этот аргумент принимает строковые значения admin или operator.Псевдонимы: роль | ||
| name | Имя пользователя, которое необходимо настроить на устройстве VyOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. Обратите внимание, что этот параметр не такой же, как provider username. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Для получения дополнительной информации см. Руководство по сети. Объект типа dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт для использования при построении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| purge bool |
| Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий набор определённых пользователей). | |
| state |
| Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в 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'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Дополнительную информацию см. в Поддержка и техническое обслуживание модулей.
Список других модулей, поддерживаемых командой Ansible по работе с сетями, см. здесь.
Поддержка
Дополнительную информацию о поддержке данного модуля компанией 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.6/modules/vyos_user_module.html
