nxos_snmp_user - Управляет пользователями SNMP для мониторинга.

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

Управляет конфигурацией пользователей SNMP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authentication		Варианты: md5 sha	Параметры аутентификации для пользователя.
encrypt bool		Варианты: no yes	Включает шифрование AES-128 бит при использовании пароля конфиденциальности.
group			Группа, к которой будет принадлежать пользователь. Если состояние = присутствует, и пользователь существует, группа добавляется к пользователю. Если пользователь не существует, запись пользователя создается с этим аргументом группы. Если состояние = отсутствует, только группа удаляется из записи пользователя. Однако, для сохранения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если аргумент группы совпадает с группой существующего пользователя, тогда запись пользователя также удаляется.
privacy			Пароль конфиденциальности для пользователя. Это не идемпотентно.
provider			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Дополнительная информация приведена в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	port	По умолчанию: "0 (использовать стандартный порт)"	Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию устанавливается в соответствующий общий порт транспорта, если он не указан в задании. (cli=22, http=80, https=443).
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	authorize bool (добавлен в 2.5.3)	Варианты: no ← yes	Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass (добавлен в 2.5.3)	По умолчанию: "none"	Указывает пароль для использования, если требуется переход в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	timeout (добавлен в 2.3)	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т. д.).
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	По умолчанию: "cli"	Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_ssl bool	Варианты: no ← yes	Настраивает transport для использования SSL, если значение равно true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	validate_certs bool	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
	use_proxy bool (добавлен в 2.5)	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
pwd			Пароль аутентификации при использовании md5 или sha. Это не идемпотентно.
state		Варианты: present ← absent	Управление состоянием ресурса.
user обязательно			Имя пользователя.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Параметры аутентификации не идемпотентны.
Сведения об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- nxos_snmp_user:
    user: ntc
    group: network-operator
    authentication: md5
    pwd: test_password

Возвращаемые значения

Общие возвращаемые значения описаны в разделе, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
commands список	всегда	команды, отправленные на устройство Пример: ['snmp-server user ntc network-operator auth md5 test_password']

Статус

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

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым технологиям. Подробнее см. в Разделе по поддержке модулей.

Список других модулей, поддерживаемых командой Ansible по сетевым технологиям, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний

Автор

Jason Edelman (@jedelman8)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_snmp_user_module.html