Spec-Zone.ru › Ansible 2.6

avi_alertconfig - Модуль для настройки объекта AlertConfig Avi RESTful

Новая версия 2.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Этот модуль используется для настройки объекта AlertConfig
  • дополнительные примеры на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
action_group_ref
Конфигурация оповещения сработает при выбранном действии оповещения, которое может отправлять уведомления и выполнять скрипт управления.
Это ссылка на объект типа actiongroupconfig.
alert_rule
обязательно
Список фильтров, соответствующих событиям или журналам клиентов, используемым для запуска оповещений.
api_context
(добавлен в 2.5)
Контекст API Avi, который включает текущий идентификатор сессии и маркер CSRF.
Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version По умолчанию:
"16.4.4"
Версия API Avi для использования с API Avi и объектами.
autoscale_alert
bool
    Варианты:
  • no
  • yes
Данная конфигурация оповещения применяется к оповещениям автоматического масштабирования.
avi_api_patch_op
(добавлен в 2.5)
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method как исправление.
avi_api_update_method
(добавлен в 2.5)
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials
(добавлен в 2.5)
Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
category
обязательно
Определяет, будет ли оповещение поднято немедленно при возникновении события (режим реального времени) или после того, как произойдет указанное число событий в течение заданного временного интервала.
окна.
Варианты перечисления — REALTIME, ROLLINGWINDOW, WATERMARK.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как REALTIME.
controller По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
description
Поле пользовательского описания.
enabled
bool
    Варианты:
  • no
  • yes
Включить или отключить эту конфигурацию оповещения для генерации новых оповещений.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.
expiry_time
Оповещение считается просроченным и удаляется после истечения срока действия.
Исходное событие, вызвавшее оповещение, остается в журнале событий.
Допустимые значения — 1–31536000.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 86400.
Единицы (СЕК).
name
обязательно
Название конфигурации оповещения.
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,
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.
password По умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.
recommendation
Рекомендация alertconfig.
rolling_window
Оповещение генерируется только в том случае, если количество событий достигает или превышает заданное значение в течение заданного временного интервала.
Допустимые значения — 1–31536000.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 300.
Единицы (СЕК).
source
обязательно
Указывает системные события или тип журналов клиентов, используемых в этой конфигурации оповещения.
Варианты перечисления — CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.
state
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
summary
Краткое описание причины генерации оповещения.
tenant По умолчанию:
"admin"
Имя клиента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
Ссылка на объект типа tenant.
tenant_uuid По умолчанию:
""
UUID клиента, используемого для всех вызовов API Avi и контекста объекта.
threshold
Оповещение создается только тогда, когда количество событий соответствует или превышает это значение в течение выбранного временного интервала.
Допустимые значения — 1–65536.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 1.
throttle
Оповещения подавляются (ограничиваются) в течение этого времени с момента последнего оповещения по этой конфигурации оповещения.
Допустимые значения — 0–31536000.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 600.
Единицы (СЕК).
url
URL контроллера Avi для объекта.
username По умолчанию:
""
Имя пользователя для доступа к контроллеру 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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, ниже приведены поля, уникальные для данного модуля:

Ключ Возвращаемое значение Описание
obj
dict
 success, changed
Объект AlertConfig (api/alertconfig)


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в Документации по поддержке и обслуживанию модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • Gaurav 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.6/modules/avi_alertconfig_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API