nxos_snmp_user — Управляет пользователями SNMP для мониторинга.
Впервые добавлена в версии 2.2.
Обзор
- Управляет настройками пользователей SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authentication |
|
Параметры аутентификации для пользователя. | |
| encrypt |
|
Включает шифрование AES-128 бит при использовании пароля конфиденциальности. | |
| group | Группа, к которой будет принадлежать пользователь. Если состояние = present, и пользователь существует, группа добавляется к пользователю. Если пользователя не существует, запись пользователя создается с этим аргументом группы. Если состояние = absent, только группа удаляется из записи пользователя. Однако, для обеспечения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если аргумент группы совпадает с группой существующего пользователя, то запись пользователя также удаляется. | ||
| privacy | Пароль конфиденциальности для пользователя. Этот параметр не идемпотентен. | ||
| provider | Значение по умолчанию: None |
Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Этот параметр требуется только если используется NX-API. Дополнительная информация в руководстве по платформе NXOS: NXOS Platform Options. Объект словаря, содержащий детали подключения. |
|
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME. |
||
| authorize (добавлено в 2.5.3) |
|
Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| use_proxy (добавлено в 2.5) |
|
Если no, переменные среды http_proxy и https_proxy будут проигнорированы. |
|
| auth_pass (добавлено в 2.5.3) |
Значение по умолчанию: none |
Указывает пароль для использования, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. |
|
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлено в 2.3) |
Значение по умолчанию: 10 |
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т.д.). | |
| use_ssl |
|
Настраивает transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. |
|
| password | Значение по умолчанию: None |
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. |
|
| validate_certs |
None
|
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. |
|
| port | Значение по умолчанию: 0 (использование стандартного порта) |
Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту для транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно |
Значение по умолчанию: cli |
Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| pwd | Пароль аутентификации при использовании md5 или sha. Этот параметр не идемпотентен. | ||
| state |
|
Управление состоянием ресурса. | |
| user обязательно |
Имя пользователя. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL.
- Параметры аутентификации не идемпотентны.
- Дополнительная информация об использовании CLI и 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'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_snmp_user_module.html
