Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт пароль протокола аутентификации, используемый для ловушек SNMP v3.

Требуется для snmp_version соответствует v3 и для security_level

auth_protocol

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт протокол аутентификации, используемый для ловушек SNMP v3.

Требуется для security_level

Варианты:

  • "sha"
  • "md5"

community

string

Задаёт имя сообщества для назначения ловушки.

destination

string

Задаёт адрес назначения ловушки. Это может быть IP-адрес или имя хоста.

name

string / обязательный

Имя конечной точки конфигурации SNMP.

network

string

Задаёт имя сети ловушек. Этот параметр не поддерживается в версиях BIG-IP до 12.1.0 и в этих версиях просто игнорируется.

Значение default удалено в BIG-IP версии 13.1.0. Указание этого значения при настройке BIG-IP приводит к остановке модуля и сообщению об ошибке. В этом случае выберите один из других вариантов, например management.

Варианты:

  • "other"
  • "management"
  • "default"

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

port

string

Задаёт порт назначения ловушки.

privacy_password

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт пароль протокола конфиденциальности, используемый для ловушек SNMP v3.

Требуется для security_level соответствует c(auth-privacy)

privacy_protocol

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт протокол конфиденциальности, используемый для ловушек SNMP v3.

Требуется для security_level соответствует c(auth-privacy)

Варианты:

  • "aes"
  • "des"

provider

dictionary

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

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика аутентификации, который получает токены аутентификации с удалённого устройства.

Этот параметр используется главным образом при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную окружения F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, поскольку её название вводило в заблуждение.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задаёт время ожидания в секундах при взаимодействии с сетевым устройством — при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.

transport

string

Настраивает транспортное соединение, используемое при подключении к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную окружения F5_USER.

validate_certs

boolean

Если no, SSL-сертификаты не проверяются. Используйте этот параметр только на сайтах под вашим личным контролем, применяющих самоподписанные сертификаты.

Этот параметр можно не указывать, задав переменную окружения F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

security_level

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт порт назначения ловушки.

Требуется для snmp_version соответствует v3.

Варианты:

  • "auth-no-privacy"
  • "auth-privacy"

security_name

string

добавлено в f5networks.f5_modules 1.16.0

Задаёт имя безопасности для ловушки SNMP v3.

Требуется для snmp_version соответствует v3.

snmp_version

string

Задаёт версию простого протокола управления сетью (SNMP), к которой относится назначение ловушки.

Варианты:

  • "1"
  • "2c"
  • "3"

state

string

Если present, обеспечивает наличие ресурса.

Если absent, обеспечивает отсутствие ресурса.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Этот модуль поддерживает только версии SNMP v1 и v2c.
  • Параметр network не поддерживается в версиях BIG-IP до 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

list / elements=string

Новое имя community для назначения ловушки.

Возвращается: при изменении и успешном выполнении

Пример: ["secret"]

destination

string

Новый адрес назначения ловушки в виде IP-адреса или имени хоста.

Возвращается: при изменении и успешном выполнении

Пример: "1.2.3.4"

network

string

Новое имя сети, в которой находится ловушка SNMP.

Возвращается: при изменении и успешном выполнении

Пример: "management"

port

string

Новый port назначения ловушки.

Возвращается: при изменении и успешном выполнении

Пример: "900"

snmp_version

string

Новая snmp_version, настроенная на удалённом устройстве.

Возвращается: при изменении и успешном выполнении

Пример: "2c"

Авторы

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

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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