Spec-Zone.ru › Ansible 2.8

bigip_snmp_trap – Управление информацией о SNMP-ловушке на BIG-IP

Новое в версии 2.4.

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

Обзор

  • Управление информацией о SNMP-ловушке на BIG-IP.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
community
строка
Указывает имя сообщества для пункта назначения ловушки.
destination
строка
Указывает адрес пункта назначения ловушки. Это может быть IP-адрес или имя хоста.
name
строка / обязательно
Имя конечной точки конфигурации SNMP.
network
строка
    Варианты:
  • other
  • management
  • default
Указывает имя сети ловушки. Этот параметр не поддерживается в версиях BIG-IP < 12.1.0. Если используется в версиях < 12.1.0, он будет просто проигнорирован.
Значение default было удалено в версии BIG-IP 13.1.0. Указание этого значения при конфигурировании BIG-IP заставит модуль остановиться и сообщить об ошибке. Обычно требуется выбрать один из других вариантов, например, management.
partition
строка
добавлен в 2.5
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
строка / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
port
строка
Указывает порт пункта назначения ловушки.
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
password
строка / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.
ssh_keyfile
путь
Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli.
Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Значение по умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль сообщит об ошибке.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
server
строка / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
добавлен в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.
snmp_version
строка
    Варианты:
  • 1
  • 2c
Указывает, к какой версии Simple Network Management Protocol (SNMP) относится пункт назначения ловушки.
state
строка
    Варианты:
  • present ←
  • absent
Если present, гарантирует, что ресурс существует.
Если absent, гарантирует, что ресурс не существует.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
добавлен в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Примечания

Примечание

  • Этот модуль поддерживает только версии SNMP v1 и v2c.
  • Опция network не поддерживается на версиях BIG-IP < 12.1.0, так как платформа не поддерживала эту опцию до версии 12.1.0. Если она используется на версиях < 12.1.0, она будет просто проигнорирована.
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, обязательно включите по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create snmp v1 trap
  bigip_snmp_trap:
    community: general
    destination: 1.2.3.4
    name: my-trap1
    network: management
    port: 9000
    snmp_version: 1
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create snmp v2 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.8
    name: my-trap2
    network: default
    port: 7000
    snmp_version: 2c
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:

Ключ Возвращаемое значение Описание
community
список
изменён и успешно
Новое имя назначения ловушки SNMP.

Пример:
secret
destination
строка
изменён и успешно
Новый адрес назначения ловушки SNMP в формате IP-адреса или имени хоста.

Пример:
1.2.3.4
network
строка
изменён и успешно
Новое имя сети, в которой находится ловушка SNMP.

Пример:
management
port
строка
изменён и успешно
Новый port назначения ловушки SNMP.

Пример:
900
snmp_version
строка
изменён и успешно
Новая snmp_version, настроенная на удалённом устройстве.

Пример:
2c


Статус

  • Данный модуль гарантированно не содержит изменений интерфейса, несовместимых с предыдущими версиями. [stableinterface]
  • Этот модуль поддерживается партнёром Ansible. [certified]

Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_snmp_trap_module.html

Spec-Zone.ru

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