arista.eos.eos_user – Управление коллекцией локальных пользователей на устройствах EOS
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в плейбуке укажите: arista.eos.eos_user.
Новое в версии 1.0.0: модуля arista.eos
Краткое описание
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Arista EOS. Он позволяет плейбукам управлять как отдельными именами пользователей, так и всей коллекцией имен в текущей конфигурации. Он также поддерживает удаление имен пользователей из конфигурации, которые не определены явно.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве Arista EOS. Элементы списка могут быть именем пользователя или хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом username. псевдонимы: users, collection | ||
| configured_password строка | Пароль, который необходимо настроить на удалённом устройстве Arista EOS. Пароль должен быть предоставлен в открытом виде и будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name строка | Имя пользователя, которое необходимо настроить на удалённом устройстве Arista EOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. Обратите внимание, что этот параметр отличается от provider username. | ||
| nopassword булево |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. | |
| privilege целое число | Аргумент privilege настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15. | ||
| role строка | Настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве. | ||
| sshkey строка | Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state строка |
| Настраивает состояние определения имени пользователя по отношению к конфигурации работы устройства. При установке в present имя(на) пользователя должно быть настроено в активной конфигурации устройства, а при установке в absent имя(на) пользователя не должно быть в активной конфигурации устройства. | |
| update_password строка |
| Так как пароли зашифрованы в конфигурации устройства, этот аргумент указывает модулю, когда необходимо изменить пароль. При установке в always, пароль всегда будет обновлён на устройстве, а при установке в on_create, пароль будет обновлён только в случае создания имени пользователя. | |
| configured_password строка | Пароль, который необходимо настроить на удалённом устройстве Arista EOS. Пароль должен быть предоставлен в открытом виде и будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name строка | Имя пользователя, которое необходимо настроить на удалённом устройстве Arista EOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate . Обратите внимание, что этот параметр отличается от provider username. | ||
| nopassword булево |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. | |
| privilege целое число | Аргумент privilege настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуем использовать connection: httpapi для eAPI.Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для использования, если требуется переход в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент используется для транспортов cli или eapi. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 0 | Указывает порт для создания подключения к удалённому устройству. Это значение применяется к транспорту cli или eapi. Значение порта по умолчанию устанавливается на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile путь | Указывает файл ключа SSH для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| use_proxy булево |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено в yes, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не eapi, это значение игнорируется. | |
| purge булево |
| Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удалён в соответствии с ограничениями EOS. | |
| role строка | Настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве. | ||
| sshkey строка | Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state строка |
| Настраивает состояние определения имени пользователя по отношению к конфигурации работы устройства. При установке в present имя(на) пользователя должно быть настроено в активной конфигурации устройства, а при установке в absent имя(на) пользователя не должно быть в активной конфигурации устройства. | |
| update_password строка |
| Так как пароли зашифрованы в конфигурации устройства, этот аргумент указывает модулю, когда следует изменить пароль. Если установлено значение always, пароль всегда будет обновлен на устройстве, а если установлено значение on_create, пароль будет обновлен только в случае создания пользователя. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Для получения информации об использовании CLI, eAPI и привилегированного режима см. Руководство по параметрам платформы EOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista здесь.
Примеры
- name: create a new user
arista.eos.eos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
arista.eos.eos_user:
purge: yes
- name: set multiple users to privilege level 15
arista.eos.eos_user:
aggregate:
- name: netop
- name: netend
privilege: 15
state: present
- name: Change Password for User netop
arista.eos.eos_user:
username: netop
configured_password: '{{ new_password }}'
update_password: always
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['name ansible secret password', 'name admin secret admin'] |
| session_name строка | при изменении True | Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Пример: ansible_1479315771 |
Авторы
- Peter Sprygada (@privateip)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/arista/eos/eos_user_module.html
