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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authentication -		Варианты: md5 sha	Параметры аутентификации пользователя.
encrypt boolean		Варианты: no yes	Включает шифрование AES-128 бит при использовании пароля конфиденциальности.
group -			Группа, к которой будет принадлежать пользователь. Если state = present, и пользователь существует, группа добавляется к пользователю. Если пользователь не существует, запись пользователя создается с этим аргументом группы. Если state = absent, только группа удаляется из записи пользователя. Однако, для обеспечения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если аргумент группы совпадает с группой существующего пользователя, тогда запись пользователя также удаляется.
privacy -			Пароль конфиденциальности для пользователя. Этот параметр не идемпотентен.
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только если вы используете NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass string добавлен в 2.5.3		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 2.5.3	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host string / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспорта 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 строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: нет ← да	Настраивает транспорт transport для использования SSL, если значение равно `yes`, только если `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на управляемых лично сайтах с самоподписанными сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется.
pwd -			Пароль аутентификации при использовании md5 или sha. Этот параметр не идемпотентен.
state -		Варианты: present ← absent	Управление состоянием ресурса.
user - / обязательно			Имя пользователя.

Примечания

Примечание

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

Примеры

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

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается командой Ansible Network. [network]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний 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.9/modules/nxos_snmp_user_module.html