eos_user – Управление списком локальных пользователей на устройствах EOS
Описание
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Arista EOS. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо списком имен пользователей в текущей конфигурации. Он также поддерживает очистку имен пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - добавлен в 2.4 | Набор объектов пользователей, которые должны быть настроены на удалённом устройстве Arista EOS. Элементы списка могут быть либо именем пользователя, либо хешем из имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом username. псевдонимы: users, collection | ||
| auth_pass строка | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент не имеет значения. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| configured_password - добавлен в 2.4 | Пароль, который необходимо настроить на удалённом устройстве Arista EOS. Пароль должен быть указан открытым текстом, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name - добавлен в 2.4 | Имя пользователя, которое необходимо настроить на удалённом устройстве Arista EOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. Обратите внимание, что этот параметр отличается от provider username. | ||
| nopassword булево |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. | |
| privilege - | Аргумент privilege настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент не имеет значения. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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 булево добавлен в 2.5 |
| Если 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
eos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
eos_user:
purge: yes
- name: set multiple users to privilege level 15
eos_user:
aggregate:
- name: netop
- name: netend
privilege: 15
state: present
- name: Change Password for User netop
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 |
Статус
- Гарантируется, что интерфейс этого модуля не будет совместим со старыми версиями. [preview]
- Этот модуль поддерживается командой Ansible Network Команда Ansible Network. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье Базы знаний Red Hat.
Авторы
- Peter Sprygada (@privateip)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/eos_user_module.html
