cisco.nxos.nxos_snmp_user – Управляет пользователями SNMP для мониторинга.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_snmp_user.
Новый в версии 1.0.0: из cisco.nxos
Обзор
- Управляет настройками пользователей SNMP.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authentication строка |
| Параметры аутентификации для пользователя. | |
| encrypt булево |
| Включает шифрование AES-128 бит при использовании пароля конфиденциальности. | |
| group строка | Группа, к которой будет принадлежать пользователь. Если state = present, и пользователь существует, группа добавляется к пользователю. Если пользователя нет, запись пользователя создается с этим аргументом группы. Если state = absent, только группа удаляется из записи пользователя. Однако, для обеспечения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если аргумент группы совпадает с группой существующего пользователя, то запись пользователя также удаляется. | ||
| privacy строка | Пароль конфиденциальности для пользователя. Это не идемпотентно | ||
| provider словарь | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi.Этот параметр будет удален в выпуске после 2022-06-01. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для использования при построении подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате на длительных командах (sh mac, sh bgp и т. д.). | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy булево |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено yes только тогда, когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если 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 integration.
Примеры
- cisco.nxos.nxos_snmp_user:
user: ntc
group: network-operator
authentication: md5
pwd: test_password
Возвращаемые значения
Общие возвращаемые значения описаны в документе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные устройству Пример: ['snmp-server user ntc network-operator auth md5 test_password'] |
Авторы
- 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.10/collections/cisco/nxos/nxos_snmp_user_module.html
