nxos_user — Управление локальными пользователями на устройствах Nexus

Новая версия 2.3.

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус
- Поддержка
- Автор

Обзор

Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо набором имён пользователей в текущей конфигурации. Он также поддерживает удаление имён пользователей из конфигурации, которые не определены явно.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate (добавлено в 2.4)		Значение по умолчанию: None	Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве Cisco Nexus. Элементы списка могут быть либо именем пользователя, либо хешем из имени пользователя и свойств. Этот аргумент взаимоисключает аргумент `name`. псевдонимы: users, collection
configured_password (добавлено в 2.4)			Пароль, который должен быть настроен на устройстве сети. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не такой же, как `provider password`.
name		Значение по умолчанию: None	Имя пользователя, которое должно быть настроено на удалённом устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключает аргумент `aggregate`.
provider		Значение по умолчанию: None	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только если вы используете NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения.
	username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	authorize (добавлено в 2.5.3)	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	use_proxy (добавлено в 2.5)	Варианты: yes ← no	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	auth_pass (добавлено в 2.5.3)	Значение по умолчанию: none	Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize — false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
	timeout (добавлено в 2.3)	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с устройством сети для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль вернёт ошибку. NX-API может быть медленным при возврате длинных команд (sh mac, sh bgp и т.д.).
	use_ssl	Варианты: yes no ←	Настраивает transport для использования SSL, если значение true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	validate_certs	Варианты: yes no Значение по умолчанию: None	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяющими сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
	port	Значение по умолчанию: 0 (использование общего порта)	Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	transport обязательно	Значение по умолчанию: cli	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через командную строку (ssh) или nxapi.
purge		Значение по умолчанию: no	Аргумент `purge` инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удалён в соответствии с ограничениями nxos.
role		Значение по умолчанию: None	Аргумент `role` настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве. псевдонимы: roles
sshkey		Значение по умолчанию: None	Аргумент `sshkey` определяет открытый ключ SSH для настройки для имени пользователя. Этот аргумент принимает допустимое значение SSH-ключа.
state		Варианты: present ← absent	Аргумент `state` настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При значении present имя пользователя(ы) должно быть настроено в активной конфигурации устройства, а при значении absent имя пользователя(ы) не должно быть в активной конфигурации устройства.
update_password		Варианты: on_create always ←	Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет, когда обновить пароль. При значении `always`, пароль всегда будет обновлён в устройстве, а при значении `on_create`, пароль будет обновлён только при создании имени пользователя.

Примечания

Примечание

Дополнительную информацию об использовании командной строки и 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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_user_module.html