Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network

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

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

Обзор

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

Требования

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

  • avisdk

Параметры

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

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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
словарь
успех, изменение
Объект AlertConfig (api/alertconfig)


Авторы

  • Гaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>

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

Spec-Zone.ru

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