eos_user — Управление коллекцией локальных пользователей на устройствах EOS
Новая версия 2.3.
Описание
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах 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. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | По умолчанию: нет | Указывает пароль, который нужно использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не работает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. | |
| use_ssl |
| Настраивает transport для использования SSL, если значение true, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверенными сертификатами. Если аргумент transport не eapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт, который нужно использовать при построении подключения к удаленному устройству. Это значение относится как к cli, так и к eapi. Значение порта по умолчанию устанавливается для соответствующего стандартного порта транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| purge |
| Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удален в соответствии с ограничениями EOS. | |
| role | Настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, была ли настройка роли на устройстве. | ||
| sshkey | Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state |
| Настраивает состояние определения имени пользователя, относящегося к конфигурации устройства. При значении present имя пользователя(ы) должны быть настроены в активной конфигурации устройства, а при значении absent - имя пользователя(ы) не должно быть в активной конфигурации устройства | |
| update_password |
| Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда изменить пароль. При значении always, пароль всегда будет обновляться на устройстве, а при значении on_create пароль будет обновляться только при создании имени пользователя. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительную информацию об использовании командной строки, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании 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 |
Статус
Данный модуль помечен как превью, что означает, что гарантия обратной совместимости не предоставляется.
Поддержка
Для получения дополнительной информации о поддержке данного модуля 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.5/modules/eos_user_module.html
