f5networks.f5_modules.bigip_snmp_trap модуль — Управление информацией о ловушках SNMP на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_snmp_trap.

Добавлен в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
auth_password строка добавлен в f5networks.f5_modules 1.16.0	Указывает пароль для протокола аутентификации, который будет использоваться для ловушек snmp v3 Требуется для `snmp_version`, совпадающих с `v3`, и для `security_level`
auth_protocol строка добавлен в f5networks.f5_modules 1.16.0	Указывает протокол аутентификации, который будет использоваться для ловушек snmp v3 Требуется для `security_level` Выбор: `"sha"` `"md5"`
community строка	Указывает имя сообщества для пункта назначения ловушки.
destination строка	Указывает адрес пункта назначения ловушки. Это может быть IP-адрес или имя хоста.
name строка / обязательно	Имя конечной точки конфигурации SNMP.
network строка	Указывает имя сети ловушки. Этот параметр не поддерживается в версиях BIG-IP до 12.1.0 и просто игнорируется в этих версиях. Значение `default` было удалено в версии BIG-IP 13.1.0. Указание этого значения при конфигурации BIG-IP приводит к остановке модуля и сообщению об ошибке. В этом случае выберите один из других параметров, таких как `management`. Выбор: `"other"` `"management"` `"default"`
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port строка	Указывает порт для пункта назначения ловушки.
privacy_password строка добавлен в f5networks.f5_modules 1.16.0	Указывает пароль протокола конфиденциальности, который будет использоваться для ловушек snmp v3 Требуется для `security_level` совпадает с c(auth-privacy)
privacy_protocol строка добавлен в f5networks.f5_modules 1.16.0	Указывает протокол конфиденциальности, который будет использоваться для ловушек snmp v3 Требуется для `security_level` совпадает с c(auth-privacy) Выбор: `"aes"` `"des"`
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект типа dict, содержащий данные подключения.
auth_provider строка	Конфигурирует поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр фактически используется при работе с устройствами BIG-IQ.
no_f5_teem логический	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как ее имя вызывало путаницу. Выбор: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение, которое используется при подключении к удаленному устройству. Выбор: `"rest"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Выбираемые значения: `false` `true` ← (по умолчанию)
security_level строка добавлен в f5networks.f5_modules 1.16.0	Указывает порт для пункта назначения ловушки. Требуется, если `snmp_version` соответствует `v3`. Выбираемые значения: `"auth-no-privacy"` `"auth-privacy"`
security_name строка добавлен в f5networks.f5_modules 1.16.0	Указывает имя безопасности, используемое для ловушки snmp v3 Требуется, если `snmp_version` соответствует `v3`.
snmp_version строка	Указывает, к какой версии протокола Simple Network Management Protocol (SNMP) относится пункт назначения ловушки. Выбираемые значения: `"1"` `"2c"` `"3"`
state строка	При значении `present`, гарантирует существование ресурса. При значении `absent`, гарантирует отсутствие ресурса. Выбираемые значения: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Этот модуль поддерживает только версии v1 и v2c SNMP.
Параметр 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 сохранится на диске, убедитесь, что в задаче используется модуль f5networks.f5_modules.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

- name: Create snmp v3 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.9
    name: my-trap3
    network: management
    port: 7001
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test12345'
    security_name: "testsec2"
    security_level: "auth-no-privacy"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

- name: Create snmp v3 trap-2
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.10
    name: my-trap4
    network: management
    port: 7002
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test123456'
    security_name: "testsec3"
    security_level: "auth-privacy"
    privacy_protocol: "des"
    privacy_password: 'test@12345'
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
community список / элементы=строка	Новое имя сообщества `community` для пункта назначения ловушки. Возвращаемое значение: изменён и успех Пример: `["secret"]`
destination строка	Новый адрес пункта назначения ловушки в формате IP-адреса или имени хоста. Возвращаемое значение: изменён и успех Пример: `"1.2.3.4"`
network строка	Новое имя сети, на которой находится ловушка SNMP. Возвращаемое значение: изменён и успех Пример: `"management"`
port строка	Новый `port` пункта назначения ловушки. Возвращаемое значение: изменён и успех Пример: `"900"`
snmp_version строка	Новая версия `snmp_version`, настроенная на удалённом устройстве. Возвращаемое значение: изменён и успех Пример: `"2c"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_snmp_trap_module.html