eos_user – Управление коллекцией локальных пользователей на устройствах EOS
Новая версия 2.3.
Краткое описание
- Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Arista EOS. Он позволяет playbook управлять как отдельными именами пользователей, так и коллекцией имен пользователей в текущей конфигурации. Он также поддерживает удаление имен пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 boolean |
| Устаревший Начиная с 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 boolean |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без проверки пароля. | |
| privilege - | Аргумент privilege настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15. | ||
| provider - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Дополнительную информацию можно найти в руководстве EOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль, который нужно использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения 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 - | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение, которое нужно использовать при подключении к удаленному устройству. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl boolean |
| Настраивает транспорт на использование SSL, если значение равно true, только когда transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется. | |
| username - | Настраивает имя пользователя для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности входа в CLI или проверки подлинности eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. Если аргумент transport не равен eapi, это значение игнорируется. | |
| purge boolean |
| Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `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 Arista integration page.
Примеры
- 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 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible 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.7/modules/eos_user_module.html
