bigip_snmp_trap - Управление информацией SNMP-ловушек на BIG-IP
Новая версия с 2.4.
Обзор
- Управление информацией SNMP-ловушек на BIG-IP.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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) | Объект dict, содержащий данные подключения. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль сообщит об ошибке. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортных средств cli. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| 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 bool (добавлено в 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.
Примеры
- 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 список | изменилось и успешно | Новое имя community назначения ловушки.Пример: secret |
| destination строка | изменилось и успешно | Новый адрес назначения ловушки в формате IP или имени хоста. Пример: 1.2.3.4 |
| network строка | изменилось и успешно | Новое имя сети, на которой находится SNMP-ловушка. Пример: management |
| port строка | изменилось и успешно | Новый port назначения ловушки.Пример: 900 |
| snmp_version строка | изменилось и успешно | Новая snmp_version, настроенная на удалённом устройстве.Пример: 2c |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики данного модуля гарантируют, что не будет вноситься обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/bigip_snmp_trap_module.html