eos_user - Управление коллекцией локальных пользователей на устройствах EOS
Новая версия 2.3.
Обзор
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Arista EOS. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо коллекцией имён пользователей в текущей рабочей конфигурации. Он также поддерживает удаление имён пользователей из конфигурации, которые не определены явно.
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| aggregate (добавлено в 2.4)
| нет | Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве Arista EOS. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом username. Псевдоним users. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| auth_pass | нет | none | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| authorize | нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения 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 | нет | Объект словаря, содержащий сведения о подключении. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purge | нет |
| Инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит любые ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удалён в соответствии с ограничениями EOS. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| role | нет | Настраивает роль для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sshkey | нет | Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает действительное значение ключа SSH. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| state | нет | present |
| Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в present имя(а) пользователя должно(должны) быть настроено(ны) в активной конфигурации устройства, а при установке в absent имя(а) пользователя не должно(должны) быть в активной конфигурации устройства | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| update_password | нет | always |
| Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При установке в always, пароль всегда будет обновлён на устройстве, а при установке в on_create пароль будет обновлён только в случае создания имени пользователя. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примеры
- 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 | Список команд режима конфигурации для отправки на устройство | всегда | список | ['имя ansible секретный пароль', 'имя admin секретный admin'] |
| session_name | Имя сеанса конфигурации EOS, используемого для загрузки конфигурации | при изменении True | строка | ansible_1479315771 |
Примечания
Примечание
- Проверено на EOS 4.15
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы этого желаете, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/eos_user_module.html
