Class: Ansible::Ruby::Modules::Avi_alertconfig

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Avi_alertconfig

Defined in:

lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb

Overview

This module is used to configure AlertConfig object more examples at U(github.com/avinetworks/devops)

Instance Method Summary

• #action_group_ref ⇒ Object^?

  The alert config will trigger the selected alert action, which can send notifications and execute a controlscript.,It is a reference to an object of type actiongroupconfig.

• #alert_rule ⇒ Object

  List of filters matching on events or client logs used for triggering alerts.

• #autoscale_alert ⇒ Symbol^?

  This alert config applies to auto scale alerts.

• #avi_api_patch_op ⇒ :add, ...

  Patch operation to use when using avi_api_update_method as patch.

• #avi_api_update_method ⇒ :put, ...

  Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.

• #category ⇒ Object

  Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time,window.,Enum options - REALTIME, ROLLINGWINDOW, WATERMARK.,Default value when not specified in API or module is interpreted by Avi Controller as REALTIME.

• #description ⇒ Object^?

  A custom description field.

• #enabled ⇒ Symbol^?

  Enable or disable this alert config from generating new alerts.,Default value when not specified in API or module is interpreted by Avi Controller as True.

• #expiry_time ⇒ Object^?

  An alert is expired and deleted after the expiry time has elapsed.,The original event triggering the alert remains in the event’s log.,Allowed values are 1-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 86400.,Units(SEC).

• #name ⇒ String

  Name of the alert configuration.

• #obj_uuid ⇒ Object^?

  Uuid of the resource for which alert was raised.

• #object_type ⇒ Object^?

  The object type to which the alert config is associated with.,Valid object types are - virtual service, pool, service engine.,Enum options - 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,,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, 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.

• #recommendation ⇒ Object^?

  Recommendation of alertconfig.

• #rolling_window ⇒ Object^?

  Only if the number of events is reached or exceeded within the time window will an alert be generated.,Allowed values are 1-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC).

• #source ⇒ Object

  Signifies system events or the type of client logsused in this alert configuration.,Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.

• #state ⇒ :absent, ...

  The state that should be applied on the entity.

• #summary ⇒ Object^?

  Summary of reason why alert is generated.

• #tenant_ref ⇒ Object^?

  It is a reference to an object of type tenant.

• #threshold ⇒ Object^?

  An alert is created only when the number of events meets or exceeds this number within the chosen time frame.,Allowed values are 1-65536.,Default value when not specified in API or module is interpreted by Avi Controller as 1.

• #throttle ⇒ Object^?

  Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config.,Allowed values are 0-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 600.,Units(SEC).

• #url ⇒ Object^?

  Avi controller URL of the object.

• #uuid ⇒ Object^?

  Unique object identifier of the object.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#action_group_ref ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 25

attribute :action_group_ref

#alert_rule ⇒ Object

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 28

attribute :alert_rule

#autoscale_alert ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 32

attribute :autoscale_alert

#avi_api_patch_op ⇒ :add, ...

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 21

attribute :avi_api_patch_op

#avi_api_update_method ⇒ :put, ...

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 17

attribute :avi_api_update_method

#category ⇒ Object

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 36

attribute :category

#description ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 40

attribute :description

#enabled ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 43

attribute :enabled

#expiry_time ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 47

attribute :expiry_time

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 50

attribute :name

#obj_uuid ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 54

attribute :obj_uuid

#object_type ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 57

attribute :object_type

#recommendation ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 60

attribute :recommendation

#rolling_window ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 63

attribute :rolling_window

#source ⇒ Object

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 66

attribute :source

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 13

attribute :state

#summary ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 70

attribute :summary

#tenant_ref ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 73

attribute :tenant_ref

#threshold ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 76

attribute :threshold

#throttle ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 79

attribute :throttle

#url ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 82

attribute :url

#uuid ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/avi/avi_alertconfig.rb', line 85

attribute :uuid