bigip_snmp_trap – Управление информацией о SNMP-ловушках на BIG-IP
Новая версия с 2.4.
Описание
- Управление информацией о SNMP-ловушках на BIG-IP.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| community - | Указывает имя сообщества для назначения ловушки. | ||
| destination - | Указывает адрес назначения ловушки. Это может быть IP-адрес или имя хоста. | ||
| name - / обязательно | Имя конечной точки конфигурации SNMP. | ||
| network - |
| Указывает имя сети ловушки. Этот параметр не поддерживается в версиях 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 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами, с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port - добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| snmp_version - |
| Указывает, к какой версии протокола Simple Network Management Protocol (SNMP) относится назначение ловушки. | |
| state - |
| Когда present, гарантирует, что ресурс существует.Когда absent, гарантирует, что ресурс не существует. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами, с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Этот модуль поддерживает только версии 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.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО 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
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
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 строка | изменённое и успешное | Новый порт назначения ловушки SNMP. Пример: 900 |
| snmp_version строка | изменённое и успешное | Новая версия SNMP, настроенная на удалённом устройстве. Пример: 2c |
Статус
- Данный модуль гарантированно не будет содержать изменений интерфейса, несовместимых со старыми версиями. [stableinterface]
- Данный модуль поддерживается партнёром Ansible. [certified]
Авторы
- Tim Rupp (@caphrim007)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_snmp_trap_module.html