cisco.nxos.nxos_user – Управление набором локальных пользователей на устройствах Nexus
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_user.
Новое в версии 1.0.0: коллекции cisco.nxos
Обзор
- Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет книгам задач управлять либо отдельными именами пользователей, либо набором имён пользователей в текущей рабочей конфигурации. Он также поддерживает удаление имён пользователей из конфигурации, которые не определены явно.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Набор объектов пользователей, которые должны быть настроены на удаленном устройстве Cisco Nexus. Элементы списка могут быть именем пользователя или хэшем из имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name. псевдонимы: пользователи, коллекция | ||
| configured_password строка | Пароль, который должен быть настроен на сетевом устройстве. Пароль должен быть предоставлен в открытом виде и будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name строка | Имя пользователя, которое должно быть настроено на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и является взаимоисключающим с аргументом aggregate. | ||
| roles список / элементы=строка | Аргумент role настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.псевдонимы: роль | ||
| sshkey строка | Аргумент sshkey определяет открытый ключ SSH для настройки для имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state строка |
| Аргумент state настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При установке в present, имя пользователя(и) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(и) не должно быть в активной конфигурации устройства | |
| update_password строка |
| Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При установке в always, пароль всегда будет обновлен на устройстве, а при установке в on_create, пароль будет обновлен только в случае создания имени пользователя. | |
| configured_password строка | Пароль, который должен быть настроен на сетевом устройстве. Пароль должен быть предоставлен в открытом виде и будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name строка | Имя пользователя, которое должно быть настроено на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и является взаимоисключающим с аргументом aggregate. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в выпуске после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для создания подключения к удаленному устройству. Это значение относится к cli или nxapi. Если порт не указан в задаче, значение по умолчанию будет соответствовать общему порту для соответствующего транспорта (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут будет превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать при выполнении длительных команд (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает транспорт transport для использования SSL, если значение установлено в yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| purge логическое значение |
| Аргумент purge указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удален по ограничениям nxos. | |
| roles список / элементы=строка | Аргумент role настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.псевдонимы: роль | ||
| sshkey строка | Аргумент sshkey определяет открытый ключ SSH для настройки для имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state строка |
| Аргумент state настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При установке в present, имя пользователя(и) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(и) не должно быть в активной конфигурации устройства | |
| update_password строка |
| Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При установке в always, пароль всегда будет обновлен на устройстве, а при установке в on_create, пароль будет обновлен только в случае создания имени пользователя. | |
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в Руководстве по параметрам платформы NXOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: create a new user
cisco.nxos.nxos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
cisco.nxos.nxos_user:
purge: yes
- name: set multiple users role
cisco.nxos.nxos_user:
aggregate:
- name: netop
- name: netend
role: network-operator
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| commands list / elements=string | всегда | Список команд режима конфигурации для отправки устройству Пример: ['name ansible', 'name ansible password password'] |
Авторы
- Peter Sprygada (@privateip)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_user_module.html
