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, содержащий данные подключения.
	auth_pass - добавлен в 2.5.3	По умолчанию: "none"	Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize равно false, то этот аргумент не имеет значения. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 2.5.3	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
	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 - добавлен в 2.3	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истек до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.).
	transport - / обязательно	По умолчанию: "cli"	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает transport на использование SSL, если значение true только в том случае, если `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
purge boolean		Варианты: no ← yes	Аргумент `purge` инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удален в соответствии с ограничениями nxos.
role -			Аргумент `role` настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, была ли роль настроена на устройстве. Псевдонимы: roles
sshkey -			Аргумент `sshkey` определяет открытый ключ SSH для настройки для имени пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state -		Варианты: present ← absent	Аргумент `state` настраивает состояние определения имени пользователя в отношении рабочей конфигурации устройства. При значении present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при значении absent имя пользователя(ей) не должно быть в активной конфигурации устройства.
update_password -		Варианты: on_create always ←	Поскольку пароли шифруются в конфигурации устройства, этот аргумент укажет, когда изменить пароль. При значении `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 Network Team. [сеть]

Поддержка 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.7/modules/nxos_user_module.html