nxos_user – Управление коллекцией локальных пользователей на устройствах Nexus
Описание
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах 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. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка добавлен в 2.5.3 | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не оказывает никакого влияния. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение добавлен в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль, используемый для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: "0 (использовать общий порт)" | Указывает порт, который используется при построении соединения с удалённым устройством. Это значение относится к транспорту cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если в задаче не указано другое значение. (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ, используемый для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение добавлен в 2.5 |
| Если 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. | |
| role - | Аргумент role настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроен ли роль на устройстве.алиасы: roles | ||
| sshkey - | Аргумент sshkey определяет открытый SSH-ключ для настройки имени пользователя. Этот аргумент принимает допустимое значение SSH-ключа. | ||
| state - |
| Аргумент state настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При значении present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя пользователя(ей) не должно находиться в активной конфигурации устройства. | |
| update_password - |
| Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент указывает, когда нужно изменить пароль. При значении always, пароль всегда будет обновлён на устройстве, а при значении on_create пароль будет обновлён только при создании имени пользователя. | |
Примечания
Примечание
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по Ansible для сети
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции 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 Network. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний 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.9/modules/nxos_user_module.html
