Spec-Zone.ru › Ansible

community.network.avi_alertconfig модуль — Модуль для настройки объекта AlertConfig Avi RESTful

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: community.network.avi_alertconfig.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Псевдонимы: network.avi.avi_alertconfig

Требования

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

  • avisdk

Параметры

Параметр

Комментарии

action_group_ref

строка

Настройка оповещения вызовет выбранное действие оповещения, которое может отправлять уведомления и выполнять скрипт управления.

Это ссылка на объект типа actiongroupconfig.

alert_rule

строка / обязательно

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

api_context

словарь

Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF.

Это позволяет пользователю выполнить одно вход и повторно использовать сеанс.

api_version

строка

Версия API Avi для использования с API Avi и объектами.

По умолчанию: "16.4.4"

autoscale_alert

логический тип

Эта настройка оповещения относится к оповещениям масштабирования.

Варианты:

  • false
  • true

avi_api_patch_op

строка

Операция исправления для использования при использовании avi_api_update_method как исправления.

Варианты:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

строка

Метод по умолчанию для обновления объекта — HTTP PUT.

Установка в «исправление» переопределит это поведение, чтобы использовать HTTP PATCH.

Варианты:

  • "put" ← (по умолчанию)
  • "patch"

avi_credentials

словарь

Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi Controller.

api_version

строка

Версия контроллера Avi

По умолчанию: "16.4.4"

controller

строка

IP-адрес или SQDN контроллера Avi

csrftoken

строка

Маркер csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса

По умолчанию: ""

password

строка

Пароль контроллера Avi

port

строка

Порт контроллера Avi

session_id

строка

Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken

По умолчанию: ""

tenant

строка

Тенд контроллера Avi

По умолчанию: "admin"

tenant_uuid

строка

UUID клиента контроллера Avi

По умолчанию: ""

timeout

строка

Таймаут запроса контроллера Avi

По умолчанию: 300

token

строка

Токен API контроллера Avi

По умолчанию: ""

username

строка

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

логический тип

Отключает кеширование информации о сеансе avi в качестве факта.

Варианты:

  • false ← (по умолчанию)
  • true

category

строка / обязательно

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

Варианты перечисления — REALTIME, ROLLINGWINDOW, WATERMARK.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как REALTIME.

controller

string

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER.

description

string

Пользовательское поле описания.

enabled

boolean

Включить или отключить данную конфигурацию оповещения для генерации новых оповещений.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • true

expiry_time

string

Оповещение истекает и удаляется после истечения срока действия.

Исходное событие, вызвавшее оповещение, остается в журнале событий.

Допустимые значения: от 1 до 31536000.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 86400.

name

string / обязательно

Имя конфигурации оповещения.

obj_uuid

string

UUID ресурса, для которого было поднято оповещение.

object_type

string

Тип объекта, к которому привязана конфигурация оповещения.

Допустимые типы объектов: виртуальная служба, пул, сетевой шлюз.

Перечисление вариантов — 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.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.

recommendation

string

Рекомендация для конфигурации оповещения.

rolling_window

string

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

Допустимые значения: от 1 до 31536000.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.

source

string / обязательно

Указывает на события системы или тип клиентских журналов, используемых в данной конфигурации оповещения.

Перечисление вариантов — CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.

state

string

Состояние, которое должно быть применено к сущности.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

summary

string

Краткое описание причины генерации тревоги.

tenant

string

Имя используемого для всех API-вызовов Avi и контекста объекта арендатора.

По умолчанию: "admin"

tenant_ref

string

Ссылка на объект типа арендатор.

tenant_uuid

string

UUID арендатора, используемого для всех API-вызовов Avi и контекста объекта.

По умолчанию: ""

threshold

string

Тревога создается только тогда, когда количество событий достигает или превышает это число в течение выбранного интервала времени.

Допустимые значения: 1-65536.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.

throttle

string

Тревоги подавляются (throttled) на этот период времени с момента последнего поднятия тревоги для данной конфигурации тревоги.

Допустимые значения: 0-31536000.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 600.

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME

uuid

string

Уникальный идентификатор объекта.

Примечания

Примечание

  • Для получения дополнительной информации об использовании Ansible для управления устройствами Avi Network см. https://www.ansible.com/ansible-avi-networks.

Примеры

- 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

dictionary

Объект AlertConfig (api/alertconfig)

Возвращается: success, changed

Авторы

  • Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_alertconfig_module.html

Spec-Zone.ru

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