avi_alertconfig – Модуль для настройки AlertConfig Avi RESTful объекта
Новая версия 2.4.
Краткое описание
- Этот модуль используется для настройки объекта AlertConfig
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action_group_ref - | Конфигурация оповещения запустит выбранное действие оповещения, которое может отправлять уведомления и выполнять скрипты управления. Это ссылка на объект типа actiongroupconfig. | |
| alert_rule - / required | Список фильтров, соответствующих событиям или журналам клиента, используемым для запуска оповещений. | |
| api_context - добавлено в 2.5 | Контекст API Avi, который включает текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | |
| api_version - | Значение по умолчанию: "16.4.4" | Версия API Avi, которая будет использоваться для API Avi и объектов. |
| autoscale_alert boolean |
| Эта конфигурация оповещения применяется к оповещениям автомасштабирования. |
| avi_api_patch_op - добавлено в 2.5 |
| Операция исправления, которая будет использоваться при использовании avi_api_update_method как исправление. |
| avi_api_update_method - добавлено в 2.5 |
| Метод обновления объекта по умолчанию - HTTP PUT. Установка в patch переопределит это поведение, используя HTTP PATCH. |
| avi_credentials - добавлено в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных для входа в Avi Controller. | |
| category - / required | Определяет, будет ли оповещение вызываться немедленно при возникновении события (в реальном времени) или после того, как произойдет указанное количество событий в течение скользящего временного окна. Варианты перечисления - REALTIME, ROLLINGWINDOW, WATERMARK. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как REALTIME. | |
| controller - | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. |
| description - | Пользовательское поле описания. | |
| enabled boolean |
| Включить или отключить эту конфигурацию оповещения от генерации новых оповещений. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. |
| expiry_time - | Оповещение истекает и удаляется после истечения времени истечения срока действия. Оригинальное событие, вызвавшее оповещение, остается в журнале событий. Допустимые значения - 1-31536000. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 86400. Единицы(СЕК). | |
| name - / required | Имя конфигурации оповещения. | |
| obj_uuid - | Uuid ресурса, для которого было вызвано оповещение. | |
| object_type - | Тип объекта, с которым связана конфигурация оповещения. Допустимые типы объектов - виртуальный сервис, пул, сервисный модуль. Варианты перечисления - VIRTUALSERVICE, POOL, HEALTHMONITOR, NETWORKPROFILE, APPLICATIONPROFILE, HTTPPOLICYSET, DNSPOLICY, IPADDRGROUP, STRINGGROUP, SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE, AUTHPROFILE, CLOUD, SERVERAUTOSCALEPOLICY, AUTOSCALELAUNCHCONFIG, MICROSERVICEGROUP, IPAMPROFILE, HARDWARESECURITYMODULEGROUP, POOLGROUP, PRIORITYLABELS, POOLGROUPDEPLOYMENTPOLICY, GSLBSERVICE, GSLBSERVICERUNTIME, SCHEDULER, GSLBGEODBPROFILE, GSLBAPPLICATIONPERSISTENCEPROFILE, TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, L4POLICYSET, SERVICEENGINE, DEBUGSERVICEENGINE, DEBUGCONTROLLER, DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION, VRFCONTEXT, USER, ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE, ACTIONGROUPPROFILE, MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART, IPAMDNSRECORD, GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME, UDPSTATRUNTIME, IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME, L7GLOBALSTATSRUNTIME, L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME, ARPTABLERUNTIME, DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME, METRICSAGENTMESSAGE, HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL, CONNECTIONDUMPRUNTIME, SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST, MEMINFORUNTIME, RTERINGSTATRUNTIME, ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER, HTTPPOLICYSETSTATS, DNSPOLICYSTATS, METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS, CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME, SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME, METRICSRUNTIMEDETAIL, METRICSRUNTIMESUMMARY, DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE, HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME, SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS, SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM, SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ, SEUPGRADE, SEUPGRADESTATUSDETAIL, SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE, SEAUTHSTATSRUNTIME, AUTOSCALESTATE, VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL, SERVERSTATEUPDATEINFO, CLTRACKINTERNAL, CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL, CLIENTSUMMARYINTERNAL, MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL, INTERFACESUMMARYRUNTIME, INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST, TRAFFICCLONERUNTIME, GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME, VSESSHARINGPOOL, SEVSSPLACEMENT, L4POLICYSETSTATS, L4POLICYSETINTERNAL, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS, SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME, INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS, TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS, VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS, VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS, VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION, CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY, POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL, APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS, APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE, NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI, MAXOBJECTS. | |
| password - | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная среды AVI_PASSWORD. |
| recommendation - | Рекомендация по alertconfig. | |
| rolling_window - | Только если количество событий достигнуто или превышено в течение временного окна, будет сгенерировано оповещение. Допустимые значения - 1-31536000. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 300. Единицы(СЕК). | |
| source - / required | Обозначает системные события или тип журналов клиента, используемых в этой конфигурации оповещения. Варианты перечисления - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS. |
| состояние - |
| Состояние, которое должно быть применено к сущности. |
| краткое_описание - | Краткое описание причины создания предупреждения. | |
| арендатор - | По умолчанию: "admin" | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| арендатор_ссылка - | Это ссылка на объект типа арендатор. | |
| арендатор_uuid - | По умолчанию: "" | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| порог - | Предупреждение создается только тогда, когда количество событий достигает или превышает это число в выбранном временном интервале. Допустимые значения: 1-65536. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | |
| ограничение - | Предупреждения подавляются (ограничиваются) на это время с момента последнего поднятия предупреждения для этой конфигурации предупреждения. Допустимые значения: 0-31536000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 600. Единицы (СЕК). | |
| url - | URL контроллера Avi объекта. | |
| имя_пользователя - | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid - | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create AlertConfig object
avi_alertconfig:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_alertconfig
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| объект словарь | успех, изменения | Объект AlertConfig (api/alertconfig) |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Гaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/avi_alertconfig_module.html