nxos_snmp_user - Управляет пользователями SNMP для мониторинга.
Новая версия 2.2.
Описание
- Управляет конфигурацией пользователей SNMP.
Параметры
| параметр | обязательный | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| auth | нет |
| Параметры аутентификации для пользователя. | |
| auth_pass (добавлен в 2.4.4)
| нет | none | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| encrypt | нет |
| Включает шифрование AES-128 бит при использовании пароля конфиденциальности. | |
| group | да | Группа, к которой будет принадлежать пользователь. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации соединения с удаленным устройством. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту используемого транспорта, если в задаче не указано другое. (cli=22, http=80, https=443). | |
| privacy | нет | Пароль конфиденциальности для пользователя. | ||
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, возможные значения и т. д.) должны быть удовлетворены либо отдельными аргументами, либо значениями в этом словаре. | ||
| pwd | нет | Пароль аутентификации при использовании md5 или sha. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Управление состоянием ресурса. |
| timeout (добавлен в 2.3)
| нет | 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результат при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает транспорт transport для использования SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| user | да | Имя пользователя. | ||
| username | нет | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверенных сертификатов. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
- nxos_snmp_user:
user: ntc
group: network-operator
auth: md5
pwd: test_password
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | команды, отправленные устройству | всегда | список | ['snmp-server user ntc network-operator auth md5 test_password'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Параметры аутентификации не идемпотентны.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для помощи в разработке модулей, если вы так заинтересованы, прочитайте Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_snmp_user_module.html
