nxos_user - Управление коллекцией локальных пользователей на устройствах Nexus
Новое в версии 2.3.
Обзор
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо коллекцией имен пользователей в текущей рабочей конфигурации. Он также поддерживает очистку имен пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate (добавлен в 2.4) | Набор объектов имени пользователя, которые должны быть настроены на удаленном устройстве Cisco Nexus. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключает аргумент name. Псевдонимы: users, collection | ||
| configured_password (добавлен в 2.4) | Пароль, который необходимо настроить на сетевом устройстве. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не эквивалентен provider password. | ||
| name | Имя пользователя, которое необходимо настроить на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключает аргумент aggregate. | ||
| provider | Устаревший Начиная с Ansible 2.5, мы рекомендуем использовать connection: network_cli. Этот параметр необходим только если вы используете NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении соединения с удаленным устройством. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: "none" | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах с самозаверяющимися сертификатами. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| purge bool |
| Аргумент purge указывает модулю считать определение ресурса абсолютным. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удален в соответствии с ограничениями nxos. | |
| role | Аргумент role настраивает роль для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, была ли роль настроена на устройстве.Псевдонимы: roles | ||
| sshkey | Аргумент sshkey определяет открытый ключ SSH для настройки для имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state |
| Аргумент state настраивает состояние определения имени пользователя, как это относится к рабочей конфигурации устройства. При значении present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя пользователя(ей) не должно быть в активной конфигурации устройства. | |
| update_password |
| Так как пароли шифруются в рабочей конфигурации устройства, этот аргумент укажет модулю, когда изменить пароль. При значении always, пароль всегда будет обновлен на устройстве, а при значении on_create, пароль будет обновлен только в случае создания имени пользователя. | |
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: create a new user
nxos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
nxos_user:
purge: yes
- name: set multiple users role
aggregate:
- name: netop
- name: netend
role: network-operator
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд режима конфигурации, которые нужно отправить устройству Пример: ['name ansible', 'name ansible password password'] |
| delta строка | всегда | Время, затраченное на выполнение всех операций Пример: 0:00:10.469466 |
| end строка | всегда | Время окончания работы задания Пример: 2016-11-16 10:38:25.595612 |
| start строка | всегда | Время начала работы задания Пример: 2016-11-16 10:38:15.126146 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются командой Ansible по работе с сетями, см. в этом месте.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/nxos_user_module.html
