community.network.avi_alertconfig 模块 – 用于设置 AlertConfig Avi RESTful 对象的模块

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。 您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：community.network.avi_alertconfig。

注意

community.network 集合已弃用，将从 Ansible 12 中删除。 有关更多信息，请参阅讨论帖。

已弃用

已删除:

版本 6.0.0

原因:

此集合及其中的所有内容都已无人维护且已弃用。

替代方案:

未知。

概要

别名：network.avi.avi_alertconfig

要求

执行此模块的主机上需要以下要求。

  • avisdk

参数

参数

注释

action_group_ref

字符串

警报配置将触发所选警报操作，该操作可以发送通知并执行控制脚本。

它是对类型为 actiongroupconfig 的对象的引用。

alert_rule

字符串 / 必需

匹配事件或客户端日志的过滤器列表，用于触发警报。

api_context

字典

Avi API 上下文，包括当前会话 ID 和 CSRF 令牌。

这允许用户执行单点登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

autoscale_alert

布尔值

此警报配置适用于自动缩放警报。

选择

  • false

  • true

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时要使用的 Patch 操作。

选择

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选择

  • "put" ←（默认）

  • "patch"

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi 控制器登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

控制器

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于重用具有会话 ID 的现有会话

默认值： ""

密码

字符串

Avi 控制器密码

端口

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 ID，用于重用具有 csrftoken 的现有会话

默认值： ""

租户

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

超时

字符串

Avi 控制器请求超时

默认值： 300

令牌

字符串

Avi 控制器 API 令牌

默认值： ""

用户名

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 Avi 会话信息缓存为事实。

选择

  • false ←（默认）

  • true

类别

字符串 / 必需

确定当事件发生时（实时）是否立即引发警报，或者在滚动时间内发生指定数量的事件后引发警报

窗口。

枚举选项 - REALTIME、ROLLINGWINDOW、WATERMARK。

API 或模块中未指定时的默认值由 Avi 控制器解释为 REALTIME。

控制器

字符串

控制器的 IP 地址或主机名。 默认值是环境变量 AVI_CONTROLLER。

描述

字符串

自定义描述字段。

已启用

布尔值

启用或禁用此警报配置，使其不生成新警报。

当 API 或模块中未指定时，默认值会被 Avi 控制器解释为 True。

选择

  • false

  • true

expiry_time

字符串

警报在过期时间过后将被过期并删除。

触发警报的原始事件仍保留在事件日志中。

允许的值为 1-31536000。

当 API 或模块中未指定时，默认值会被 Avi 控制器解释为 86400。

name

字符串 / 必需

警报配置的名称。

obj_uuid

字符串

触发警报的资源的 UUID。

object_type

字符串

警报配置关联的对象类型。

有效的对象类型为 - 虚拟服务、池、服务引擎。

枚举选项 - VIRTUALSERVICE、POOL、HEALTHMONITOR、NETWORKPROFILE、APPLICATIONPROFILE、HTTPPOLICYSET、DNSPOLICY、SECURITYPOLICY、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、

GSLBSERVICERUNTIMEBATCH、WAFPOLICYPSMGROUP、PINGACCESSAGENT、SERVICEENGINEPOLICY、NATPOLICY、SSOPOLICY、PROTOCOLPARSER、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、

IPAMDNSPROVIDERPROFILE、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、METRICSRUNTIMESUMMARY、METRICSRUNTIMEDETAIL、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、NDTABLERUNTIME、IP6STATRUNTIME、ICMP6STATRUNTIME、SEVSSPLACEMENT、L4POLICYSETSTATS、L4POLICYSETINTERNAL、BGPDEBUGINFO、SHARD、

CPUSTATRUNTIMEDETAIL、SEASSERTSTATRUNTIME、SEFAULTINJECTINFRA、SEAGENTASSERTSTATRUNTIME、SEDATASTORESTATUS、DIFFQUEUESTATUS、IP6ROUTETABLERUNTIME、

SECURITYMGRSTATE、VIRTUALSERVICESESCALEOUTSTATUS、SHARDSERVERSTATUS、SEAGENTSHARDCLIENTRESOURCEMAP、SEAGENTCONSISTENTHASH、SEAGENTVNICDBHISTORY、

SEAGENTSHARDCLIENTAPPMAP、SEAGENTSHARDCLIENTEVENTHISTORY、SENATSTATRUNTIME、SENATFLOWRUNTIME、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。

密码

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

recommendation

字符串

警报配置的建议。

rolling_window

字符串

只有在时间窗口内达到或超过事件数量时，才会生成警报。

允许的值为 1-31536000。

当 API 或模块中未指定时，默认值会被 Avi 控制器解释为 300。

source

字符串 / 必需

表示此警报配置中使用的系统事件或客户端日志类型。

枚举选项 - CONN_LOGS、APP_LOGS、EVENT_LOGS、METRICS。

state

字符串

应应用于实体的状态。

选择

  • "absent"

  • "present" ← (默认)

summary

字符串

生成警报的原因摘要。

租户

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值： "admin"

tenant_ref

字符串

它是对租户类型对象的引用。

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值： ""

threshold

字符串

仅当事件数量在选定的时间范围内满足或超过此数量时才会创建警报。

允许的值为 1-65536。

当 API 或模块中未指定时，默认值会被 Avi 控制器解释为 1。

throttle

字符串

自上次为此警报配置引发警报以来，在此期间会抑制（限制）警报。

允许的值为 0-31536000。

当 API 或模块中未指定时，默认值会被 Avi 控制器解释为 600。

url

字符串

对象的 Avi 控制器 URL。

用户名

字符串

用于访问 Avi 控制器的用户名。默认值为环境变量 AVI_USERNAME。

uuid

字符串

对象的唯一对象标识符。

注释

注意

示例

- name: Example to create AlertConfig object
  community.network.avi_alertconfig:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_alertconfig

返回值

常见返回值记录在此处 此处，以下是此模块独有的字段

键

描述

obj

字典

AlertConfig (api/alertconfig) 对象

返回: 成功，已更改

状态

  • 此模块将在 6.0.0 版本中删除。[已弃用]

  • 有关更多信息，请参阅 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)