Spec-Zone.ru › Ansible 2.9

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 для использования с Avi API и объектами.
autoscale_alert
булево
    Варианты:
  • нет
  • да
Эта настройка оповещения применяется к оповещениям автомасштабирования.
avi_api_patch_op
-
добавлен в 2.5
    Варианты:
  • добавить
  • заменить
  • удалить
Операция исправления, которая используется при использовании avi_api_update_method как patch.
avi_api_update_method
-
добавлен в 2.5
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка на patch переопределит это поведение на использование HTTP PATCH.
avi_credentials
словарь
добавлен в 2.5
Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в систему Avi Controller.
api_version
-
По умолчанию:
"16.4.4"
Версия контроллера Avi
controller
-
IP-адрес или доменное имя контроллера.
csrftoken
-
Маркер csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса.
password
-
Пароль контроллера Avi.
port
-
Порт контроллера Avi.
session_id
-
Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с маркёром csrf.
tenant
-
По умолчанию:
"admin"
Тенент контроллера Avi.
tenant_uuid
-
UUID тенента контроллера Avi.
timeout
-
По умолчанию:
300
Время ожидания запроса контроллера Avi.
token
-
Токен API контроллера Avi.
username
-
Имя пользователя контроллера Avi.
avi_disable_session_cache_as_fact
булево
добавлен в 2.6
    Варианты:
  • нет
  • да
Отключает кеширование информации о сеансе avi в качестве факта.
category
- / обязательно
Определяет, поднимается ли оповещение немедленно при возникновении события (режим реального времени) или после возникновения определённого количества событий в окне скользящего среднего.
Варианты перечисления — REALTIME, ROLLINGWINDOW, WATERMARK.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как REALTIME.
controller
строка
По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
description
-
Пользовательское поле описания.
enabled
булево
    Варианты:
  • нет
  • да
Включить или отключить эту настройку оповещения для генерации новых оповещений.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.
expiry_time
-
Оповещение истекает и удаляется после истечения времени истечения срока действия.
Исходное событие, вызвавшее оповещение, остается в журнале событий.
Допустимые значения — 1–31536000.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 86400.
name
- / обязательно
Имя конфигурации оповещения.
obj_uuid
-
Uuid ресурса, для которого было поднято оповещение.
тип_объекта
-
Тип объекта, к которому привязана конфигурация оповещения.
Допустимые типы объектов: виртуальная служба, пул, движок службы.
Варианты перечисления — 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.
рекомендация
-
Рекомендация для alertconfig.
rolling_window
-
Оповещение генерируется только в том случае, если количество событий достигает или превышает заданное значение в течение заданного временного окна.
Допустимые значения — 1-31536000.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.
источник
- / обязательно
Указывает на системные события или тип журналов клиентов, используемых в этой конфигурации оповещения.
Варианты перечисления — CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.
состояние
-
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к объекту.
краткое_описание
-
Краткое описание причины генерации оповещения.
арендатор
строка
Значение по умолчанию:
"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 см. на сайте 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)


Статус

  • Этот модуль не гарантирует обратную совместимость. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Gaurav Rastogi (@grastogi23) <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.9/modules/avi_alertconfig_module.html

Spec-Zone.ru

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