endpointlocation.v1

Top

arista/endpointlocation.v1/endpointlocation.proto

Device

Field NameTypeDescription
identifier_listIdentifierList

device_typeDeviceType

location_listLocationList

The list of possible locations, in order from most likely to least likely

device_statusDeviceStatus

device_infoDeviceInfo

DeviceInfo

Field NameTypeDescription
device_namegoogle.protobuf.StringValue

mobilegoogle.protobuf.BoolValue

tabletgoogle.protobuf.BoolValue

scoregoogle.protobuf.UInt32Value

versiongoogle.protobuf.StringValue

mac_vendorgoogle.protobuf.StringValue

classificationgoogle.protobuf.StringValue

hierarchyfmp.RepeatedString

DeviceMap

Field NameTypeDescription
valuesDeviceMap.ValuesEntry[…]

DeviceMap.ValuesEntry

Field NameTypeDescription
keystring

valueDevice

EndpointLocation

Field NameTypeDescription
keyEndpointLocationKey

device_mapDeviceMap

EndpointLocationKey

Field NameTypeDescription
search_termgoogle.protobuf.StringValue

ExplanationList

Field NameTypeDescription
valuesExplanation[…]

Identifier

Field NameTypeDescription
typeIdentifierType

valuegoogle.protobuf.StringValue

source_listIdentifierSourceList

IdentifierList

Field NameTypeDescription
valuesIdentifier[…]

IdentifierSourceList

Field NameTypeDescription
valuesIdentifierSource[…]

Location

Field NameTypeDescription
device_idgoogle.protobuf.StringValue

device_statusDeviceStatus

interfacegoogle.protobuf.StringValue

vlan_idgoogle.protobuf.UInt32Value

learned_timegoogle.protobuf.Timestamp

mac_typeMacType

likelihoodLikelihood

explanation_listExplanationList

identifier_listIdentifierList

LocationList

Field NameTypeDescription
valuesLocation[…]

DeviceStatus

NameNumberDescription
DEVICE_STATUS_UNSPECIFIED0

DEVICE_STATUS_ACTIVE1

DEVICE_STATUS_INACTIVE2

DeviceType

NameNumberDescription
DEVICE_TYPE_UNSPECIFIED0

DEVICE_TYPE_INVENTORY1

DEVICE_TYPE_ENDPOINT2

DEVICE_TYPE_WIFI_ENDPOINT3

Explanation

NameNumberDescription
EXPLANATION_UNSPECIFIED0

Explanation for ports that have unspecified likelihood

EXPLANATION_DIRECT_CONNECTION1

Explanation for ports directly connected to the queried endpoint device in LLDP

EXPLANATION_NON_INVENTORY_CONNECTION2

Explanation for ports directly connected to at least one non-inventory device in LLDP

EXPLANATION_NO_CONNECTION3

Explanation for ports not directly connected to any device in LLDP

EXPLANATION_INVENTORY_CONNECTION4

Explanation for ports only connected to inventory devices in LLDP

EXPLANATION_OWN_PORT_INVENTORY_DEVICE5

Explanation for ports that are on the inventory device itself

EXPLANATION_DIRECT_CONNECTION_INVENTORY_DEVICE6

Explanation for ports directly connected to the queried device in LLDP (for inventory devices)

EXPLANATION_NO_CONNECTION_INVENTORY_DEVICE7

Explanation for ports not directly connected to any device in LLDP (for inventory devices)

EXPLANATION_OTHER_CONNECTION_INVENTORY_DEVICE8

Explanation for ports connected to only other devices besides queried inventory device

EXPLANATION_VIRTUAL9

Explanation for ports containing a virtual interface

EXPLANATION_WIRELESS_CONNECTION10

Explanation for wireless clients that are directly connected to a wireless access point

IdentifierSource

NameNumberDescription
IDENTIFIER_SOURCE_UNSPECIFIED0

IDENTIFIER_SOURCE_FDB1

IDENTIFIER_SOURCE_ARP2

IDENTIFIER_SOURCE_NEIGHBOR3

IDENTIFIER_SOURCE_DEVICE_INVENTORY4

Onboarded or inventory devices

IDENTIFIER_SOURCE_LLDP5

IDENTIFIER_SOURCE_DHCP6

IDENTIFIER_SOURCE_WIFI7

IdentifierType

NameNumberDescription
IDENTIFIER_TYPE_UNSPECIFIED0

IDENTIFIER_TYPE_MAC_ADDR1

IDENTIFIER_TYPE_IPV4_ADDR2

IDENTIFIER_TYPE_IPV6_ADDR3

IDENTIFIER_TYPE_INVENTORY_DEVICE_ID4

IDENTIFIER_TYPE_PRIMARY_MANAGEMENT_IP5

IDENTIFIER_TYPE_HOSTNAME6

IDENTIFIER_TYPE_USERNAME7

IDENTIFIER_TYPE_OTHER99999

May be used for some unknown LLDP chassis id type

Likelihood

NameNumberDescription
LIKELIHOOD_UNSPECIFIED0

These ports have unspecified likelihood

LIKELIHOOD_VERY_LIKELY1

These ports are very likely to be physically connected to the queried device

LIKELIHOOD_LIKELY2

These ports are likely to be physically connected to the queried device

LIKELIHOOD_SOMEWHAT_LIKELY3

These ports are somewhat likely to be physically connected to the queried device

LIKELIHOOD_LESS_LIKELY4

These ports are less likely to be physically connected to the queried device

MacType

NameNumberDescription
MAC_TYPE_UNSPECIFIED0

MAC_TYPE_LEARNED_DYNAMIC1

MAC_TYPE_LEARNED_SECURE2

MAC_TYPE_CONFIGURED_DYNAMIC3

MAC_TYPE_CONFIGURED_SECURE4

MAC_TYPE_CONFIGURED_STATIC5

MAC_TYPE_PEER_DYNAMIC6

MAC_TYPE_PEER_STATIC7

MAC_TYPE_PEER_SECURE8

MAC_TYPE_LEARNED_REMOTE9

MAC_TYPE_CONFIGURED_REMOTE10

MAC_TYPE_RECEIVED_REMOTE11

MAC_TYPE_PEER_LEARNED_REMOTE12

MAC_TYPE_PEER_CONFIGURED_REMOTE13

MAC_TYPE_PEER_RECEIVED_REMOTE14

MAC_TYPE_EVPN_DYNAMIC_REMOTE15

MAC_TYPE_EVPN_CONFIGURED_REMOTE16

MAC_TYPE_PEER_EVPN_REMOTE17

MAC_TYPE_CONFIGURED_ROUTER18

MAC_TYPE_PEER_ROUTER19

MAC_TYPE_EVPN_INTF_DYNAMIC20

MAC_TYPE_EVPN_INTF_STATIC21

MAC_TYPE_AUTHENTICATED22

MAC_TYPE_PEER_AUTHENTICATED23

MAC_TYPE_PENDING_SECURE24

MAC_TYPE_OTHER99999

This is used for capturing future MAC types

Top

arista/endpointlocation.v1/services.gen.proto

EndpointLocationRequest

Field NameTypeDescription
keyEndpointLocationKey

Key uniquely identifies a EndpointLocation instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

EndpointLocationResponse

Field NameTypeDescription
valueEndpointLocation

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

EndpointLocation instance in this response.

EndpointLocationStreamRequest

Field NameTypeDescription
partial_eq_filterEndpointLocation[…]

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.

timearista.time.TimeBounds

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.

This field is not allowed in the Subscribe RPC.

EndpointLocationStreamResponse

Field NameTypeDescription
valueEndpointLocation

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this EndpointLocation’s last modification.

typearista.subscriptions.Operation

Operation indicates how the EndpointLocation 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.

EndpointLocationService

Method NameRequest TypeResponse TypeDescription
GetOneEndpointLocationRequestEndpointLocationResponse

GetAllEndpointLocationStreamRequestEndpointLocationStreamResponse stream

SubscribeEndpointLocationStreamRequestEndpointLocationStreamResponse stream