cloudvision.api.arista.alert.v1 package

Module contents

class cloudvision.api.arista.alert.v1.Alert(configuration_errors: ~cloudvision.api.arista.alert.v1.ConfigErrors = <PLACEHOLDER>, endpoint_errors: ~cloudvision.api.arista.alert.v1.EndpointErrors = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>)[source]

Bases: Message

Alert is the current status of the alert system

configuration_errors: ConfigErrors = <PLACEHOLDER>: configuration_errors contain any configuration errors reported by the backend

endpoint_errors: EndpointErrors = <PLACEHOLDER>: endpoint_errors contain any failed attempts to send alerts

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the configuration was last modified

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the user who last modified the configuration

class cloudvision.api.arista.alert.v1.AlertConfig(settings: ~cloudvision.api.arista.alert.v1.Settings = <PLACEHOLDER>, rules: ~cloudvision.api.arista.alert.v1.Rules = <PLACEHOLDER>, broadcast_groups: ~cloudvision.api.arista.alert.v1.BroadcastGroups = <PLACEHOLDER>)[source]

Bases: Message

AlertConfig is the configuration for sending alerts

broadcast_groups: BroadcastGroups = <PLACEHOLDER>: broadcast_groups are groups of endpoints that alerts are sent to

rules: Rules = <PLACEHOLDER>: rules define how we route alerts to broadcast groups

settings: Settings = <PLACEHOLDER>: settings is the global default settings for various endpoints used in broadcast groups. Can be overwritten in individual endpoint settings

class cloudvision.api.arista.alert.v1.AlertConfigRequest(time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.AlertConfigResponse(value: 'AlertConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the AlertConfig instance in this response.

value: AlertConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.AlertConfigServiceBase[source]

Bases: ServiceBase

async get_all(alert_config_stream_request: AlertConfigStreamRequest) → AsyncIterator[AlertConfigStreamResponse][source]

async get_one(alert_config_request: AlertConfigRequest) → AlertConfigResponse[source]

async set(alert_config_set_request: AlertConfigSetRequest) → AlertConfigSetResponse[source]

async subscribe(alert_config_stream_request: AlertConfigStreamRequest) → AsyncIterator[AlertConfigStreamResponse][source]

async subscribe_meta(alert_config_stream_request: AlertConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(alert_config_stream_request: AlertConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AlertConfigStreamResponse][source]

async get_one(alert_config_request: AlertConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AlertConfigResponse[source]

async set(alert_config_set_request: AlertConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AlertConfigSetResponse[source]

async subscribe(alert_config_stream_request: AlertConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AlertConfigStreamResponse][source]

async subscribe_meta(alert_config_stream_request: AlertConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.alert.v1.AlertConfigSetRequest(value: 'AlertConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: AlertConfig = <PLACEHOLDER>: AlertConfig carries the value to set into the datastore. See the documentation on the AlertConfig struct for which fields are required.

class cloudvision.api.arista.alert.v1.AlertConfigSetResponse(value: 'AlertConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==CreatedAt will include this instance.

value: AlertConfig = <PLACEHOLDER>: Value carries all the values given in the AlertConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.alert.v1.AlertConfigStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each AlertConfig at end. * Each AlertConfig response is fully-specified (all fields set).

start: Returns the state of each AlertConfig at start, followed by updates until now. * Each AlertConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each AlertConfig at start, followed by updates until end. * Each AlertConfig response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.AlertConfigStreamResponse(value: 'AlertConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this AlertConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the AlertConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: AlertConfig = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.alert.v1.AlertRequest(time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.AlertResponse(value: 'Alert' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Alert instance in this response.

value: Alert = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.AlertServiceBase[source]

Bases: ServiceBase

async get_all(alert_stream_request: AlertStreamRequest) → AsyncIterator[AlertStreamResponse][source]

async get_one(alert_request: AlertRequest) → AlertResponse[source]

async subscribe(alert_stream_request: AlertStreamRequest) → AsyncIterator[AlertStreamResponse][source]

async subscribe_meta(alert_stream_request: AlertStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(alert_stream_request: AlertStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AlertStreamResponse][source]

async get_one(alert_request: AlertRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AlertResponse[source]

async subscribe(alert_stream_request: AlertStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AlertStreamResponse][source]

async subscribe_meta(alert_stream_request: AlertStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.alert.v1.AlertStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each Alert at end. * Each Alert response is fully-specified (all fields set).

start: Returns the state of each Alert at start, followed by updates until now. * Each Alert response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each Alert at start, followed by updates until end. * Each Alert response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.AlertStreamResponse(value: 'Alert' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Alert’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Alert value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: Alert = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.alert.v1.AzureOAuth(client_id: str | None = <PLACEHOLDER>, tenant_id: str | None = <PLACEHOLDER>, client_secret: str | None = <PLACEHOLDER>, auth_uri: str | None = <PLACEHOLDER>, scopes: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

AzureOAuth contains the settings for the sending of emails on Azure smtp server

auth_uri: str | None = <PLACEHOLDER>: auth_uri is the URI used for OAuth this should always be https://login.microsoftonline.com/ unless using a very custom set up, where the Azure enviroment is not running on microsoft servers

client_id: str | None = <PLACEHOLDER>: client_id of the Azure environment

client_secret: str | None = <PLACEHOLDER>: client_secret is a user generated secret key used for auth

scopes: ___fmp__.RepeatedString = <PLACEHOLDER>: scopes are the scopes that auth is granted for

tenant_id: str | None = <PLACEHOLDER>: tenant_id of the Azure environment

class cloudvision.api.arista.alert.v1.BroadcastGroup(email: ~cloudvision.api.arista.alert.v1.EmailEndpoints = <PLACEHOLDER>, webhook: ~cloudvision.api.arista.alert.v1.WebhookEndpoints = <PLACEHOLDER>, slack: ~cloudvision.api.arista.alert.v1.SlackEndpoints = <PLACEHOLDER>, opsgenie: ~cloudvision.api.arista.alert.v1.OpsgenieEndpoints = <PLACEHOLDER>, pushover: ~cloudvision.api.arista.alert.v1.PushoverEndpoints = <PLACEHOLDER>, pagerduty: ~cloudvision.api.arista.alert.v1.PagerdutyEndpoints = <PLACEHOLDER>, victorops: ~cloudvision.api.arista.alert.v1.VictorOpsEndpoints = <PLACEHOLDER>, gchat: ~cloudvision.api.arista.alert.v1.GoogleChatEndpoints = <PLACEHOLDER>, msteams: ~cloudvision.api.arista.alert.v1.MsTeamsEndpoints = <PLACEHOLDER>, sendgrid: ~cloudvision.api.arista.alert.v1.SendgridEndpoints = <PLACEHOLDER>, syslog: ~cloudvision.api.arista.alert.v1.SyslogEndpoints = <PLACEHOLDER>, snmp: ~cloudvision.api.arista.alert.v1.SnmpEndpoints = <PLACEHOLDER>, cue_syslog: ~cloudvision.api.arista.alert.v1.CueSyslogEndpoints = <PLACEHOLDER>, cue_snmp: ~cloudvision.api.arista.alert.v1.CueSnmpEndpoints = <PLACEHOLDER>, cue_sendgrid: ~cloudvision.api.arista.alert.v1.CueSendgridEndpoints = <PLACEHOLDER>, zoom: ~cloudvision.api.arista.alert.v1.ZoomEndpoints = <PLACEHOLDER>, ms_graph_send_mail: ~cloudvision.api.arista.alert.v1.MsGraphSendMailEndpoints = <PLACEHOLDER>, cv_action: ~cloudvision.api.arista.alert.v1.CvActionEndpoints = <PLACEHOLDER>)[source]

Bases: Message

BroadcastGroup is a series of endpoints that alerts are sent to if routed there by a rule No restriction on the number of types of endpoints that can be defined

cue_sendgrid: CueSendgridEndpoints = <PLACEHOLDER>: cue_sendgrid is a set of cue sendgrid endpoints to send alerts to as part of this group

cue_snmp: CueSnmpEndpoints = <PLACEHOLDER>: cue_snmp is a set of cue snmp endpoints to send alerts to as part of this group

cue_syslog: CueSyslogEndpoints = <PLACEHOLDER>: cue_syslog is a set of cue syslog endpoints to send alerts to as part of this group

cv_action: CvActionEndpoints = <PLACEHOLDER>: cv_action is a set of Cloud Vision Portal Action endpoints to send alerts to as part of this group. If the field is present during a Set call, all the Actions are set to authenticate as the calling user.

email: EmailEndpoints = <PLACEHOLDER>: email is a set of email endpoints to send alerts to as part of this group

gchat: GoogleChatEndpoints = <PLACEHOLDER>: gchat is a set of google chat endpoints to send alerts to as part of this group

ms_graph_send_mail: MsGraphSendMailEndpoints = <PLACEHOLDER>: ms_graph_send_mail is a set of Microsoft Graph sendMail endpoints to send alerts to as part of this group

msteams: MsTeamsEndpoints = <PLACEHOLDER>: msteams is a set of MS teams endpoints to send alerts to as part of this group

opsgenie: OpsgenieEndpoints = <PLACEHOLDER>: opsgenie is a set of opsgenie endpoints to send alerts to as part of this group

pagerduty: PagerdutyEndpoints = <PLACEHOLDER>: pagerduty is a set of pagerduty endpoints to send alerts to as part of this group

pushover: PushoverEndpoints = <PLACEHOLDER>: pushover is a set of pushover endpoints to send alerts to as part of this group

sendgrid: SendgridEndpoints = <PLACEHOLDER>: sendgrid is a set of sendgrid endpoints to send alerts to as part of this group

slack: SlackEndpoints = <PLACEHOLDER>: slack is a set of slack endpoints to send alerts to as part of this group

snmp: SnmpEndpoints = <PLACEHOLDER>: snmp is a set of snmp endpoints to send alerts to as part of this group

syslog: SyslogEndpoints = <PLACEHOLDER>: syslog is a set of syslog endpoints to send alerts to as part of this group

victorops: VictorOpsEndpoints = <PLACEHOLDER>: victorops is a set of victorops endpoints to send alerts to as part of this group

webhook: WebhookEndpoints = <PLACEHOLDER>: webhook is a set of webhook endpoints to send alerts to as part of this group

zoom: ZoomEndpoints = <PLACEHOLDER>: zoom is a set of zoom endpoints to send alerts to as part of this group

class cloudvision.api.arista.alert.v1.BroadcastGroups(values: ~typing.Dict[str, ~cloudvision.api.arista.alert.v1.BroadcastGroup] = <PLACEHOLDER>)[source]

Bases: Message

BroadcastGroups is a collection of named broadcast groups

values: Dict[str, BroadcastGroup] = <PLACEHOLDER>: values is a map of user defined ids to broadcast groups. No restrictions to naming applies

class cloudvision.api.arista.alert.v1.ConfigError(path: str | None = <PLACEHOLDER>, error_type: ~cloudvision.api.arista.alert.v1.ConfigErrorType = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigError is an error caused by an invalid config being rejected by the backend

error: str | None = <PLACEHOLDER>: error is a user-friendly error message

error_type: ConfigErrorType = <PLACEHOLDER>: error_type is the type of error, this allows custom handling of different error types

path: str | None = <PLACEHOLDER>: path is the ‘path’ to the invalid config element, eg: path.userPathName.email_configs[1].to = the ‘to’ field of the second email config of the ‘userPathName’ broadcast_group

class cloudvision.api.arista.alert.v1.ConfigErrorType(value: int)[source]

Bases: Enum

ConfigErrorType describes the set of possible config error types

ILLEGAL_VALUE = ConfigErrorType.ILLEGAL_VALUE: CONFIG_ERROR_TYPE_ILLEGAL_VALUE is caused by a value outside of its bounds

INVALID_FORMAT = ConfigErrorType.INVALID_FORMAT

url)

Type:: CONFIG_ERROR_TYPE_INVALID_FORMAT is caused by invalid format for value (eg

INVALID_SYNTAX = ConfigErrorType.INVALID_SYNTAX

regex)

Type:: CONFIG_ERROR_TYPE_INVALID_SYNTAX is caused by invalid syntax for value (eg

INVALID_TYPE = ConfigErrorType.INVALID_TYPE: CONFIG_ERROR_TYPE_INVALID_TYPE is caused by the wrong type found in backing store

MISSING_REQUIRED = ConfigErrorType.MISSING_REQUIRED: CONFIG_ERROR_TYPE_MISSING_REQUIRED is caused by a missing required attribute

TEMPLATE_INVALID = ConfigErrorType.TEMPLATE_INVALID: CONFIG_ERROR_TYPE_TEMPLATE_INVALID is caused by failure to parse a template

UNSPECIFIED = ConfigErrorType.UNSPECIFIED: CONFIG_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.ConfigErrors(values: ~typing.List[~cloudvision.api.arista.alert.v1.ConfigError] = <PLACEHOLDER>)[source]

Bases: Message

ConfigErrors is a list of configuration-related errors

values: List[ConfigError] = <PLACEHOLDER>: values is a list of errors

class cloudvision.api.arista.alert.v1.CueData(values: ~typing.Dict[str, str] = <PLACEHOLDER>)[source]

Bases: Message

CueData contains additional cue-specific data

values: Dict[str, str] = <PLACEHOLDER>: values can contain some additional data which is required by the cue specific provider

class cloudvision.api.arista.alert.v1.CueSendgridEndpoint(send_resolved: bool | None = <PLACEHOLDER>, to: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>)[source]

Bases: Message

CueSendgridEndpoint contains the required information for an alert to be sent to a cue sendgrid endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings This overrides the value used in Settings message in the global alert config

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

to: str | None = <PLACEHOLDER>: to address to send email to

class cloudvision.api.arista.alert.v1.CueSendgridEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.CueSendgridEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

CueSendgridEndpoints is a set of cue sendgrid endpoints

values: List[CueSendgridEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.CueSendgridSettings(api_key: str | None = <PLACEHOLDER>, from_: str | None = <PLACEHOLDER>)[source]

Bases: Message

CueSendgridSettings contain the settings for sending cue alerts to sendgrid

api_key: str | None = <PLACEHOLDER>: api_key is the key used to connect to the sendgrid APIs

from_: str | None = <PLACEHOLDER>: from is the sender’s address in the email sent

class cloudvision.api.arista.alert.v1.CueSnmpAuth(community: str | None = <PLACEHOLDER>, username: str | None = <PLACEHOLDER>, security_level: ~cloudvision.api.arista.alert.v1.SnmpSecurityLevel = <PLACEHOLDER>, authentication_protocol: ~cloudvision.api.arista.alert.v1.CueSnmpAuthProtocol = <PLACEHOLDER>, authentication_passphrase: str | None = <PLACEHOLDER>, privacy_protocol: ~cloudvision.api.arista.alert.v1.CueSnmpPrivProtocol = <PLACEHOLDER>, privacy_passphrase: str | None = <PLACEHOLDER>)[source]

Bases: Message

CueSNMPAuth is the authentication

authentication_passphrase: str | None = <PLACEHOLDER>: authentication_passphrase is the passphrase to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels

authentication_protocol: CueSnmpAuthProtocol = <PLACEHOLDER>: authentication_protocol is the protocol to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels

community: str | None = <PLACEHOLDER>: community is the community string used for authentication in SNMPv1 and v2c required if version < 3

privacy_passphrase: str | None = <PLACEHOLDER>: privacy_passphrase is the passphrase to use for privacy in SNMPv3 required for AUTH_PRIV security level

privacy_protocol: CueSnmpPrivProtocol = <PLACEHOLDER>: privacy_protocol is the protocol to use for privacy in SNMPv3 required for AUTH_PRIV security level

security_level: SnmpSecurityLevel = <PLACEHOLDER>: security_level the security level for SNMPv3

username: str | None = <PLACEHOLDER>: username the username for SNMPv3 auth

class cloudvision.api.arista.alert.v1.CueSnmpAuthProtocol(value: int)[source]

Bases: Enum

CueSNMPAuthProtocol represents the authentication protocol to be used

MD5 = CueSnmpAuthProtocol.MD5: CUE_SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

SHA = CueSnmpAuthProtocol.SHA: CUE_SNMP_AUTH_PROTOCOL_SHA use the sha protocol

UNSPECIFIED = CueSnmpAuthProtocol.UNSPECIFIED: CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.CueSnmpEndpoint(send_resolved: bool | None = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.CueSnmpSettings = <PLACEHOLDER>)[source]

Bases: Message

CueSNMPEndpoint contains the required information for an alert to be sent to a cue SNMP endpoint

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: CueSnmpSettings = <PLACEHOLDER>: settings_override is the override for the cue snmp global endpoint settings

class cloudvision.api.arista.alert.v1.CueSnmpEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.CueSnmpEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

CueSnmpEndpoints is a set of cue SNMP endpoints

values: List[CueSnmpEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.CueSnmpPrivProtocol(value: int)[source]

Bases: Enum

CueSNMPPrivProtocol represents the privacy protocol to be used

AES = CueSnmpPrivProtocol.AES: CUE_SNMP_PRIV_PROTOCOL_AES use the aes protocol

DES = CueSnmpPrivProtocol.DES: CUE_SNMP_PRIV_PROTOCOL_DES use the des protocol

UNSPECIFIED = CueSnmpPrivProtocol.UNSPECIFIED: CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.CueSnmpSettings(target: str | None = <PLACEHOLDER>, port: int | None = <PLACEHOLDER>, transport: str | None = <PLACEHOLDER>, version: int | None = <PLACEHOLDER>, auth: ~cloudvision.api.arista.alert.v1.CueSnmpAuth = <PLACEHOLDER>, data: ~cloudvision.api.arista.alert.v1.CueData = <PLACEHOLDER>)[source]

Bases: Message

CueSNMPSettings contain the settings for sending cue alerts with SNMP

auth: CueSnmpAuth = <PLACEHOLDER>: auth is the optional authentication settings

data: CueData = <PLACEHOLDER>: data is additional data that maybe required for constructing the message or sending it

port: int | None = <PLACEHOLDER>: port is the network port to target

target: str | None = <PLACEHOLDER>: target is an ipv4 address to send messages to

transport: str | None = <PLACEHOLDER>: transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

version: int | None = <PLACEHOLDER>: version is the SNMP version, v2c and v3 are supported and can be set with 2 and 3 respectively

class cloudvision.api.arista.alert.v1.CueSyslogEndpoint(send_resolved: bool | None = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.CueSyslogSettings = <PLACEHOLDER>)[source]

Bases: Message

CueSyslogEndpoint contains the required information for an alert to be sent to a cue syslog endpoint

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: CueSyslogSettings = <PLACEHOLDER>: settings_override is the override for the cue syslog global endpoint settings

class cloudvision.api.arista.alert.v1.CueSyslogEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.CueSyslogEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

CueSyslogEndpoints is a set of cue syslog endpoints

values: List[CueSyslogEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.CueSyslogMessageFormat(value: int)[source]

Bases: Enum

CueSyslogMessageFormat is the message format for cue syslog messages

IDMEF = CueSyslogMessageFormat.IDMEF: CUE_SYSLOG_MESSAGE_FORMAT_IDMEF uses IDMEF message format as described here: https://datatracker.ietf.org/doc/html/rfc4765

PLAIN = CueSyslogMessageFormat.PLAIN: CUE_SYSLOG_MESSAGE_FORMAT_PLAIN format uses the text format for constructing the syslog message

UNSPECIFIED = CueSyslogMessageFormat.UNSPECIFIED: CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.CueSyslogSettings(network: str | None = <PLACEHOLDER>, address: str | None = <PLACEHOLDER>, port: int | None = <PLACEHOLDER>, message_format: ~cloudvision.api.arista.alert.v1.CueSyslogMessageFormat = <PLACEHOLDER>, append_bom_header: bool | None = <PLACEHOLDER>, data: ~cloudvision.api.arista.alert.v1.CueData = <PLACEHOLDER>)[source]

Bases: Message

CueSyslogSettings contain the settings for sending alerts with syslog for cue

address: str | None = <PLACEHOLDER>: address is the ip address to send syslog messages to

append_bom_header: bool | None = <PLACEHOLDER>: append_bom_header if true a BOM( Byte Order Mark ) will be appended to the outgoing message BOM will tell the server that is receiving the messages, that the format is UTF8.

data: CueData = <PLACEHOLDER>: data is additional data that maybe required for constructing the message or sending it

message_format: CueSyslogMessageFormat = <PLACEHOLDER>: message_format defines the message format to use

network: str | None = <PLACEHOLDER>: network is the network protocol to use, default is “udp”, options also include: tcp,tcp4,tcp6,udp4,udp6

port: int | None = <PLACEHOLDER>: port is server’s port to connect to

class cloudvision.api.arista.alert.v1.CvAction(action_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

CvAction is a single CloudVision Action to be executed.

action_id: str | None = <PLACEHOLDER>: action_id identifies the Action to run. Presently one cannot specify its arguments.

class cloudvision.api.arista.alert.v1.CvActionEndpoint(on_firing: ~cloudvision.api.arista.alert.v1.CvActions = <PLACEHOLDER>, on_resolving: ~cloudvision.api.arista.alert.v1.CvActions = <PLACEHOLDER>)[source]

Bases: Message

CvActionEndpoint contains the required information for an alert to run CloudVision Actions (e.g. python scripts).

on_firing: CvActions = <PLACEHOLDER>: on_firing are the CloudVision Actions to be executed sequentially, one after another, when an event is triggered.

on_resolving: CvActions = <PLACEHOLDER>: on_resolving are the CloudVision Actions to be executed sequentially, one after another, when an event resolves.

class cloudvision.api.arista.alert.v1.CvActionEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.CvActionEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

CvActionEndpoints is a set of Cloud Vision Portal Action endpoints

values: List[CvActionEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.CvActionSettings[source]

Bases: Message

CvActionSettings contain the settings for sending alerts to CloudVision Action

class cloudvision.api.arista.alert.v1.CvActions(values: ~typing.List[~cloudvision.api.arista.alert.v1.CvAction] = <PLACEHOLDER>)[source]

Bases: Message

CvActions is a list of CloudVision Actions to be executed sequentially, one after another.

values: List[CvAction] = <PLACEHOLDER>: values is a list of CloudVision Actions to be executed.

class cloudvision.api.arista.alert.v1.DefaultTemplate(key: ~cloudvision.api.arista.alert.v1.TemplateKey = <PLACEHOLDER>, template: str | None = <PLACEHOLDER>, multi_alert: bool | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, external_documentation: str | None = <PLACEHOLDER>, output_format: ~cloudvision.api.arista.alert.v1.TemplateOutput = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

DefaultTemplate is the system default template which is used when no user template has been set

description: str | None = <PLACEHOLDER>: description is a description of the template.

display_name: str | None = <PLACEHOLDER>: display_name is the name that can be displayed to the user for this particular template type

external_documentation: str | None = <PLACEHOLDER>: external_documentation is a url to any relevant external documentation, or “” if there is no relevant documentation.

key: TemplateKey = <PLACEHOLDER>: key identifies which template the configuration is for

multi_alert: bool | None = <PLACEHOLDER>: multi_alert is true if this template uses a multiple alert context and false if a single alert context is used.

output_format: TemplateOutput = <PLACEHOLDER>: output_format is the expected output format of this template Any submitted template will be expected to output text with valid formatting for any input or may fail validation.

template: str | None = <PLACEHOLDER>: template is the string template value to be used Templates need to be compatible with their respective parsers Message templates are read and parsed by https://golang.org/pkg/text/template/ Html templates are read and parsed by https://golang.org/pkg/html/template/ Templates must output valid JSON for certain templates Templates must not fail for any valid input

class cloudvision.api.arista.alert.v1.DefaultTemplateBatchedStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DefaultTemplate at end. * Each DefaultTemplate response is fully-specified (all fields set).

start: Returns the state of each DefaultTemplate at start, followed by updates until now. * Each DefaultTemplate response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DefaultTemplate at start, followed by updates until end. * Each DefaultTemplate response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.DefaultTemplateBatchedStreamResponse(responses: List[ForwardRef('DefaultTemplateStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[DefaultTemplateStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.alert.v1.DefaultTemplateRequest(key: 'TemplateKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: TemplateKey = <PLACEHOLDER>: Key uniquely identifies a DefaultTemplate instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.DefaultTemplateResponse(value: 'DefaultTemplate' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DefaultTemplate instance in this response.

value: DefaultTemplate = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.DefaultTemplateServiceBase[source]

Bases: ServiceBase

async get_all(default_template_stream_request: DefaultTemplateStreamRequest) → AsyncIterator[DefaultTemplateStreamResponse][source]

async get_all_batched(default_template_batched_stream_request: DefaultTemplateBatchedStreamRequest) → AsyncIterator[DefaultTemplateBatchedStreamResponse][source]

async get_meta(default_template_stream_request: DefaultTemplateStreamRequest) → MetaResponse[source]

async get_one(default_template_request: DefaultTemplateRequest) → DefaultTemplateResponse[source]

async get_some(default_template_some_request: DefaultTemplateSomeRequest) → AsyncIterator[DefaultTemplateSomeResponse][source]

async subscribe(default_template_stream_request: DefaultTemplateStreamRequest) → AsyncIterator[DefaultTemplateStreamResponse][source]

async subscribe_batched(default_template_batched_stream_request: DefaultTemplateBatchedStreamRequest) → AsyncIterator[DefaultTemplateBatchedStreamResponse][source]

async subscribe_meta(default_template_stream_request: DefaultTemplateStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(default_template_stream_request: DefaultTemplateStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DefaultTemplateStreamResponse][source]

async get_all_batched(default_template_batched_stream_request: DefaultTemplateBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DefaultTemplateBatchedStreamResponse][source]

async get_meta(default_template_stream_request: DefaultTemplateStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(default_template_request: DefaultTemplateRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DefaultTemplateResponse[source]

async get_some(default_template_some_request: DefaultTemplateSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DefaultTemplateSomeResponse][source]

async subscribe(default_template_stream_request: DefaultTemplateStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DefaultTemplateStreamResponse][source]

async subscribe_batched(default_template_batched_stream_request: DefaultTemplateBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DefaultTemplateBatchedStreamResponse][source]

async subscribe_meta(default_template_stream_request: DefaultTemplateStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.alert.v1.DefaultTemplateSomeRequest(keys: List[ForwardRef('TemplateKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[TemplateKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.DefaultTemplateSomeResponse(value: 'DefaultTemplate' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the DefaultTemplate instance in this response.

value: DefaultTemplate = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.DefaultTemplateStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each DefaultTemplate at end. * Each DefaultTemplate response is fully-specified (all fields set).

start: Returns the state of each DefaultTemplate at start, followed by updates until now. * Each DefaultTemplate response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each DefaultTemplate at start, followed by updates until end. * Each DefaultTemplate response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.DefaultTemplateStreamResponse(value: 'DefaultTemplate' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this DefaultTemplate’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the DefaultTemplate value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: DefaultTemplate = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.alert.v1.EmailEndpoint(send_resolved: bool | None = <PLACEHOLDER>, to: str | None = <PLACEHOLDER>)[source]

Bases: Message

EmailEndpoint contains the required information for an alert to be sent to an email endpoint

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

to: str | None = <PLACEHOLDER>

to address to send email to

Email does not have a http override Email does not have a settings override

class cloudvision.api.arista.alert.v1.EmailEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.EmailEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

EmailEndpoints is a set of email endpoints

values: List[EmailEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.EmailSettings(from_: str | None = <PLACEHOLDER>, smarthost: str | None = <PLACEHOLDER>, auth_username: str | None = <PLACEHOLDER>, auth_password: str | None = <PLACEHOLDER>, require_tls: bool | None = <PLACEHOLDER>, single_alert_per_email: bool | None = <PLACEHOLDER>, azure_o_auth: ~cloudvision.api.arista.alert.v1.AzureOAuth = <PLACEHOLDER>)[source]

Bases: Message

EmailSettings contain the settings for the sending of emails

auth_password: str | None = <PLACEHOLDER>: auth_password the password to use when sending emails

auth_username: str | None = <PLACEHOLDER>: auth_username the username to use when sending emails required for all auth methods

azure_o_auth: AzureOAuth = <PLACEHOLDER>: azure_o_auth used for auth when using an Azure smtp server uses auth_username, scopes is not required as we use https://outlook.office365.com/.default

from_: str | None = <PLACEHOLDER>: from is the email address to send from

require_tls: bool | None = <PLACEHOLDER>: require_tls always use TLS connections when sending emails

single_alert_per_email: bool | None = <PLACEHOLDER>: single_alert_per_email configures the Alerter such that each alert generates a separate email notification, the email will only have a single notification, the format will also be different

smarthost: str | None = <PLACEHOLDER>: smarthost is the hostname and port of the SMTP server

class cloudvision.api.arista.alert.v1.EndpointError(endpoint_type: str | None = <PLACEHOLDER>, broadcast_group_name: str | None = <PLACEHOLDER>, config_index: int | None = <PLACEHOLDER>, error_type: ~cloudvision.api.arista.alert.v1.EndpointErrorType = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>)[source]

Bases: Message

EndpointError is an error caused by a failure to send alert(s) for any reason

broadcast_group_name: str | None = <PLACEHOLDER>: broadcast_group_name is the name of the broadcast group which was being used, empty string if not group specific

config_index: int | None = <PLACEHOLDER>: config_index is the index of the config on the broadcast group or -1 if not applicable eg: if there are two email config in one broadcast group, then the indices for each are 0 and 1 note that these are done per type, so only counting email/slack/…

endpoint_type: str | None = <PLACEHOLDER>: endpoint_type indicates the type of endpoint which failed, or unknown if not endpoint-specific (eg: slack, opsgenie)

error: str | None = <PLACEHOLDER>: error is a user-friendly error message

error_type: EndpointErrorType = <PLACEHOLDER>: error_type is the type of error, this allows custom handling of different error types

class cloudvision.api.arista.alert.v1.EndpointErrorType(value: int)[source]

Bases: Enum

EndpointErrorType describes the set of possible endpoint error types.

ALERT_CAP_ERROR = EndpointErrorType.ALERT_CAP_ERROR: ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR is caused by the number of alerts sent to a sender exceeding the built-in limit

BAD_RESPONSE_ERROR = EndpointErrorType.BAD_RESPONSE_ERROR: ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR is caused by receiving a negative response from an endpoint indicating that the alert was not sent

CONNECTION_ERROR = EndpointErrorType.CONNECTION_ERROR: ENDPOINT_ERROR_TYPE_CONNECTION_ERROR is caused by errors with a connection

HTTP_POST_ERROR = EndpointErrorType.HTTP_POST_ERROR: ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR an error in sending HTTP request or reading a HTTP response

INVALID_CONFIG_ERROR = EndpointErrorType.INVALID_CONFIG_ERROR: ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR is an error caused by invalid config (missing, bad format, etc)

JSON_MARSHAL_ERROR = EndpointErrorType.JSON_MARSHAL_ERROR: ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR is caused by errors while encoding json

O_AUTH_ERROR = EndpointErrorType.O_AUTH_ERROR: ENDPOINT_ERROR_TYPE_O_AUTH_ERROR is caused when we failed authenticating using the OAuth apis

RATE_LIMIT_ERROR = EndpointErrorType.RATE_LIMIT_ERROR: ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR is caused by an Alerter rate limit being exceeded

SMTP_ERROR = EndpointErrorType.SMTP_ERROR: ENDPOINT_ERROR_TYPE_SMTP_ERROR is caused by errors with SMTP

TEMPLATE_ERROR = EndpointErrorType.TEMPLATE_ERROR: ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR is caused by errors while executing templates

TIMEOUT_ERROR = EndpointErrorType.TIMEOUT_ERROR: ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR is caused by errors with a connection

UNSPECIFIED = EndpointErrorType.UNSPECIFIED: ENDPOINT_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.EndpointErrors(values: ~typing.List[~cloudvision.api.arista.alert.v1.EndpointError] = <PLACEHOLDER>)[source]

Bases: Message

EndpointErrors is a set of errors related to sending of alerts

values: List[EndpointError] = <PLACEHOLDER>: values is the list of errors

class cloudvision.api.arista.alert.v1.EndpointType(value: int)[source]

Bases: Enum

EndpointType describes the set of possible endpoint types.

CUE_SENDGRID = EndpointType.CUE_SENDGRID: ENDPOINT_TYPE_CUE_SENDGRID represents the Cue Sendgrid endpoint type.

CUE_SNMP = EndpointType.CUE_SNMP: ENDPOINT_TYPE_CUE_SNMP represents the Cue SNMP endpoint type.

CUE_SYSLOG = EndpointType.CUE_SYSLOG: ENDPOINT_TYPE_CUE_SYSLOG represents the Cue Syslog endpoint type.

CV_ACTION = EndpointType.CV_ACTION: ENDPOINT_TYPE_CV_ACTION represents the Actions of the Cloud Vision Portal endpoint type.

EMAIL = EndpointType.EMAIL: ENDPOINT_TYPE_EMAIL represents the email endpoint type.

GOOGLE_CHAT = EndpointType.GOOGLE_CHAT: ENDPOINT_TYPE_GOOGLE_CHAT represents the Google Chat endpoint type.

MICROSOFT_TEAMS = EndpointType.MICROSOFT_TEAMS: ENDPOINT_TYPE_MICROSOFT_TEAMS represents the Microsft Teams endpoint type.

MS_GRAPH_SEND_MAIL = EndpointType.MS_GRAPH_SEND_MAIL: ENDPOINT_TYPE_MS_GRAPH_SEND_MAIL represents the Microsoft Graph sendMail endpoint type.

OPSGENIE = EndpointType.OPSGENIE: ENDPOINT_TYPE_OPSGENIE represents the Opsgenie endpoint type.

PAGERDUTY = EndpointType.PAGERDUTY: ENDPOINT_TYPE_PAGERDUTY represents the PagerDuty endpoint type.

PUSHOVER = EndpointType.PUSHOVER: ENDPOINT_TYPE_PUSHOVER represents the Pushover endpoint type.

SENDGRID = EndpointType.SENDGRID: ENDPOINT_TYPE_SENDGRID represents the Sendgrid endpoint type.

SLACK = EndpointType.SLACK: ENDPOINT_TYPE_SLACK represents the Slack endpoint type.

SNMP = EndpointType.SNMP: ENDPOINT_TYPE_SNMP represents the SNMP endpoint type.

SYSLOG = EndpointType.SYSLOG: ENDPOINT_TYPE_SYSLOG represents the Syslog endpoint type.

UNSPECIFIED = EndpointType.UNSPECIFIED: ENDPOINT_TYPE_UNSPECIFIED represents the unspecified enum value.

VICTOROPS = EndpointType.VICTOROPS: ENDPOINT_TYPE_VICTOROPS represents the VictorOps endpoint type.

WEBHOOK = EndpointType.WEBHOOK: ENDPOINT_TYPE_WEBHOOK represents the Webhook endpoint type.

ZOOM = EndpointType.ZOOM: ENDPOINT_TYPE_ZOOM represents the Zoom endpoint type.

name: str | None

value: int

class cloudvision.api.arista.alert.v1.EventFilter(events: ~cloudvision.api.arista.alert.v1.EventIdentifiers = <PLACEHOLDER>, is_test: bool | None = <PLACEHOLDER>)[source]

Bases: Message

EventFilter defines the criteria to filter response data based on the contained event identifiers. If EventFilter is nil, it’s a pass-through filter.

events: EventIdentifiers = <PLACEHOLDER>: events is a slice of EventIdentifiers that are matched against the EventIdentifiers in a SenderStatus message. Filter passes if any EventIdentifier from events match any EventIdentifier in SenderStatus. Nil fields are considered pass-through.

is_test: bool | None = <PLACEHOLDER>: is_test specifies filtering option with regard to sender status being triggered by a test event or non-test event. When set, it will discard events from status based on matching the IsTest field. If not set, returns all.

class cloudvision.api.arista.alert.v1.EventIdentifier(key: str | None = <PLACEHOLDER>, time: ~datetime.datetime = <PLACEHOLDER>, alerter_rule_index: int | None = <PLACEHOLDER>, firing: bool | None = <PLACEHOLDER>, is_test: bool | None = <PLACEHOLDER>, event_type: str | None = <PLACEHOLDER>)[source]

Bases: Message

EventIdentifier consists of the minimal information required to uniquely match which event triggered an alert and due to which rule.

alerter_rule_index: int | None = <PLACEHOLDER>: alerter_rule_index is the index of an alerter rule (don’t confuse with generation rule) that was used to match the receiver and event. The rule index changes dynamically whenever a config change is issued.

event_type: str | None = <PLACEHOLDER>: event_type is the type of the event.

firing: bool | None = <PLACEHOLDER>: firing is true if event is ongoing and false if event has finished.

is_test: bool | None = <PLACEHOLDER>: is_test is true if event was initiated via test notification page.

key: str | None = <PLACEHOLDER>: key is the event key.

time: datetime = <PLACEHOLDER>: time is the time of event generation.

class cloudvision.api.arista.alert.v1.EventIdentifiers(values: ~typing.List[~cloudvision.api.arista.alert.v1.EventIdentifier] = <PLACEHOLDER>)[source]

Bases: Message

EventIdentifiers is a list of EventIdentifier messages.

values: List[EventIdentifier] = <PLACEHOLDER>: values is a list of event identifiers.

class cloudvision.api.arista.alert.v1.EventList(event_types: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

EventList is a list of event types

event_types: ___fmp__.RepeatedString = <PLACEHOLDER>: event_types contain the event types

class cloudvision.api.arista.alert.v1.GoogleChatEndpoint(send_resolved: bool | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.GoogleChatSettings = <PLACEHOLDER>)[source]

Bases: Message

GoogleChatEndpoint contains the required information for an alert to be sent to a google chat endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: GoogleChatSettings = <PLACEHOLDER>: settings_override is the override for the google chat global endpoint settings

class cloudvision.api.arista.alert.v1.GoogleChatEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.GoogleChatEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

GoogleChatEndpoints is a set of googleChat endpoints

values: List[GoogleChatEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.GoogleChatSettings(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

GoogleChatSettings contain the settings for sending alerts to google chat

url: str | None = <PLACEHOLDER>: url is the url of the webhook to send alerts to

class cloudvision.api.arista.alert.v1.HeaderValues(values: ~typing.List[str] = <PLACEHOLDER>)[source]

Bases: Message

HeaderValues is a set of values for this header

values: List[str] = <PLACEHOLDER>: values is the header values

class cloudvision.api.arista.alert.v1.HttpHeaders(values: ~typing.Dict[str, ~cloudvision.api.arista.alert.v1.HeaderValues] = <PLACEHOLDER>)[source]

Bases: Message

HttpHeaders is a set of http headers

values: Dict[str, HeaderValues] = <PLACEHOLDER>: values is a map of http header names to values

class cloudvision.api.arista.alert.v1.HttpSettings(username: str | None = <PLACEHOLDER>, password: str | None = <PLACEHOLDER>, proxy_url: str | None = <PLACEHOLDER>, custom_headers: ~cloudvision.api.arista.alert.v1.HttpHeaders = <PLACEHOLDER>)[source]

Bases: Message

HttpSettings are the settings to be used when sending various message over a http connection

custom_headers: HttpHeaders = <PLACEHOLDER>: custom_headers is custom http headers to be used along with the default headers

password: str | None = <PLACEHOLDER>: password is the password to use when connecting to the http proxy

proxy_url: str | None = <PLACEHOLDER>: proxy_url is the url for the http proxy

username: str | None = <PLACEHOLDER>: username is the username to use when connecting to the http proxy

class cloudvision.api.arista.alert.v1.InhibitionSettings(values: ~typing.Dict[str, ~cloudvision.api.arista.alert.v1.EventList] = <PLACEHOLDER>)[source]

Bases: Message

InhibitionSettings allows certain event types to be suppressed while other event types are active

values: Dict[str, EventList] = <PLACEHOLDER>: values is a map where the keys are event type which when active will suppress any events with event types in the related EventList

class cloudvision.api.arista.alert.v1.Matches(severities: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, devices: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, event_types: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, device_tags: str | None = <PLACEHOLDER>, intf_tags: str | None = <PLACEHOLDER>, rule_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

Matches is a set of restrictions that must be satisfied for a rule to be matched Empty fields are ignored for matching purposes. Condition contents are OR’d and then AND’d with the other criteria

device_tags: str | None = <PLACEHOLDER>: device_tags is a string tag query that is used to match on the event’s device tags

devices: ___fmp__.RepeatedString = <PLACEHOLDER>: devices is a list of device IDs to filter on, if an event does not belong to one of these devices, it will not match

event_types: ___fmp__.RepeatedString = <PLACEHOLDER>: event_types is a list of event types to filter on, if an event does not have one of these event types, it will not match

intf_tags: str | None = <PLACEHOLDER>: intf_tags is a string tag query that is used to match on the event’s interface tags

rule_ids: ___fmp__.RepeatedString = <PLACEHOLDER>: rule_ids is a list of rule IDs to filter on, if an event does not have one of these rule IDs, it will not match

severities: ___fmp__.RepeatedString = <PLACEHOLDER>: severities is a list of severities to filter on, if an event does not have one of these severities, it will not match Valid values are DEBUG, INFO, WARNING, ERROR and CRITICAL

class cloudvision.api.arista.alert.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)[source]

Bases: Message

count: int | None = <PLACEHOLDER>: Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>: Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

class cloudvision.api.arista.alert.v1.MsGraphSendMailEndpoint(send_resolved: bool | None = <PLACEHOLDER>, to: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.MsGraphSendMailSettings = <PLACEHOLDER>)[source]

Bases: Message

MsGraphSendMailEndpoint contains the required information for an alert to be sent to the microsft graph send mail api

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: MsGraphSendMailSettings = <PLACEHOLDER>: settings_override is the override for the microsoft graph send mail global endpoint settings

to: str | None = <PLACEHOLDER>: to address to send email to

class cloudvision.api.arista.alert.v1.MsGraphSendMailEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.MsGraphSendMailEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

MsGraphSendMailEndpoints is a set of microsoft graph send mail endpoints

values: List[MsGraphSendMailEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.MsGraphSendMailSettings(single_alert_per_email: bool | None = <PLACEHOLDER>, azure_o_auth: ~cloudvision.api.arista.alert.v1.AzureOAuth = <PLACEHOLDER>, user_principal_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

MsGraphSendMailSettings contain the settings for sending alerts to a Microsoft Graph sendMail

azure_o_auth: AzureOAuth = <PLACEHOLDER>: azure_o_auth used for auth when using an Azure smtp server uses auth_username

single_alert_per_email: bool | None = <PLACEHOLDER>: single_alert_per_email configures the Alerter such that each alert generates a separate email notification, the email will only have a single notification, the format will also be different

user_principal_name: str | None = <PLACEHOLDER>: user_principal_name is the user used to send from

class cloudvision.api.arista.alert.v1.MsTeamsEndpoint(send_resolved: bool | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.MsTeamsSettings = <PLACEHOLDER>)[source]

Bases: Message

MsTeamsEndpoint contains the required information for an alert to be sent to an ms teams endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: MsTeamsSettings = <PLACEHOLDER>: settings_override is the override for the microsoft teams global endpoint settings

class cloudvision.api.arista.alert.v1.MsTeamsEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.MsTeamsEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

MsTeamsEndpoints is a set of ms teams endpoints

values: List[MsTeamsEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.MsTeamsSettings(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

MsTeamsSettings contain the settings for sending alerts to MS Teams

url: str | None = <PLACEHOLDER>: url is the url of the webhook to send alerts to

class cloudvision.api.arista.alert.v1.OpsgenieEndpoint(send_resolved: bool | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.OpsgenieSettings = <PLACEHOLDER>)[source]

Bases: Message

OpsgenieEndpoint contains the required information for an alert to be sent to an opsgenie endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: OpsgenieSettings = <PLACEHOLDER>: settings_override is the override for the opsgenie global endpoint settings

class cloudvision.api.arista.alert.v1.OpsgenieEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.OpsgenieEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

OpsgenieEndpoints is a set of opsgenie endpoints

values: List[OpsgenieEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.OpsgenieSettings(key: str | None = <PLACEHOLDER>, url: str | None = <PLACEHOLDER>)[source]

Bases: Message

OpsgenieSettings contain the settings for sending alerts to opsgenie

key: str | None = <PLACEHOLDER>: key is the API key to use when talking to the OpsGenie API

url: str | None = <PLACEHOLDER>: url is the url to use when sending alerts to opsgenie

class cloudvision.api.arista.alert.v1.PagerdutyEndpoint(send_resolved: bool | None = <PLACEHOLDER>, routing_key: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.PagerdutySettings = <PLACEHOLDER>)[source]

Bases: Message

PagerdutyEndpoint contains the required information for an alert to be sent to a pagerduty endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

routing_key: str | None = <PLACEHOLDER>: routing_key is the routing key for sending pagerduty alerts

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: PagerdutySettings = <PLACEHOLDER>: settings_override is the override for the pagerduty global endpoint settings

class cloudvision.api.arista.alert.v1.PagerdutyEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.PagerdutyEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

PagerdutyEndpoints is a set of pagerduty endpoints

values: List[PagerdutyEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.PagerdutySettings(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

PagerdutySettings contain the settings for sending alerts to pagerduty

url: str | None = <PLACEHOLDER>: url is the url to use when sending alerts to pagerduty

class cloudvision.api.arista.alert.v1.Priorities(critical: int | None = <PLACEHOLDER>, error: int | None = <PLACEHOLDER>, warn: int | None = <PLACEHOLDER>, info: int | None = <PLACEHOLDER>)[source]

Bases: Message

Priorities is a mapping of CV event severities to syslog severities

critical: int | None = <PLACEHOLDER>: critical priority, default = 2 (Critical)

error: int | None = <PLACEHOLDER>: error priority, default = 3 (Error)

info: int | None = <PLACEHOLDER>: info priority, default = 6 (Informational)

warn: int | None = <PLACEHOLDER>: warn priority, default = 4 (Warning)

class cloudvision.api.arista.alert.v1.PushoverEndpoint(send_resolved: bool | None = <PLACEHOLDER>, token: str | None = <PLACEHOLDER>, user_key: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>)[source]

Bases: Message

PushoverEndpoint contains the required information for an alert to be sent to a pushover endpoint

http_override: HttpSettings = <PLACEHOLDER>

http_override is the override of the global http settings

Pushover does not have a settings override

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

token: str | None = <PLACEHOLDER>

//pushover.net/apps

Type:: token is the user’s registered application’s API token, see https

user_key: str | None = <PLACEHOLDER>: user_key is the user’s user key

class cloudvision.api.arista.alert.v1.PushoverEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.PushoverEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

PushoverEndpoints is a set of pushover endpoints

values: List[PushoverEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.Rule(sends_to: str | None = <PLACEHOLDER>, match_criteria: ~cloudvision.api.arista.alert.v1.Matches = <PLACEHOLDER>, continue_checks: bool | None = <PLACEHOLDER>, comment: str | None = <PLACEHOLDER>, suppress_for: ~datetime.timedelta = <PLACEHOLDER>)[source]

Bases: Message

Rule is a rule to send to a certain broadcast group

comment: str | None = <PLACEHOLDER>: comment is a comment to include that will be displayed in the alert

continue_checks: bool | None = <PLACEHOLDER>: continue_checks if true, causes alerts matching this rule’s criteria to continue checking against other rules, allowing for additional matches. If false, alerts matching this rule will not proceed with checking

match_criteria: Matches = <PLACEHOLDER>: match_criteria is the criteria that an alert must match to be sent to the broadcast group

sends_to: str | None = <PLACEHOLDER>: sends_to is the name of the broadcast group top send matching alerts to

suppress_for: timedelta = <PLACEHOLDER>: suppress_for is a time duration that a rule will be debounced for after being called

class cloudvision.api.arista.alert.v1.Rules(values: ~typing.List[~cloudvision.api.arista.alert.v1.Rule] = <PLACEHOLDER>)[source]

Bases: Message

Rules is a list of rules which dictates which events generate alerts for which broadcast groups

values: List[Rule] = <PLACEHOLDER>: values contains the rules

class cloudvision.api.arista.alert.v1.SenderStatus(key: ~cloudvision.api.arista.alert.v1.SenderStatusKey = <PLACEHOLDER>, success: bool | None = <PLACEHOLDER>, config_index: int | None = <PLACEHOLDER>, remaining_retries: int | None = <PLACEHOLDER>, error_type: ~cloudvision.api.arista.alert.v1.EndpointErrorType = <PLACEHOLDER>, error_message: str | None = <PLACEHOLDER>, events: ~cloudvision.api.arista.alert.v1.EventIdentifiers = <PLACEHOLDER>, previous_attempts: int | None = <PLACEHOLDER>)[source]

Bases: Message

SenderStatus provides information about the status of particular send.

config_index: int | None = <PLACEHOLDER>: config_index is the index of the config on the broadcast group or -1 if not applicable e.g.: if there are two email configs in one broadcast group, then the indices for each are 0 and 1. Config indices are counted per type.

error_message: str | None = <PLACEHOLDER>: error_message is a user-friendly error message.

error_type: EndpointErrorType = <PLACEHOLDER>: error_type is the type of error. This allows custom handling of different error types.

events: EventIdentifiers = <PLACEHOLDER>: events is a list of events triggering the alert.

key: SenderStatusKey = <PLACEHOLDER>: key uniquely identifies the instance of sender status.

previous_attempts: int | None = <PLACEHOLDER>: previous_attempts is the number of times the alert corresponding to this sender status has been retried.

remaining_retries: int | None = <PLACEHOLDER>: remaining_retries is the number of remaining attempts to send a particular alert.

success: bool | None = <PLACEHOLDER>: success indicates whether the send succeeded or not.

class cloudvision.api.arista.alert.v1.SenderStatusBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SenderStatus')] = <PLACEHOLDER>, filter: 'EventFilter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

filter: EventFilter = <PLACEHOLDER>: For each SenderStatus in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given SenderStatus is streamed to the user.

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[SenderStatus] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each SenderStatus at end. * Each SenderStatus response is fully-specified (all fields set).

start: Returns the state of each SenderStatus at start, followed by updates until now. * Each SenderStatus response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each SenderStatus at start, followed by updates until end. * Each SenderStatus response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.SenderStatusBatchedStreamResponse(responses: List[ForwardRef('SenderStatusStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SenderStatusStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.alert.v1.SenderStatusKey(broadcast_group_name: str | None = <PLACEHOLDER>, endpoint_type: ~cloudvision.api.arista.alert.v1.EndpointType = <PLACEHOLDER>)[source]

Bases: Message

SenderStatusKey defines the unique key for SenderStatus.

broadcast_group_name: str | None = <PLACEHOLDER>: broadcast_group_name is the name of the broadcast group which was being used, empty string if not group specific.

endpoint_type: EndpointType = <PLACEHOLDER>: endpoint_type indicates the target to which an attempt to send an alert was made or is “unknown” if not endpoint-specific (eg: slack, opsgenie).

class cloudvision.api.arista.alert.v1.SenderStatusRequest(key: 'SenderStatusKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SenderStatusKey = <PLACEHOLDER>: Key uniquely identifies a SenderStatus instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.SenderStatusResponse(value: 'SenderStatus' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the SenderStatus instance in this response.

value: SenderStatus = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.SenderStatusServiceBase[source]

Bases: ServiceBase

async get_all(sender_status_stream_request: SenderStatusStreamRequest) → AsyncIterator[SenderStatusStreamResponse][source]

async get_all_batched(sender_status_batched_stream_request: SenderStatusBatchedStreamRequest) → AsyncIterator[SenderStatusBatchedStreamResponse][source]

async get_meta(sender_status_stream_request: SenderStatusStreamRequest) → MetaResponse[source]

async get_one(sender_status_request: SenderStatusRequest) → SenderStatusResponse[source]

async get_some(sender_status_some_request: SenderStatusSomeRequest) → AsyncIterator[SenderStatusSomeResponse][source]

async subscribe(sender_status_stream_request: SenderStatusStreamRequest) → AsyncIterator[SenderStatusStreamResponse][source]

async subscribe_batched(sender_status_batched_stream_request: SenderStatusBatchedStreamRequest) → AsyncIterator[SenderStatusBatchedStreamResponse][source]

async subscribe_meta(sender_status_stream_request: SenderStatusStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(sender_status_stream_request: SenderStatusStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SenderStatusStreamResponse][source]

async get_all_batched(sender_status_batched_stream_request: SenderStatusBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SenderStatusBatchedStreamResponse][source]

async get_meta(sender_status_stream_request: SenderStatusStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(sender_status_request: SenderStatusRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SenderStatusResponse[source]

async get_some(sender_status_some_request: SenderStatusSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SenderStatusSomeResponse][source]

async subscribe(sender_status_stream_request: SenderStatusStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SenderStatusStreamResponse][source]

async subscribe_batched(sender_status_batched_stream_request: SenderStatusBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SenderStatusBatchedStreamResponse][source]

async subscribe_meta(sender_status_stream_request: SenderStatusStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.alert.v1.SenderStatusSomeRequest(keys: List[ForwardRef('SenderStatusKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SenderStatusKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.SenderStatusSomeResponse(value: 'SenderStatus' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the SenderStatus instance in this response.

value: SenderStatus = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.SenderStatusStreamRequest(partial_eq_filter: List[ForwardRef('SenderStatus')] = <PLACEHOLDER>, filter: 'EventFilter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

filter: EventFilter = <PLACEHOLDER>: For each SenderStatus in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given SenderStatus is streamed to the user.

partial_eq_filter: List[SenderStatus] = <PLACEHOLDER>

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each SenderStatus at end. * Each SenderStatus response is fully-specified (all fields set).

start: Returns the state of each SenderStatus at start, followed by updates until now. * Each SenderStatus response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each SenderStatus at start, followed by updates until end. * Each SenderStatus response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.SenderStatusStreamResponse(value: 'SenderStatus' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this SenderStatus’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the SenderStatus value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: SenderStatus = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.alert.v1.SendgridEndpoint(send_resolved: bool | None = <PLACEHOLDER>, to: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>)[source]

Bases: Message

SendgridEndpoint contains the required information for an alert to be sent to a sendgrid endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

to: str | None = <PLACEHOLDER>: to address to send email to

class cloudvision.api.arista.alert.v1.SendgridEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.SendgridEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

SendgridEndpoints is a set of sendgrid endpoints

values: List[SendgridEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.SendgridSettings(api_key: str | None = <PLACEHOLDER>, from_: str | None = <PLACEHOLDER>)[source]

Bases: Message

SendgridSettings contain the settings for sending emails via sendgrid

api_key: str | None = <PLACEHOLDER>: api_key is the api key to use

from_: str | None = <PLACEHOLDER>: from is the email address to send from

class cloudvision.api.arista.alert.v1.Settings(email: ~cloudvision.api.arista.alert.v1.EmailSettings = <PLACEHOLDER>, http: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, slack: ~cloudvision.api.arista.alert.v1.SlackSettings = <PLACEHOLDER>, victorops: ~cloudvision.api.arista.alert.v1.VictoropsSettings = <PLACEHOLDER>, pagerduty: ~cloudvision.api.arista.alert.v1.PagerdutySettings = <PLACEHOLDER>, opsgenie: ~cloudvision.api.arista.alert.v1.OpsgenieSettings = <PLACEHOLDER>, gchat: ~cloudvision.api.arista.alert.v1.GoogleChatSettings = <PLACEHOLDER>, msteams: ~cloudvision.api.arista.alert.v1.MsTeamsSettings = <PLACEHOLDER>, inhibition: ~cloudvision.api.arista.alert.v1.InhibitionSettings = <PLACEHOLDER>, base_url: str | None = <PLACEHOLDER>, timezone: str | None = <PLACEHOLDER>, syslog: ~cloudvision.api.arista.alert.v1.SyslogSettings = <PLACEHOLDER>, snmp: ~cloudvision.api.arista.alert.v1.SnmpSettings = <PLACEHOLDER>, sendgrid: ~cloudvision.api.arista.alert.v1.SendgridSettings = <PLACEHOLDER>, cue_syslog: ~cloudvision.api.arista.alert.v1.CueSyslogSettings = <PLACEHOLDER>, cue_snmp: ~cloudvision.api.arista.alert.v1.CueSnmpSettings = <PLACEHOLDER>, cue_sendgrid: ~cloudvision.api.arista.alert.v1.CueSendgridSettings = <PLACEHOLDER>, hide_tags: bool | None = <PLACEHOLDER>, zoom: ~cloudvision.api.arista.alert.v1.ZoomSettings = <PLACEHOLDER>, webhook: ~cloudvision.api.arista.alert.v1.WebhookSettings = <PLACEHOLDER>, ms_graph_send_mail: ~cloudvision.api.arista.alert.v1.MsGraphSendMailSettings = <PLACEHOLDER>, cv_action: ~cloudvision.api.arista.alert.v1.CvActionSettings = <PLACEHOLDER>)[source]

Bases: Message

Settings portion of config, a list of default global settings used by broadcast groups

base_url: str | None = <PLACEHOLDER>: base_url is the root address of your CloudVision app. Used to generate links in notifications.

cue_sendgrid: CueSendgridSettings = <PLACEHOLDER>: cue_sendgrid is the global default settings for cue sendgrid

cue_snmp: CueSnmpSettings = <PLACEHOLDER>: cue_snmp is the global default settings for cue snmp

cue_syslog: CueSyslogSettings = <PLACEHOLDER>: cue_syslog is the global default settings for cue syslog

cv_action: CvActionSettings = <PLACEHOLDER>: cv_action is the global default settings for CloudVision Action

email: EmailSettings = <PLACEHOLDER>: email is the global default settings for email

gchat: GoogleChatSettings = <PLACEHOLDER>: gchat is the global default settings for google chat

hide_tags: bool | None = <PLACEHOLDER>: hide_tags is used to by the alerting system to omit tags and other “superfluous” values from the notifications that are sent out by the system

http: HttpSettings = <PLACEHOLDER>: http is the global default settings for http

inhibition: InhibitionSettings = <PLACEHOLDER>: inhibition defines the inhibition rules for alerts, allowing events of certain types to be suppressed while another event type is active

ms_graph_send_mail: MsGraphSendMailSettings = <PLACEHOLDER>: ms_graph_send_mail is the settings for Microsoft Graph sendMail

msteams: MsTeamsSettings = <PLACEHOLDER>: msteams is the global default settings for ms teams

opsgenie: OpsgenieSettings = <PLACEHOLDER>: opsgenie is the global default settings for opsgenie

pagerduty: PagerdutySettings = <PLACEHOLDER>: pagerduty is the global default settings for pagerduty

sendgrid: SendgridSettings = <PLACEHOLDER>: sendgrid is the global default settings for sendgrid

slack: SlackSettings = <PLACEHOLDER>: slack is the global default settings for slack

snmp: SnmpSettings = <PLACEHOLDER>: snmp is the global default settings for snmp

syslog: SyslogSettings = <PLACEHOLDER>: syslog is the global default settings for syslog

timezone: str | None = <PLACEHOLDER>: timezone is used for formatting event times in notifications. E.g. ‘UTC’, ‘US/Pacific’

victorops: VictoropsSettings = <PLACEHOLDER>: victorops is the global default settings for victorops

webhook: WebhookSettings = <PLACEHOLDER>: webhook is the auth settings for webhook

zoom: ZoomSettings = <PLACEHOLDER>: zoom is the global default settings for zoom

class cloudvision.api.arista.alert.v1.SlackEndpoint(send_resolved: bool | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.SlackSettings = <PLACEHOLDER>)[source]

Bases: Message

SlackEndpoint contains the required information for an alert to be sent to a slack endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: SlackSettings = <PLACEHOLDER>: settings_override is the override for the slack global endpoint settings

class cloudvision.api.arista.alert.v1.SlackEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.SlackEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

SlackEndpoints is a set of slack endpoints

values: List[SlackEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.SlackSettings(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

SlackSettings contain the settings for sending alerts to slack

url: str | None = <PLACEHOLDER>: url is the url of the slack webhook to use

class cloudvision.api.arista.alert.v1.SnmpAuth(community: str | None = <PLACEHOLDER>, username: str | None = <PLACEHOLDER>, security_level: ~cloudvision.api.arista.alert.v1.SnmpSecurityLevel = <PLACEHOLDER>, authentication_protocol: ~cloudvision.api.arista.alert.v1.SnmpAuthProtocol = <PLACEHOLDER>, authentication_passphrase: str | None = <PLACEHOLDER>, privacy_protocol: ~cloudvision.api.arista.alert.v1.SnmpPrivProtocol = <PLACEHOLDER>, privacy_passphrase: str | None = <PLACEHOLDER>)[source]

Bases: Message

SNMPAuth contain authentication information for SNMP

authentication_passphrase: str | None = <PLACEHOLDER>: authentication_passphrase is the passphrase to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels

authentication_protocol: SnmpAuthProtocol = <PLACEHOLDER>: authentication_protocol is the protocol to use for authentication in SNMPv3 required for AUTH_NO_PRIV/AUTH_PRIV security levels

community: str | None = <PLACEHOLDER>: community is the community string used for authentication in SNMPv1 and v2c required if version < 3

privacy_passphrase: str | None = <PLACEHOLDER>: privacy_passphrase is the passphrase to use for privacy in SNMPv3 required for AUTH_PRIV security level

privacy_protocol: SnmpPrivProtocol = <PLACEHOLDER>: privacy_protocol is the protocol to use for privacy in SNMPv3 required for AUTH_PRIV security level

security_level: SnmpSecurityLevel = <PLACEHOLDER>: security_level the security level for SNMPv3

username: str | None = <PLACEHOLDER>: username the username for SNMPv3 auth

class cloudvision.api.arista.alert.v1.SnmpAuthProtocol(value: int)[source]

Bases: Enum

SNMPAuthProtocol represents the authentication protocol to be used

MD5 = SnmpAuthProtocol.MD5: SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

SHA = SnmpAuthProtocol.SHA: SNMP_AUTH_PROTOCOL_SHA use the sha protocol

SHA_224 = SnmpAuthProtocol.SHA_224: SNMP_AUTH_PROTOCOL_SHA_224 use the sha224 protocol

SHA_256 = SnmpAuthProtocol.SHA_256: SNMP_AUTH_PROTOCOL_SHA_256 use the sha256 protocol

SHA_384 = SnmpAuthProtocol.SHA_384: SNMP_AUTH_PROTOCOL_SHA_384 use the sha384 protocol

SHA_512 = SnmpAuthProtocol.SHA_512: SNMP_AUTH_PROTOCOL_SHA_512 use the sha512 protocol

UNSPECIFIED = SnmpAuthProtocol.UNSPECIFIED: SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.SnmpEndpoint(send_resolved: bool | None = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.SnmpSettings = <PLACEHOLDER>)[source]

Bases: Message

SNMPEndpoint contains the required information for an alert to be sent to an SNMP endpoint

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: SnmpSettings = <PLACEHOLDER>: settings_override is the override for the microsoft teams global endpoint settings

class cloudvision.api.arista.alert.v1.SnmpEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.SnmpEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

SNMPEndpoints is a set of SNMP endpoints

values: List[SnmpEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.SnmpPrivProtocol(value: int)[source]

Bases: Enum

SNMPPrivProtocol represents the privacy protocol to be used

AES = SnmpPrivProtocol.AES: SNMP_PRIV_PROTOCOL_AES use the aes protocol

AES_192 = SnmpPrivProtocol.AES_192: SNMP_PRIV_PROTOCOL_AES_192 use the aes192 protocol

AES_192C = SnmpPrivProtocol.AES_192C: SNMP_PRIV_PROTOCOL_AES_192C use the aes192c protocol

AES_256 = SnmpPrivProtocol.AES_256: SNMP_PRIV_PROTOCOL_AES_256 use the aes256 protocol

AES_256C = SnmpPrivProtocol.AES_256C: SNMP_PRIV_PROTOCOL_AES_256C use the aes256c protocol

DES = SnmpPrivProtocol.DES: SNMP_PRIV_PROTOCOL_DES use the des protocol

UNSPECIFIED = SnmpPrivProtocol.UNSPECIFIED: SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.SnmpSecurityLevel(value: int)[source]

Bases: Enum

SNMPSecurityLevel indicates what level of security should be used

AUTH_NO_PRIV = SnmpSecurityLevel.AUTH_NO_PRIV: SNMP_SECURITY_LEVEL_AUTH_NO_PRIV use authentication without privacy

AUTH_PRIV = SnmpSecurityLevel.AUTH_PRIV: SNMP_SECURITY_LEVEL_AUTH_PRIV use both authentication and privacy

NO_AUTH_NO_PRIV = SnmpSecurityLevel.NO_AUTH_NO_PRIV: SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV use no security

UNSPECIFIED = SnmpSecurityLevel.UNSPECIFIED: SNMP_SECURITY_LEVEL_UNSPECIFIED is the unspecified enum value

name: str | None

value: int

class cloudvision.api.arista.alert.v1.SnmpSettings(target: str | None = <PLACEHOLDER>, port: int | None = <PLACEHOLDER>, transport: str | None = <PLACEHOLDER>, version: int | None = <PLACEHOLDER>, auth: ~cloudvision.api.arista.alert.v1.SnmpAuth = <PLACEHOLDER>, engine_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

SNMPSettings contain the settings for sending alerts with SNMP

auth: SnmpAuth = <PLACEHOLDER>: auth is optional authentication settings

engine_id: str | None = <PLACEHOLDER>: engine_id is the engine ID that will be used by the Alerter This should be a hexadecimal string, colon separators between bytes will be accepted when writing, but will be absent when reading optional: if excluded or left blank, this will be automatically generated

port: int | None = <PLACEHOLDER>: port is the network port to target

target: str | None = <PLACEHOLDER>: target is an ipv4 address to send messages to

transport: str | None = <PLACEHOLDER>: transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

version: int | None = <PLACEHOLDER>: version is the SNMP version, v1, v2c and v3 are supported and can be set with 1, 2 and 3 respectively

class cloudvision.api.arista.alert.v1.SyslogEndpoint(send_resolved: bool | None = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.SyslogSettings = <PLACEHOLDER>)[source]

Bases: Message

SyslogEndpoint contains the required information for an alert to be sent to a syslog endpoint

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: SyslogSettings = <PLACEHOLDER>: settings_override is the override for the microsoft teams global endpoint settings

class cloudvision.api.arista.alert.v1.SyslogEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.SyslogEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

SyslogEndpoints is a set of syslog endpoints

values: List[SyslogEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.SyslogSettings(network: str | None = <PLACEHOLDER>, address: str | None = <PLACEHOLDER>, facility: int | None = <PLACEHOLDER>, priorities: ~cloudvision.api.arista.alert.v1.Priorities = <PLACEHOLDER>, tag: str | None = <PLACEHOLDER>, per_device: bool | None = <PLACEHOLDER>, use_tls: bool | None = <PLACEHOLDER>)[source]

Bases: Message

SyslogSettings contain the settings for sending alerts with syslog

address: str | None = <PLACEHOLDER>: address is the network address to send syslog messages to

facility: int | None = <PLACEHOLDER>: facility is the syslog facility 0-23 inc. This is the syslog facility as defined in RFC-3164

network: str | None = <PLACEHOLDER>: network is the network protocol to use, default is “udp”, options also include: tcp,tcp4,tcp6,udp4,udp6

per_device: bool | None = <PLACEHOLDER>: per_device allows message to optionally be sent per device, if an event concerns two devices the behaviour is changed based on this option:

true: two messages are sent, one for each device false: a single message is sent

priorities: Priorities = <PLACEHOLDER>: priorities describes how CVP severity maps to syslog priority priority is a number between 0-7 inc. as defined in RFC-3164

tag: str | None = <PLACEHOLDER>: tag is the syslog TAG as described in RFC-3164, it is the prefix to all syslog messages

use_tls: bool | None = <PLACEHOLDER>: use_tls determines if the connection to the server should be secured with TLS

class cloudvision.api.arista.alert.v1.TemplateConfig(key: ~cloudvision.api.arista.alert.v1.TemplateKey = <PLACEHOLDER>, template: str | None = <PLACEHOLDER>)[source]

Bases: Message

TemplateConfig represents a template configuration

key: TemplateKey = <PLACEHOLDER>: key identifies which template the configuration is for

template: str | None = <PLACEHOLDER>: template is the string template value to be used Templates need to be compatible with their respective parsers Message templates are read and parsed by https://golang.org/pkg/text/template/ Html templates are read and parsed by https://golang.org/pkg/html/template/ Templates must output valid JSON for certain templates Templates must not fail for any valid input

class cloudvision.api.arista.alert.v1.TemplateConfigBatchedStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each TemplateConfig at end. * Each TemplateConfig response is fully-specified (all fields set).

start: Returns the state of each TemplateConfig at start, followed by updates until now. * Each TemplateConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each TemplateConfig at start, followed by updates until end. * Each TemplateConfig response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.TemplateConfigBatchedStreamResponse(responses: List[ForwardRef('TemplateConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[TemplateConfigStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteAllRequest[source]: Bases: Message

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'TemplateKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: TemplateKey = <PLACEHOLDER>: This is the key of the TemplateConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteRequest(key: 'TemplateKey' = <PLACEHOLDER>)[source]

Bases: Message

key: TemplateKey = <PLACEHOLDER>: Key indicates which TemplateConfig instance to remove. This field must always be set.

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteResponse(key: 'TemplateKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: TemplateKey = <PLACEHOLDER>: Key echoes back the key of the deleted TemplateConfig instance.

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==DeletedAt will not include this instance.

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteSomeRequest(keys: List[ForwardRef('TemplateKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[TemplateKey] = <PLACEHOLDER>: key contains a list of TemplateConfig keys to delete

class cloudvision.api.arista.alert.v1.TemplateConfigDeleteSomeResponse(key: ~cloudvision.api.arista.alert.v1.TemplateKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

TemplateConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: TemplateKey = <PLACEHOLDER>

class cloudvision.api.arista.alert.v1.TemplateConfigRequest(key: 'TemplateKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: TemplateKey = <PLACEHOLDER>: Key uniquely identifies a TemplateConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.TemplateConfigResponse(value: 'TemplateConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the TemplateConfig instance in this response.

value: TemplateConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.TemplateConfigServiceBase[source]

Bases: ServiceBase

async delete(template_config_delete_request: TemplateConfigDeleteRequest) → TemplateConfigDeleteResponse[source]

async delete_all(template_config_delete_all_request: TemplateConfigDeleteAllRequest) → AsyncIterator[TemplateConfigDeleteAllResponse][source]

async delete_some(template_config_delete_some_request: TemplateConfigDeleteSomeRequest) → AsyncIterator[TemplateConfigDeleteSomeResponse][source]

async get_all(template_config_stream_request: TemplateConfigStreamRequest) → AsyncIterator[TemplateConfigStreamResponse][source]

async get_all_batched(template_config_batched_stream_request: TemplateConfigBatchedStreamRequest) → AsyncIterator[TemplateConfigBatchedStreamResponse][source]

async get_meta(template_config_stream_request: TemplateConfigStreamRequest) → MetaResponse[source]

async get_one(template_config_request: TemplateConfigRequest) → TemplateConfigResponse[source]

async get_some(template_config_some_request: TemplateConfigSomeRequest) → AsyncIterator[TemplateConfigSomeResponse][source]

async set(template_config_set_request: TemplateConfigSetRequest) → TemplateConfigSetResponse[source]

async set_some(template_config_set_some_request: TemplateConfigSetSomeRequest) → AsyncIterator[TemplateConfigSetSomeResponse][source]

async subscribe(template_config_stream_request: TemplateConfigStreamRequest) → AsyncIterator[TemplateConfigStreamResponse][source]

async subscribe_batched(template_config_batched_stream_request: TemplateConfigBatchedStreamRequest) → AsyncIterator[TemplateConfigBatchedStreamResponse][source]

async subscribe_meta(template_config_stream_request: TemplateConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(template_config_delete_request: TemplateConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → TemplateConfigDeleteResponse[source]

async delete_all(template_config_delete_all_request: TemplateConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigDeleteAllResponse][source]

async delete_some(template_config_delete_some_request: TemplateConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigDeleteSomeResponse][source]

async get_all(template_config_stream_request: TemplateConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigStreamResponse][source]

async get_all_batched(template_config_batched_stream_request: TemplateConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigBatchedStreamResponse][source]

async get_meta(template_config_stream_request: TemplateConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(template_config_request: TemplateConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → TemplateConfigResponse[source]

async get_some(template_config_some_request: TemplateConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigSomeResponse][source]

async set(template_config_set_request: TemplateConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → TemplateConfigSetResponse[source]

async set_some(template_config_set_some_request: TemplateConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigSetSomeResponse][source]

async subscribe(template_config_stream_request: TemplateConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigStreamResponse][source]

async subscribe_batched(template_config_batched_stream_request: TemplateConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[TemplateConfigBatchedStreamResponse][source]

async subscribe_meta(template_config_stream_request: TemplateConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.alert.v1.TemplateConfigSetRequest(value: 'TemplateConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: TemplateConfig = <PLACEHOLDER>: TemplateConfig carries the value to set into the datastore. See the documentation on the TemplateConfig struct for which fields are required.

class cloudvision.api.arista.alert.v1.TemplateConfigSetResponse(value: 'TemplateConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

a time-ranged query with StartTime==CreatedAt will include this instance.

value: TemplateConfig = <PLACEHOLDER>: Value carries all the values given in the TemplateConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.alert.v1.TemplateConfigSetSomeRequest(values: List[ForwardRef('TemplateConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[TemplateConfig] = <PLACEHOLDER>

value contains a list of TemplateConfig values to write. It is possible to provide more values than can fit within either:

the maxiumum send size of the client

the maximum receive size of the server

If this error occurs you must reduce the number of values sent. See gRPC “maximum message size” documentation for more information.

class cloudvision.api.arista.alert.v1.TemplateConfigSetSomeResponse(key: 'TemplateKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: TemplateKey = <PLACEHOLDER>

class cloudvision.api.arista.alert.v1.TemplateConfigSomeRequest(keys: List[ForwardRef('TemplateKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[TemplateKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

class cloudvision.api.arista.alert.v1.TemplateConfigSomeResponse(value: 'TemplateConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the TemplateConfig instance in this response.

value: TemplateConfig = <PLACEHOLDER>: Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.

class cloudvision.api.arista.alert.v1.TemplateConfigStreamRequest(time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

time: __time__.TimeBounds = <PLACEHOLDER>

TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

end: Returns the state of each TemplateConfig at end. * Each TemplateConfig response is fully-specified (all fields set).

start: Returns the state of each TemplateConfig at start, followed by updates until now. * Each TemplateConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each TemplateConfig at start, followed by updates until end. * Each TemplateConfig response at start is fully-specified, but updates until end may

be partial.

class cloudvision.api.arista.alert.v1.TemplateConfigStreamResponse(value: 'TemplateConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this TemplateConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the TemplateConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

value: TemplateConfig = <PLACEHOLDER>: Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.

class cloudvision.api.arista.alert.v1.TemplateKey(template_type: ~cloudvision.api.arista.alert.v1.TemplateType = <PLACEHOLDER>)[source]

Bases: Message

TemplateKey is used to identify templates for event notifications

template_type: TemplateType = <PLACEHOLDER>: template_type is the enum value to match with the template

class cloudvision.api.arista.alert.v1.TemplateOutput(value: int)[source]

Bases: Enum

TemplateOutput is an enum of all of the possible output formats for templates

HTML = TemplateOutput.HTML: TEMPLATE_OUTPUT_HTML indicates the the template outputs HTML. This also indicates that “html/templates” will be used instead of “text/templates” so that html characters are automatically escaped from input.

JSON = TemplateOutput.JSON: TEMPLATE_OUTPUT_JSON indicates the the template outputs JSON.

TEXT = TemplateOutput.TEXT: TEMPLATE_OUTPUT_TEXT indicates the the template outputs plain text.

UNSPECIFIED = TemplateOutput.UNSPECIFIED: TEMPLATE_OUTPUT_UNSPECIFIED is the unspecfied value.

name: str | None

value: int

class cloudvision.api.arista.alert.v1.TemplateType(value: int)[source]

Bases: Enum

TemplateType describes the types of Templates that are usable

EMAIL_HTML = TemplateType.EMAIL_HTML: TEMPLATE_TYPE_EMAIL_HTML is the key of the html template for sent emails

EMAIL_SINGLE_HTML = TemplateType.EMAIL_SINGLE_HTML: TEMPLATE_TYPE_EMAIL_SINGLE_HTML is the key of the html template for sent emails when the single alert per email option is selected

EMAIL_SINGLE_SUBJECT = TemplateType.EMAIL_SINGLE_SUBJECT: TEMPLATE_TYPE_EMAIL_SINGLE_SUBJECT is the key of the subject line template of a sent email when the single alert per email option is selected

EMAIL_SINGLE_TEXT = TemplateType.EMAIL_SINGLE_TEXT: TEMPLATE_TYPE_EMAIL_SINGLE_TEXT is the key of the text template for sent emails when the single alert per email option is selected

EMAIL_SUBJECT = TemplateType.EMAIL_SUBJECT: TEMPLATE_TYPE_EMAIL_SUBJECT is the key of the subject line template of a sent email

EMAIL_TEXT = TemplateType.EMAIL_TEXT: TEMPLATE_TYPE_EMAIL_TEXT is the key of the text template for sent emails

GOOGLE_CHAT_MESSAGE = TemplateType.GOOGLE_CHAT_MESSAGE: TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE is the key of the message template for sent Google chat messages

MICROSOFT_TEAMS_MESSAGE = TemplateType.MICROSOFT_TEAMS_MESSAGE: TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE is the key of the message template for sent Microsoft teams messages

OPSGENIE_MESSAGE = TemplateType.OPSGENIE_MESSAGE: TEMPLATE_TYPE_OPSGENIE_MESSAGE is the key of the message template for a opsgenie alert

PAGERDUTY_SUMMARY = TemplateType.PAGERDUTY_SUMMARY: TEMPLATE_TYPE_PAGERDUTY_SUMMARY is the key of the summary template for sent pagerduty messages

PUSHOVER_MESSAGE = TemplateType.PUSHOVER_MESSAGE: TEMPLATE_TYPE_PUSHOVER_MESSAGE is the key of the message template for sent pushover messages

SLACK_MESSAGE = TemplateType.SLACK_MESSAGE: TEMPLATE_TYPE_SLACK_MESSAGE is the key of the message template for sent slack messages

SYSLOG_MESSAGE = TemplateType.SYSLOG_MESSAGE: TEMPLATE_TYPE_SYSLOG_MESSAGE is the key of the message template for a syslog message part

UNSPECIFIED = TemplateType.UNSPECIFIED: TEMPLATE_TYPE_UNSPECIFIED is the unspecified enum value

VICTOROPS_DISPLAY_NAME = TemplateType.VICTOROPS_DISPLAY_NAME: TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME is the key of the display name template for sent victorops messages

VICTOROPS_STATE_MESSAGE = TemplateType.VICTOROPS_STATE_MESSAGE: TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE is the key of the state message template for sent victorops messages

WEBHOOK_MULTIPLE = TemplateType.WEBHOOK_MULTIPLE: TEMPLATE_TYPE_WEBHOOK_MULTIPLE is the key of the template for webhook message body when the single_alert option is false

WEBHOOK_SINGLE = TemplateType.WEBHOOK_SINGLE: TEMPLATE_TYPE_WEBHOOK_SINGLE is the key of the template for webhook message body when the single_alert option is true

ZOOM_MESSAGE = TemplateType.ZOOM_MESSAGE: TEMPLATE_TYPE_ZOOM_MESSAGE is the key of the message template for sent Zoom messages

name: str | None

value: int

class cloudvision.api.arista.alert.v1.VictorOpsEndpoint(send_resolved: bool | None = <PLACEHOLDER>, routing_key: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.VictoropsSettings = <PLACEHOLDER>)[source]

Bases: Message

VictorOpsEndpoint contains the required information for an alert to be sent to a victorOps endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

routing_key: str | None = <PLACEHOLDER>: routing_key is the PagerDuty integration key

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: VictoropsSettings = <PLACEHOLDER>: settings_override is the override for the victorops global endpoint settings

class cloudvision.api.arista.alert.v1.VictorOpsEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.VictorOpsEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

VictorOpsEndpoints is a set of victorOps endpoints

values: List[VictorOpsEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.VictoropsSettings(key: str | None = <PLACEHOLDER>, url: str | None = <PLACEHOLDER>)[source]

Bases: Message

VictoropsSettings contain the settings for sending alerts to victorops

key: str | None = <PLACEHOLDER>: key is the API key to use when talking to the VictorOps API

url: str | None = <PLACEHOLDER>: url is the victorops url to use (without integration or routing key default: https://alert.victorops.com/integrations/generic/20131114/alert/

class cloudvision.api.arista.alert.v1.WebhookEndpoint(send_resolved: bool | None = <PLACEHOLDER>, url: str | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, simple_output: bool | None = <PLACEHOLDER>, single_alert: bool | None = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.WebhookSettings = <PLACEHOLDER>)[source]

Bases: Message

WebhookEndpoint contains the required information for an alert to be sent to a webhook endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: WebhookSettings = <PLACEHOLDER>: settings_override is the override for the webhook global endpoint settings

simple_output: bool | None = <PLACEHOLDER>: simple_output is a boolean flag to control the JSON structure of the webhook body. When false the output mimics the old alertmanager format. When true the output is a simple array of json objects which each represent an event.

single_alert: bool | None = <PLACEHOLDER>: single_alert is a boolean flag that will cause an individual webhook message to be sent per alert when true.

url: str | None = <PLACEHOLDER>: url is the url

class cloudvision.api.arista.alert.v1.WebhookEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.WebhookEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

WebhookEndpoints is a set of webhook endpoints

values: List[WebhookEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.WebhookSettings(azure_o_auth: ~cloudvision.api.arista.alert.v1.AzureOAuth = <PLACEHOLDER>)[source]

Bases: Message

WebhookSettings contain the settings for sending alerts to a Webhook

azure_o_auth: AzureOAuth = <PLACEHOLDER>: azure_o_auth used for auth when using an Azure smtp server uses auth_username

class cloudvision.api.arista.alert.v1.ZoomEndpoint(send_resolved: bool | None = <PLACEHOLDER>, http_override: ~cloudvision.api.arista.alert.v1.HttpSettings = <PLACEHOLDER>, settings_override: ~cloudvision.api.arista.alert.v1.ZoomSettings = <PLACEHOLDER>)[source]

Bases: Message

ZoomEndpoint contains the required information for an alert to be sent to a zoom endpoint

http_override: HttpSettings = <PLACEHOLDER>: http_override is the override of the global http settings

send_resolved: bool | None = <PLACEHOLDER>: send_resolved send alerts when events are resolved along with when they are triggered

settings_override: ZoomSettings = <PLACEHOLDER>: settings_override is the override for the zoom global endpoint settings

class cloudvision.api.arista.alert.v1.ZoomEndpoints(values: ~typing.List[~cloudvision.api.arista.alert.v1.ZoomEndpoint] = <PLACEHOLDER>)[source]

Bases: Message

ZoomEndpoints is a set of zoom endpoints

values: List[ZoomEndpoint] = <PLACEHOLDER>: values are the elements of the set

class cloudvision.api.arista.alert.v1.ZoomSettings(url: str | None = <PLACEHOLDER>, verification_token: str | None = <PLACEHOLDER>)[source]

Bases: Message

ZoomSettings contain the settings for sending alerts to zoom

url: str | None = <PLACEHOLDER>: url is the zoom incoming webhook URL to send messages to

verification_token: str | None = <PLACEHOLDER>: verification_token is the verification token to authenticate with