cisco.nxos.nxos_user – Управление списком локальных пользователей на устройствах Nexus
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos
Для использования в плейбуке укажите: cisco.nxos.nxos_user
Новое в версии 1.0.0: of cisco.nxos
Обзор
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять как отдельными именами пользователей, так и списком имен пользователей в текущей конфигурации. Он также поддерживает удаление имен пользователей из конфигурации, которые не определены явно.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Набор объектов пользователей, которые необходимо настроить на удалённом устройстве Cisco Nexus. Элементы списка могут быть именем пользователя или словарем, содержащим имя пользователя и свойства. Этот аргумент взаимоисключающий с аргументом name. псевдонимы: users, collection | ||
| configured_password строка | Пароль, который необходимо настроить на сетевом устройстве. Пароль должен быть предоставлен в открытом виде и будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name строка | Имя пользователя, которое необходимо настроить на удалённом устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. | ||
| roles список / элементы=строка | Аргумент role настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.псевдонимы: 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 настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.псевдонимы: role | ||
| 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
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_user_module.html
