nxos_user - Управление коллекцией локальных пользователей на устройствах Nexus
Новая версия 2.3.
Обзор
- Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять отдельными именами пользователей или коллекцией имён пользователей в текущей конфигурации. Он также поддерживает удаление имён пользователей из конфигурации, которые не определены явно.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| aggregate (добавлено в 2.4)
| нет | Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве Cisco Nexus. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент несовместим с аргументом name. Псевдоним users. | ||
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль, который следует использовать, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| configured_password (добавлено в 2.4)
| нет | Пароль, который должен быть настроен на сетевом устройстве. Пароль должен быть предоставлен в виде открытого текста, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не эквивалентен provider password. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| name | нет | Имя пользователя, которое нужно настроить на удалённом устройстве Cisco Nexus. Этот аргумент принимает строковое значение и несовместим с аргументом aggregate. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать общий порт) | Указывает порт, который следует использовать при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию устанавливается на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, который позволяет передать все аргументы nxos в виде объекта словаря. Все ограничения (обязательные, варианты и т.д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| purge | нет | Аргумент purge указывает модулю рассматривать определение ресурса как абсолютное. Он удалит любые ранее настроенные имена пользователей на устройстве за исключением пользователя `admin`, который не может быть удалён из-за ограничений nxos. | ||
| role | нет | Аргумент role настраивает роль для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, была ли роль настроена на устройстве. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| sshkey | нет | Аргумент sshkey определяет открытый SSH-ключ для настройки имени пользователя. Этот аргумент принимает допустимое значение SSH-ключа. | ||
| state | нет | present |
| Аргумент state настраивает состояние определения имени пользователя, как это относится к рабочей конфигурации устройства. При значении present имя пользователя(ы) должно быть настроено в активной конфигурации устройства, а при значении absent – нет. |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных операциях (sh mac, sh bgp и т.д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| update_password | нет | always |
| Поскольку пароли шифруются в конфигурации устройства, этот аргумент укажет модулю, когда изменять пароль. При значении always, пароль всегда будет обновлён на устройстве, а при значении on_create пароль будет обновлён только в случае создания имени пользователя. |
| use_ssl | нет |
| Настраивает transport на использование SSL, если установлено в true только при transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не является nxapi, это значение игнорируется. |
Примеры
- 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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Информация о техническом обслуживании
Дополнительную информацию о поддержке данного модуля компанией 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/nxos_user_module.html
