cisco.nxos.nxos_snmp_traps – Управляет ловушками SNMP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_snmp_traps.
В версии 1.0.0: коллекции cisco.nxos
Обзор
- Управляет конфигурациями ловушек SNMP.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| group строка / обязательный |
| Регистрозависимая группа. | |
| provider словарь | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в выпуске после 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, это значение игнорируется. | |
| state строка |
| Управление состоянием ресурса. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Этот модуль работает на уровне группы ловушек. Если вам нужно включить/выключить только одну конкретную ловушку в группе, используйте модуль cisco.nxos.nxos_command.
- Учтите, что вы можете настроить ловушку только для включенной функции.
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco .
Примеры
# ensure lldp trap configured
- cisco.nxos.nxos_snmp_traps:
group: lldp
state: enabled
# ensure lldp trap is not configured
- cisco.nxos.nxos_snmp_traps:
group: lldp
state: disabled
Возвращаемые значения
Общие возвращаемые значения описаны в этом месте, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | команда, отправленная устройству Пример: snmp-server enable traps lldp ; |
Авторы
- Jason Edelman (@jedelman8)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_snmp_traps_module.html