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 булево |
| Устарело Начиная с 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 целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | |
| 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
- Дополнительную информацию об использовании командной строки, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании 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 |
Статус
- Гарантированная обратная совместимость этого модуля не поддерживается. [preview]
- Этот модуль поддерживается командой Ansible Network. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.8/modules/eos_user_module.html
