Spec-Zone.ru › Ansible 2.10

cisco.nxos.nxos_snmp_traps – Управляет SNMP-ловушками.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в книге задач укажите: cisco.nxos.nxos_snmp_traps.

Добавлен в версии 1.0.0: модуль cisco.nxos

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управляет конфигурацией SNMP-ловушек.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
group
строка / обязательный
    Варианты:
  • aaa
  • bfd
  • bgp
  • bridge
  • callhome
  • cfs
  • config
  • eigrp
  • entity
  • feature-control
  • generic
  • hsrp
  • license
  • link
  • lldp
  • mmode
  • ospf
  • pim
  • rf
  • rmon
  • snmp
  • storm-control
  • stpx
  • switchfabric
  • syslog
  • sysmgr
  • system
  • upgrade
  • vtp
  • all
Регистрозависимая группа.
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
строка
    Варианты:
  • cli ←
  • nxapi
Настраивает протокол подключения к удалённому устройству. Аргумент 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
строка
    Варианты:
  • enabled ←
  • disabled
Управление состоянием ресурса.

Примечания

Примечание

  • Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
  • Этот модуль работает на уровне группы для ловушек. Если вам нужно включить/выключить только 1 конкретную ловушку в группе, используйте модуль cisco.nxos.nxos_command.
  • Обратите внимание, что ловушку можно установить только для включённой функции.
  • Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании 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–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_traps_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API