nxos_snmp_user – Управляет пользователями SNMP для мониторинга.
Новое в версии 2.2.
Обзор
- Управляет настройками пользователей SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authentication - |
| Параметры аутентификации для пользователя. | |
| encrypt boolean |
| Включает шифрование AES-128 бит при использовании пароля конфиденциальности. | |
| group - | Группа, к которой будет принадлежать пользователь. Если состояние = present, и пользователь существует, группа добавляется к пользователю. Если пользователь не существует, запись пользователя создается с этим параметром группы. Если состояние = absent, только группа удаляется из записи пользователя. Однако, для обеспечения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если параметр группы совпадает с группой существующего пользователя, то запись пользователя также удаляется. | ||
| privacy - | Пароль конфиденциальности для пользователя. Не идемпотентен | ||
| provider - | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр требуется только если вы используете NX-API. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass - добавлено в 2.5.3 | По умолчанию: "none" | Указывает пароль, который нужно использовать, если требуется войти в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот параметр ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения 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, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено значение true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Если параметр transport не 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'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [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.7/modules/nxos_snmp_user_module.html
