From 99d17bdc3611f12ad0e10f0770a1a1ab2760b405 Mon Sep 17 00:00:00 2001 From: Arista-Jenkins Date: Fri, 3 May 2024 18:54:03 +0000 Subject: [PATCH] Automated deployment: Fri May 3 18:54:03 UTC 2024 0d941b261089d53b4b3d95e3c84bf2bc1b72f37a --- 404.html | 2 +- categories/index.html | 6 +++--- clients/creating/index.html | 6 +++--- clients/existing/index.html | 6 +++--- clients/index.html | 6 +++--- connecting/index.html | 6 +++--- examples/grpc/index.html | 6 +++--- examples/index.html | 6 +++--- examples/rest/bugexposure/index.html | 6 +++--- examples/rest/changecontrol/index.html | 6 +++--- examples/rest/dashboard/index.html | 6 +++--- examples/rest/endpointlocation/index.html | 6 +++--- examples/rest/events/index.html | 6 +++--- examples/rest/index.html | 6 +++--- examples/rest/inventory/index.html | 6 +++--- examples/rest/lifecycle/index.html | 6 +++--- examples/rest/studios-and-workspaces/index.html | 6 +++--- examples/rest/tag/index.html | 6 +++--- index.html | 6 +++--- modeling/index.html | 6 +++--- models/alert.v1/index.html | 6 +++--- models/bugexposure.v1/index.html | 6 +++--- models/changecontrol.v1/index.html | 6 +++--- models/configlet.v1/index.html | 6 +++--- models/configstatus.v1/index.html | 6 +++--- models/connectivitymonitor.v1/index.html | 6 +++--- models/dashboard.v1/index.html | 6 +++--- models/endpointlocation.v1/index.html | 6 +++--- models/event.v1/index.html | 6 +++--- models/identityprovider.v1/index.html | 6 +++--- models/imagestatus.v1/index.html | 6 +++--- models/index.html | 6 +++--- models/inventory.v1/index.html | 6 +++--- models/lifecycle.v1/index.html | 6 +++--- models/redirector.v1/index.html | 6 +++--- models/serviceaccount.v1/index.html | 6 +++--- models/studio.v1/index.html | 6 +++--- models/tag.v1/index.html | 6 +++--- models/tag.v2/index.html | 6 +++--- models/workspace.v1/index.html | 6 +++--- rpcs/delete/index.html | 6 +++--- rpcs/errors/index.html | 6 +++--- rpcs/filtering/index.html | 6 +++--- rpcs/getall/index.html | 6 +++--- rpcs/getone/index.html | 6 +++--- rpcs/index.html | 6 +++--- rpcs/set/index.html | 6 +++--- rpcs/subscribe/index.html | 6 +++--- tags/index.html | 6 +++--- 49 files changed, 145 insertions(+), 145 deletions(-) diff --git a/404.html b/404.html index 2b6c8a3e..bdc42d8d 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ 404 Page not found -

Error

Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.

Go to homepage

Page not found!

\ No newline at end of file +

Error

Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.

Go to homepage

Page not found!

\ No newline at end of file diff --git a/categories/index.html b/categories/index.html index a624cc36..10d6eb2b 100644 --- a/categories/index.html +++ b/categories/index.html @@ -1,7 +1,7 @@ Categories :: Arista Networks FMP APIs -

taxonomy :: -Categories

    \ No newline at end of file +Categories
    \ No newline at end of file diff --git a/clients/creating/index.html b/clients/creating/index.html index ec603722..4e4625db 100644 --- a/clients/creating/index.html +++ b/clients/creating/index.html @@ -1,7 +1,7 @@ Creating a Client :: Arista Networks FMP APIs -

    Creating a Client

    A major advantage to Protobuf (and gRPC) is the ability to generate language bindings reliably and dependably.

    The main gRPC site has tutorials for generating clients in many languages:

    There is also an expansive ecosystem, so plenty of languages are supported.

    Tooling

    In general, there are two main components to generating a language binding:

    • protoc: The protobuf compiler which call the language-specific generator
      • typically installed via a package manager (apt, yum, brew, etc)
    • protoc-gen-{language}: The language-specific generator
      • typically installed with the language’s dependency manager, build tool, etc

    Generating

    Regardless of language, client generation generally follows a pattern of:

    $ protoc {includes} {lang-opts} {output-opts} {inputs}
@@ -13,4 +13,4 @@
     $CVAPIS/arista/example.v1/example.proto $CVAPIS/arista/example.v1/services.gen.proto

    In the above examples we generate the protobuf bindings (example.proto) as well as the gRPC services (services.gen.go) in the same command. You are free to do them separately, however, different language generators handle this differently.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/clients/existing/index.html b/clients/existing/index.html index 20c3ac6f..9aeee95a 100644 --- a/clients/existing/index.html +++ b/clients/existing/index.html @@ -1,8 +1,8 @@ Existing Clients :: Arista Networks FMP APIs -

    Existing Clients

    Arista provides and maintains the following clients:

    LanguageRepository
    Gohttps://github.com/aristanetworks/cloudvision-go
    Pythonhttps://github.com/aristanetworks/cloudvision-python
    \ No newline at end of file +
    \ No newline at end of file diff --git a/clients/index.html b/clients/index.html index d588ecbc..4f38be08 100644 --- a/clients/index.html +++ b/clients/index.html @@ -1,8 +1,8 @@ Clients :: Arista Networks FMP APIs -

    Clients

    Clients are generated from the base .proto files shipped in this repository using the protobuf compiler.

    While Arista maintains clients for some languages, creating a client for your language of choice is also possible.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/connecting/index.html b/connecting/index.html index 6597081f..f67a384c 100644 --- a/connecting/index.html +++ b/connecting/index.html @@ -1,7 +1,7 @@ Connecting :: Arista Networks FMP APIs -

    Connecting

    The port used to connect to CVP is 443 for both on-prem and cloud deployments.

    Authentication

    Our APIs currently support token based authentication.

    In future releases we intend to support mutual TLS authentication which does not require tokens or login credentials to be stored along with the application.

    For more details on gRPC authentication, see: authentication.

    Token Based Authentication

    Tokens can be either received from the HTTP login API (only last for 24 hours) or can be generated on for service accounts (recommended).

    Service accounts have been introduced in 2020.3.0 and have been on CVaaS from the beginning.

    The steps to create a service account token are (both CV on-prem and CVaaS):

    1. Go to Settings

    2. Go to Access Control - Service Accounts

    3. Create a Service account if there isn’t one by clicking on the + New Service Account button

      service account 1

    4. Fill out the form and click Add

      service account 2

    5. Edit the service account by clicking on it and generate a token

      service account 3

      service account 4

    The service account token will not be retreivable after clicking Ok. It is recommended to store it somewhere safe.

    Read on if you are interested in generating a short lived token for CloudVision on-prem using the HTTP login API.

    The following examples use python but Go, Java, or any other language capable of HTTP requests will work almost identically. To make the HTTP request, we will use the requests library which is available through pip:

    python -m pip install requests
@@ -98,4 +98,4 @@
 combined_credentials = grpc.composite_channel_credentials(channel_credentials, call_credentials)
 channel = grpc.secure_channel(CV_HOST + ':' + CV_API_PORT, combined_credentails)
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/grpc/index.html b/examples/grpc/index.html index 1e6f669e..c34dd02e 100644 --- a/examples/grpc/index.html +++ b/examples/grpc/index.html @@ -1,7 +1,7 @@ gRPC :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/index.html b/examples/index.html index 0709c009..e9e0ceb0 100644 --- a/examples/index.html +++ b/examples/index.html @@ -1,8 +1,8 @@ Examples :: Arista Networks FMP APIs -

    Examples

    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/bugexposure/index.html b/examples/rest/bugexposure/index.html index 8b040590..ca8b5fcc 100644 --- a/examples/rest/bugexposure/index.html +++ b/examples/rest/bugexposure/index.html @@ -1,7 +1,7 @@ Bugexposure :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/changecontrol/index.html b/examples/rest/changecontrol/index.html index 6b4646b9..fcedef38 100644 --- a/examples/rest/changecontrol/index.html +++ b/examples/rest/changecontrol/index.html @@ -1,7 +1,7 @@ Change Control :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/dashboard/index.html b/examples/rest/dashboard/index.html index e81091aa..657f0d34 100644 --- a/examples/rest/dashboard/index.html +++ b/examples/rest/dashboard/index.html @@ -1,7 +1,7 @@ Dashboard :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/endpointlocation/index.html b/examples/rest/endpointlocation/index.html index 1985b435..28541150 100644 --- a/examples/rest/endpointlocation/index.html +++ b/examples/rest/endpointlocation/index.html @@ -1,7 +1,7 @@ Endpointlocation :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/events/index.html b/examples/rest/events/index.html index b68e0a4d..66f7dfaa 100644 --- a/examples/rest/events/index.html +++ b/examples/rest/events/index.html @@ -1,7 +1,7 @@ Events :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/index.html b/examples/rest/index.html index 9480fd88..11462544 100644 --- a/examples/rest/index.html +++ b/examples/rest/index.html @@ -1,10 +1,10 @@ REST API Examples :: Arista Networks FMP APIs -

    REST API Examples

    Examples scripts: examples_cvprac.py, examples_python_rest.py

    REST bindings for Resource APIs were introduced in CVP 2021.1.0

    When fetching a state from NetDB between two arbitrary dates, the result returned will contain data that existed between those two dates and not just data that was created between those dates. For instance if BGP events are queried between 2023-05-01 10:00 and 2023-05-01 12:00 the result will contain events that were active in the range of 10 AM to 12 PM. If there were events that started before 10 AM and were not resolved (still active) at that time, the result will contain those events too.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/inventory/index.html b/examples/rest/inventory/index.html index fc94ef59..24474f0e 100644 --- a/examples/rest/inventory/index.html +++ b/examples/rest/inventory/index.html @@ -1,7 +1,7 @@ Inventory :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/lifecycle/index.html b/examples/rest/lifecycle/index.html index 77cc947e..ab4e06ee 100644 --- a/examples/rest/lifecycle/index.html +++ b/examples/rest/lifecycle/index.html @@ -1,7 +1,7 @@ Lifecycle :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/studios-and-workspaces/index.html b/examples/rest/studios-and-workspaces/index.html index 8fa1bbb0..ff5af1ef 100644 --- a/examples/rest/studios-and-workspaces/index.html +++ b/examples/rest/studios-and-workspaces/index.html @@ -1,7 +1,7 @@ Studios and Workspaces :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/examples/rest/tag/index.html b/examples/rest/tag/index.html index 083f2cb4..9d3d50d3 100644 --- a/examples/rest/tag/index.html +++ b/examples/rest/tag/index.html @@ -1,7 +1,7 @@ Tags :: Arista Networks FMP APIs -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/index.html b/index.html index 98e3cc5c..e14cf615 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ :: Arista Networks FMP APIs -
    navigation

    CloudVision APIs

    Cloudvision APIs are state based, resource-oriented APIs modeled in Protobuf and accessed over gRPC using a standardized set of RPC verbs.

    CloudVision is a powerful platform that processes and stores tremendous amounts of network data. It knows the topology of the network, device configuration, interface activity and other network events. These APIs allow access to fleet-wide data access and control, forming a management-plane with consistent usage.

    Data Driven

    Functionality is defined in a data-oriented (rather than action-oriented) form. @@ -18,4 +18,4 @@ environment in nearly any language.

    For Arista-supported clients, see the Existing Clients page.
    Alternatively, a basic guide on creating your own.

    In addition to pure-gRPC clients, HTTP REST mappings are easily generated through the great gRPC ecosystem. Thus, APIs can be utilized from nearly anywhere.

    gRPC Ecosystem

    Another benefit of using protobuf and gRPC is the vast ecosystem surrounding them. While portable client-generation is useful a well-supported ecosystem provides even more tooling.

    This list is not extensive, nor an endorsement of any project. -Many more tools can be found on the awesome-grpc page.

    \ No newline at end of file +Many more tools can be found on the awesome-grpc page.

    \ No newline at end of file diff --git a/modeling/index.html b/modeling/index.html index fcdb6d5d..2531aef5 100644 --- a/modeling/index.html +++ b/modeling/index.html @@ -1,7 +1,7 @@ Modeling :: Arista Networks FMP APIs -

    Modeling

    Resources are modeled in Protobuf and accessed over gRPC with a standardized set of RPCs (discussed in later sections). These models are divided into two types:

    • config: models which allow user-modification, exposing modifiable/tunable options.
    • state: models which expose read-only operational and/or derived state based on config data.

    Config Models

    Config models describe the user’s interaction with the system. Fields in these models are populated by the user (or by defaults).

    Config models are read-writeable, meaning their APIs expose both read and write methods. The Protobuf message extension fmp.model = "rw" denotes that a given model is used as config and the generated RPCs will expose both read and write method sets.

    State Models

    State models describe the operational state of the system. Fields in these models are populated by the system and are not modifiable (except through the relevant config model).

    State models only have read methods defined and are denoted with the Protobuf message extension fmp.model = "ro".

    While not required, state models are allowed to “echo” the associated config model for convenience of the user. You should check the relevant model(s) before expecting this behaviour, however.

    High Level Config-State Flow

    Below is a diagram explaining the data flow from writing a Config to the system creating/updating State. @@ -20,4 +20,4 @@ google.protobuf.StringValue wrapped_string = 2; }

    A list of the available wrapper types can be seen here, though models may define their own for maps or repeated (array) fields.

    Keys

    All models (whether config or state) contain a key message.

    This key contains the minimal set of data needed to uniquely identify a given model entity. Model keys may be as simple as a single string (say, a name) or as complex as containing references to a datacenter, device, interface, or any combination of them. The complexity of the key depends entirely on the model at hand.

    Messages used for keys are denoted in protobuf with the extension: fmp.model_key = true.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/alert.v1/index.html b/models/alert.v1/index.html index 66ab6806..7f15eb75 100644 --- a/models/alert.v1/index.html +++ b/models/alert.v1/index.html @@ -1,11 +1,11 @@ alert.v1 :: Arista Networks FMP APIs -

    alert.v1

    Top

    arista/alert.v1/alert.proto

    Alert

    Alert is the current status of the alert system

    Field NameTypeDescription
    configuration_errorsConfigErrors

    configuration_errors contain any configuration errors reported by the backend

    endpoint_errorsEndpointErrors

    endpoint_errors contain any failed attempts to send alerts

    last_modified_atgoogle.protobuf.Timestamp

    last_modified_at is the time at which the configuration was last modified

    last_modified_bygoogle.protobuf.StringValue

    last_modified_by is the user who last modified the configuration

    AlertConfig

    AlertConfig is the configuration for sending alerts

    Field NameTypeDescription
    settingsSettings

    settings is the global default settings for various endpoints used in broadcast groups.

    Can be overwritten in individual endpoint settings

    rulesRules

    rules define how we route alerts to broadcast groups

    broadcast_groupsBroadcastGroups

    broadcast_groups are groups of endpoints that alerts are sent to

    AzureOAuth

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

    Field NameTypeDescription
    client_idgoogle.protobuf.StringValue

    client_id of the Azure environment

    tenant_idgoogle.protobuf.StringValue

    tenant_id of the Azure environment

    client_secretgoogle.protobuf.StringValue

    client_secret is a user generated secret key used for auth

    auth_urigoogle.protobuf.StringValue

    auth_uri is the URI used for OAuth

    BroadcastGroup

    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

    Field NameTypeDescription
    emailEmailEndpoints

    email is a set of email endpoints to send alerts to as part of this group

    webhookWebhookEndpoints

    webhook is a set of webhook endpoints to send alerts to as part of this group

    slackSlackEndpoints

    slack is a set of slack endpoints to send alerts to as part of this group

    opsgenieOpsgenieEndpoints

    opsgenie is a set of opsgenie endpoints to send alerts to as part of this group

    pushoverPushoverEndpoints

    pushover is a set of pushover endpoints to send alerts to as part of this group

    pagerdutyPagerdutyEndpoints

    pagerduty is a set of pagerduty endpoints to send alerts to as part of this group

    victoropsVictorOpsEndpoints

    victorops is a set of victorops endpoints to send alerts to as part of this group

    gchatGoogleChatEndpoints

    gchat is a set of google chat endpoints to send alerts to as part of this group

    msteamsMsTeamsEndpoints

    msteams is a set of MS teams endpoints to send alerts to as part of this group

    sendgridSendgridEndpoints

    sendgrid is a set of sendgrid endpoints to send alerts to as part of this group

    syslogSyslogEndpoints

    syslog is a set of syslog endpoints to send alerts to as part of this group

    snmpSNMPEndpoints

    snmp is a set of snmp endpoints to send alerts to as part of this group

    cue_syslogCueSyslogEndpoints

    cue_syslog is a set of cue syslog endpoints to send alerts to as part of this group

    cue_snmpCueSnmpEndpoints

    cue_snmp is a set of cue snmp endpoints to send alerts to as part of this group

    cue_sendgridCueSendgridEndpoints

    cue_sendgrid is a set of cue sendgrid endpoints to send alerts to as part of this group

    zoomZoomEndpoints

    zoom is a set of zoom endpoints to send alerts to as part of this group

    BroadcastGroups

    BroadcastGroups is a collection of named broadcast groups

    Field NameTypeDescription
    valuesBroadcastGroups.ValuesEntry[…]

    values is a map of user defined ids to broadcast groups. No restrictions to naming applies

    BroadcastGroups.ValuesEntry

    Field NameTypeDescription
    keystring

    valueBroadcastGroup

    ConfigError

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

    Field NameTypeDescription
    pathgoogle.protobuf.StringValue

    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

    error_typeConfigErrorType

    error_type is the type of error, this allows custom handling of different error types

    errorgoogle.protobuf.StringValue

    error is a user-friendly error message

    ConfigErrors

    ConfigErrors is a list of configuration-related errors

    Field NameTypeDescription
    valuesConfigError[…]

    values is a list of errors

    CueData

    CueData contains additional cue-specific data

    Field NameTypeDescription
    valuesCueData.ValuesEntry[…]

    values can contain some additional data which is required by the cue specific provider

    CueData.ValuesEntry

    Field NameTypeDescription
    keystring

    valuestring

    CueSNMPAuth

    CueSNMPAuth is the authentication

    Field NameTypeDescription
    communitygoogle.protobuf.StringValue

    community is the community string used for authentication in SNMPv1 and v2c

    required if version < 3

    usernamegoogle.protobuf.StringValue

    username the username for SNMPv3 auth

    security_levelSNMPSecurityLevel

    security_level the security level for SNMPv3

    authentication_protocolCueSNMPAuthProtocol

    authentication_protocol is the protocol to use for authentication in SNMPv3

    required for AUTH_NO_PRIV/AUTH_PRIV security levels

    authentication_passphrasegoogle.protobuf.StringValue

    authentication_passphrase is the passphrase to use for authentication in SNMPv3

    required for AUTH_NO_PRIV/AUTH_PRIV security levels

    privacy_protocolCueSNMPPrivProtocol

    privacy_protocol is the protocol to use for privacy in SNMPv3

    required for AUTH_PRIV security level

    privacy_passphrasegoogle.protobuf.StringValue

    privacy_passphrase is the passphrase to use for privacy in SNMPv3

    required for AUTH_PRIV security level

    CueSNMPEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    settings_overrideCueSNMPSettings

    settings_override is the override for the cue snmp global endpoint settings

    CueSNMPSettings

    CueSNMPSettings contain the settings for sending cue alerts with SNMP

    Field NameTypeDescription
    targetgoogle.protobuf.StringValue

    target is an ipv4 address to send messages to

    portgoogle.protobuf.Int32Value

    port is the network port to target

    transportgoogle.protobuf.StringValue

    transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

    versiongoogle.protobuf.Int32Value

    version is the SNMP version, v2c and v3 are supported and can be set with 2 and 3 respectively

    authCueSNMPAuth

    auth is the optional authentication settings

    dataCueData

    data is additional data that maybe required for constructing the message or sending it

    CueSendgridEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    togoogle.protobuf.StringValue

    to address to send email to

    http_overrideHttpSettings

    http_override is the override of the global http settings

    This overrides the value used in Settings message in the global alert config

    CueSendgridEndpoints

    CueSendgridEndpoints is a set of cue sendgrid endpoints

    Field NameTypeDescription
    valuesCueSendgridEndpoint[…]

    values are the elements of the set

    CueSendgridSettings

    CueSendgridSettings contain the settings for sending cue alerts to sendgrid

    Field NameTypeDescription
    api_keygoogle.protobuf.StringValue

    api_key is the key used to connect to the sendgrid APIs

    fromgoogle.protobuf.StringValue

    from is the sender’s address in the email sent

    CueSnmpEndpoints

    CueSnmpEndpoints is a set of cue SNMP endpoints

    Field NameTypeDescription
    valuesCueSNMPEndpoint[…]

    values are the elements of the set

    CueSyslogEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    settings_overrideCueSyslogSettings

    settings_override is the override for the cue syslog global endpoint settings

    CueSyslogEndpoints

    CueSyslogEndpoints is a set of cue syslog endpoints

    Field NameTypeDescription
    valuesCueSyslogEndpoint[…]

    values are the elements of the set

    CueSyslogSettings

    CueSyslogSettings contain the settings for sending alerts with syslog for cue

    Field NameTypeDescription
    networkgoogle.protobuf.StringValue

    network is the network protocol to use, default is “udp”,

    options also include: tcp,tcp4,tcp6,udp4,udp6

    addressgoogle.protobuf.StringValue

    address is the ip address to send syslog messages to

    portgoogle.protobuf.Int32Value

    port is server’s port to connect to

    message_formatCueSyslogMessageFormat

    message_format defines the message format to use

    append_bom_headergoogle.protobuf.BoolValue

    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.

    dataCueData

    data is additional data that maybe required for constructing the message or sending it

    DefaultTemplate

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

    Field NameTypeDescription
    keyTemplateKey

    key identifies which template the configuration is for

    templategoogle.protobuf.StringValue

    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

    multi_alertgoogle.protobuf.BoolValue

    multi_alert is true if this template uses a multiple alert context and false if a single

    alert context is used.

    descriptiongoogle.protobuf.StringValue

    description is a description of the template.

    external_documentationgoogle.protobuf.StringValue

    external_documentation is a url to any relevant external documentation, or "" if there is no

    relevant documentation.

    output_formatTemplateOutput

    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.

    display_namegoogle.protobuf.StringValue

    display_name is the name that can be displayed to the user for this particular template type

    EmailEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    togoogle.protobuf.StringValue

    to address to send email to

    Email does not have a http override

    Email does not have a settings override

    EmailEndpoints

    EmailEndpoints is a set of email endpoints

    Field NameTypeDescription
    valuesEmailEndpoint[…]

    values are the elements of the set

    EmailSettings

    EmailSettings contain the settings for the sending of emails

    Field NameTypeDescription
    fromgoogle.protobuf.StringValue

    from is the email address to send from

    smarthostgoogle.protobuf.StringValue

    smarthost is the hostname and port of the SMTP server

    auth_usernamegoogle.protobuf.StringValue

    auth_username the username to use when sending emails

    required for all auth methods

    auth_passwordgoogle.protobuf.StringValue

    auth_password the password to use when sending emails

    require_tlsgoogle.protobuf.BoolValue

    require_tls always use TLS connections when sending emails

    single_alert_per_emailgoogle.protobuf.BoolValue

    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

    azure_o_authAzureOAuth

    azure_o_auth used for auth when using an Azure smtp server

    uses auth_username

    EndpointError

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

    Field NameTypeDescription
    endpoint_typegoogle.protobuf.StringValue

    endpoint_type indicates the type of endpoint which failed,

    or unknown if not endpoint-specific (eg: slack, opsgenie)

    broadcast_group_namegoogle.protobuf.StringValue

    broadcast_group_name is the name of the broadcast group which was being used,

    empty string if not group specific

    config_indexgoogle.protobuf.Int32Value

    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/…

    error_typeEndpointErrorType

    error_type is the type of error, this allows custom handling of different error types

    errorgoogle.protobuf.StringValue

    error is a user-friendly error message

    EndpointErrors

    EndpointErrors is a set of errors related to sending of alerts

    Field NameTypeDescription
    valuesEndpointError[…]

    values is the list of errors

    EventList

    EventList is a list of event types

    Field NameTypeDescription
    event_typesfmp.RepeatedString

    event_types contain the event types

    GoogleChatEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideGoogleChatSettings

    settings_override is the override for the google chat global endpoint settings

    GoogleChatEndpoints

    GoogleChatEndpoints is a set of googleChat endpoints

    Field NameTypeDescription
    valuesGoogleChatEndpoint[…]

    values are the elements of the set

    GoogleChatSettings

    GoogleChatSettings contain the settings for sending alerts to google chat

    Field NameTypeDescription
    urlgoogle.protobuf.StringValue

    url is the url of the webhook to send alerts to

    HeaderValues

    HeaderValues is a set of values for this header

    Field NameTypeDescription
    valuesstring[…]

    values is the header values

    HttpHeaders

    HttpHeaders is a set of http headers

    Field NameTypeDescription
    valuesHttpHeaders.ValuesEntry[…]

    values is a map of http header names to values

    HttpHeaders.ValuesEntry

    Field NameTypeDescription
    keystring

    valueHeaderValues

    HttpSettings

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

    Field NameTypeDescription
    usernamegoogle.protobuf.StringValue

    username is the username to use when connecting to the http proxy

    passwordgoogle.protobuf.StringValue

    password is the password to use when connecting to the http proxy

    proxy_urlgoogle.protobuf.StringValue

    proxy_url is the url for the http proxy

    custom_headersHttpHeaders

    custom_headers is custom http headers to be used along with the default headers

    InhibitionSettings

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

    Field NameTypeDescription
    valuesInhibitionSettings.ValuesEntry[…]

    values is a map where the keys are event type which when active will suppress any events with

    event types in the related EventList

    InhibitionSettings.ValuesEntry

    Field NameTypeDescription
    keystring

    valueEventList

    Matches

    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

    Field NameTypeDescription
    severitiesfmp.RepeatedString

    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

    devicesfmp.RepeatedString

    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_typesfmp.RepeatedString

    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

    device_tagsgoogle.protobuf.StringValue

    device_tags is a string tag query that is used to match on the event’s device tags

    intf_tagsgoogle.protobuf.StringValue

    intf_tags is a string tag query that is used to match on the event’s interface tags

    rule_idsfmp.RepeatedString

    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

    MsTeamsEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideMsTeamsSettings

    settings_override is the override for the microsoft teams global endpoint settings

    MsTeamsEndpoints

    MsTeamsEndpoints is a set of ms teams endpoints

    Field NameTypeDescription
    valuesMsTeamsEndpoint[…]

    values are the elements of the set

    MsTeamsSettings

    MsTeamsSettings contain the settings for sending alerts to MS Teams

    Field NameTypeDescription
    urlgoogle.protobuf.StringValue

    url is the url of the webhook to send alerts to

    OpsgenieEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideOpsgenieSettings

    settings_override is the override for the opsgenie global endpoint settings

    OpsgenieEndpoints

    OpsgenieEndpoints is a set of opsgenie endpoints

    Field NameTypeDescription
    valuesOpsgenieEndpoint[…]

    values are the elements of the set

    OpsgenieSettings

    OpsgenieSettings contain the settings for sending alerts to opsgenie

    Field NameTypeDescription
    keygoogle.protobuf.StringValue

    key is the API key to use when talking to the OpsGenie API

    urlgoogle.protobuf.StringValue

    url is the url to use when sending alerts to opsgenie

    PagerdutyEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    routing_keygoogle.protobuf.StringValue

    routing_key is the routing key for sending pagerduty alerts

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overridePagerdutySettings

    settings_override is the override for the pagerduty global endpoint settings

    PagerdutyEndpoints

    PagerdutyEndpoints is a set of pagerduty endpoints

    Field NameTypeDescription
    valuesPagerdutyEndpoint[…]

    values are the elements of the set

    PagerdutySettings

    PagerdutySettings contain the settings for sending alerts to pagerduty

    Field NameTypeDescription
    urlgoogle.protobuf.StringValue

    url is the url to use when sending alerts to pagerduty

    Priorities

    Priorities is a mapping of CV event severities to syslog severities

    Field NameTypeDescription
    criticalgoogle.protobuf.Int32Value

    critical priority, default = 2 (Critical)

    errorgoogle.protobuf.Int32Value

    error priority, default = 3 (Error)

    warngoogle.protobuf.Int32Value

    warn priority, default = 4 (Warning)

    infogoogle.protobuf.Int32Value

    info priority, default = 6 (Informational)

    PushoverEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    tokengoogle.protobuf.StringValue

    token is the user’s registered application’s API token, see https://pushover.net/apps

    user_keygoogle.protobuf.StringValue

    user_key is the user’s user key

    http_overrideHttpSettings

    http_override is the override of the global http settings

    Pushover does not have a settings override

    PushoverEndpoints

    PushoverEndpoints is a set of pushover endpoints

    Field NameTypeDescription
    valuesPushoverEndpoint[…]

    values are the elements of the set

    Rule

    Rule is a rule to send to a certain broadcast group

    Field NameTypeDescription
    sends_togoogle.protobuf.StringValue

    sends_to is the name of the broadcast group top send matching alerts to

    match_criteriaMatches

    match_criteria is the criteria that an alert must match to be sent to the broadcast group

    continue_checksgoogle.protobuf.BoolValue

    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

    commentgoogle.protobuf.StringValue

    comment is a comment to include that will be displayed in the alert

    Rules

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

    Field NameTypeDescription
    valuesRule[…]

    values contains the rules

    SNMPAuth

    SNMPAuth contain authentication information for SNMP

    Field NameTypeDescription
    communitygoogle.protobuf.StringValue

    community is the community string used for authentication in SNMPv1 and v2c

    required if version < 3

    usernamegoogle.protobuf.StringValue

    username the username for SNMPv3 auth

    security_levelSNMPSecurityLevel

    security_level the security level for SNMPv3

    authentication_protocolSNMPAuthProtocol

    authentication_protocol is the protocol to use for authentication in SNMPv3

    required for AUTH_NO_PRIV/AUTH_PRIV security levels

    authentication_passphrasegoogle.protobuf.StringValue

    authentication_passphrase is the passphrase to use for authentication in SNMPv3

    required for AUTH_NO_PRIV/AUTH_PRIV security levels

    privacy_protocolSNMPPrivProtocol

    privacy_protocol is the protocol to use for privacy in SNMPv3

    required for AUTH_PRIV security level

    privacy_passphrasegoogle.protobuf.StringValue

    privacy_passphrase is the passphrase to use for privacy in SNMPv3

    required for AUTH_PRIV security level

    SNMPEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    settings_overrideSNMPSettings

    settings_override is the override for the microsoft teams global endpoint settings

    SNMPEndpoints

    SNMPEndpoints is a set of SNMP endpoints

    Field NameTypeDescription
    valuesSNMPEndpoint[…]

    values are the elements of the set

    SNMPSettings

    SNMPSettings contain the settings for sending alerts with SNMP

    Field NameTypeDescription
    targetgoogle.protobuf.StringValue

    target is an ipv4 address to send messages to

    portgoogle.protobuf.Int32Value

    port is the network port to target

    transportgoogle.protobuf.StringValue

    transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

    versiongoogle.protobuf.Int32Value

    version is the SNMP version, v1, v2c and v3 are supported and can be set

    with 1, 2 and 3 respectively

    authSNMPAuth

    auth is optional authentication settings

    engine_idgoogle.protobuf.StringValue

    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

    SendgridEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    togoogle.protobuf.StringValue

    to address to send email to

    http_overrideHttpSettings

    http_override is the override of the global http settings

    SendgridEndpoints

    SendgridEndpoints is a set of sendgrid endpoints

    Field NameTypeDescription
    valuesSendgridEndpoint[…]

    values are the elements of the set

    SendgridSettings

    SendgridSettings contain the settings for sending emails via sendgrid

    Field NameTypeDescription
    api_keygoogle.protobuf.StringValue

    api_key is the api key to use

    fromgoogle.protobuf.StringValue

    from is the email address to send from

    Settings

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

    Field NameTypeDescription
    emailEmailSettings

    email is the global default settings for email

    httpHttpSettings

    http is the global default settings for http

    slackSlackSettings

    slack is the global default settings for slack

    victoropsVictoropsSettings

    victorops is the global default settings for victorops

    pagerdutyPagerdutySettings

    pagerduty is the global default settings for pagerduty

    opsgenieOpsgenieSettings

    opsgenie is the global default settings for opsgenie

    gchatGoogleChatSettings

    gchat is the global default settings for google chat

    msteamsMsTeamsSettings

    msteams is the global default settings for ms teams

    inhibitionInhibitionSettings

    inhibition defines the inhibition rules for alerts, allowing events of certain types to be

    suppressed while another event type is active

    base_urlgoogle.protobuf.StringValue

    base_url is the root address of your CloudVision app. Used to generate links in notifications.

    timezonegoogle.protobuf.StringValue

    timezone is used for formatting event times in notifications. E.g. ‘UTC’, ‘US/Pacific’

    syslogSyslogSettings

    syslog is the global default settings for syslog

    snmpSNMPSettings

    snmp is the global default settings for snmp

    sendgridSendgridSettings

    sendgrid is the global default settings for sendgrid

    cue_syslogCueSyslogSettings

    cue_syslog is the global default settings for cue syslog

    cue_snmpCueSNMPSettings

    cue_snmp is the global default settings for cue snmp

    cue_sendgridCueSendgridSettings

    cue_sendgrid is the global default settings for cue sendgrid

    hide_tagsgoogle.protobuf.BoolValue

    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

    zoomZoomSettings

    zoom is the global default settings for zoom

    SlackEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideSlackSettings

    settings_override is the override for the slack global endpoint settings

    SlackEndpoints

    SlackEndpoints is a set of slack endpoints

    Field NameTypeDescription
    valuesSlackEndpoint[…]

    values are the elements of the set

    SlackSettings

    SlackSettings contain the settings for sending alerts to slack

    Field NameTypeDescription
    urlgoogle.protobuf.StringValue

    url is the url of the slack webhook to use

    SyslogEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    settings_overrideSyslogSettings

    settings_override is the override for the microsoft teams global endpoint settings

    SyslogEndpoints

    SyslogEndpoints is a set of syslog endpoints

    Field NameTypeDescription
    valuesSyslogEndpoint[…]

    values are the elements of the set

    SyslogSettings

    SyslogSettings contain the settings for sending alerts with syslog

    Field NameTypeDescription
    networkgoogle.protobuf.StringValue

    network is the network protocol to use, default is “udp”,

    options also include: tcp,tcp4,tcp6,udp4,udp6

    addressgoogle.protobuf.StringValue

    address is the network address to send syslog messages to

    facilitygoogle.protobuf.Int32Value

    facility is the syslog facility 0-23 inc. This is the syslog facility as defined in RFC-3164

    prioritiesPriorities

    priorities describes how CVP severity maps to syslog priority

    priority is a number between 0-7 inc. as defined in RFC-3164

    taggoogle.protobuf.StringValue

    tag is the syslog TAG as described in RFC-3164, it is the prefix to all syslog messages

    per_devicegoogle.protobuf.BoolValue

    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

    use_tlsgoogle.protobuf.BoolValue

    use_tls determines if the connection to the server should be secured with TLS

    TemplateConfig

    TemplateConfig represents a template configuration

    Field NameTypeDescription
    keyTemplateKey

    key identifies which template the configuration is for

    templategoogle.protobuf.StringValue

    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

    TemplateKey

    TemplateKey is used to identify templates for event notifications

    Field NameTypeDescription
    template_typeTemplateType

    template_type is the enum value to match with the template

    VictorOpsEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    routing_keygoogle.protobuf.StringValue

    routing_key is the PagerDuty integration key

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideVictoropsSettings

    settings_override is the override for the victorops global endpoint settings

    VictorOpsEndpoints

    VictorOpsEndpoints is a set of victorOps endpoints

    Field NameTypeDescription
    valuesVictorOpsEndpoint[…]

    values are the elements of the set

    VictoropsSettings

    VictoropsSettings contain the settings for sending alerts to victorops

    Field NameTypeDescription
    keygoogle.protobuf.StringValue

    key is the API key to use when talking to the VictorOps API

    urlgoogle.protobuf.StringValue

    url is the victorops url to use (without integration or routing key

    default: https://alert.victorops.com/integrations/generic/20131114/alert/

    WebhookEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    urlgoogle.protobuf.StringValue

    url is the url

    http_overrideHttpSettings

    http_override is the override of the global http settings

    simple_outputgoogle.protobuf.BoolValue

    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_alertgoogle.protobuf.BoolValue

    single_alert is a boolean flag that will cause an individual webhook message to be sent per

    alert when true.

    Webhook does not have a settings override

    WebhookEndpoints

    WebhookEndpoints is a set of webhook endpoints

    Field NameTypeDescription
    valuesWebhookEndpoint[…]

    values are the elements of the set

    ZoomEndpoint

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

    Field NameTypeDescription
    send_resolvedgoogle.protobuf.BoolValue

    send_resolved send alerts when events are resolved along with when they are triggered

    http_overrideHttpSettings

    http_override is the override of the global http settings

    settings_overrideZoomSettings

    settings_override is the override for the zoom global endpoint settings

    ZoomEndpoints

    ZoomEndpoints is a set of zoom endpoints

    Field NameTypeDescription
    valuesZoomEndpoint[…]

    values are the elements of the set

    ZoomSettings

    ZoomSettings contain the settings for sending alerts to zoom

    Field NameTypeDescription
    urlgoogle.protobuf.StringValue

    url is the zoom incoming webhook URL to send messages to

    verification_tokengoogle.protobuf.StringValue

    verification_token is the verification token to authenticate with

    ConfigErrorType

    ConfigErrorType describes the set of possible config error types

    NameNumberDescription
    CONFIG_ERROR_TYPE_UNSPECIFIED0

    CONFIG_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

    CONFIG_ERROR_TYPE_INVALID_FORMAT2

    CONFIG_ERROR_TYPE_INVALID_FORMAT is caused by invalid format for value (eg: url)

    CONFIG_ERROR_TYPE_INVALID_SYNTAX3

    CONFIG_ERROR_TYPE_INVALID_SYNTAX is caused by invalid syntax for value (eg: regex)

    CONFIG_ERROR_TYPE_TEMPLATE_INVALID4

    CONFIG_ERROR_TYPE_TEMPLATE_INVALID is caused by failure to parse a template

    CONFIG_ERROR_TYPE_ILLEGAL_VALUE5

    CONFIG_ERROR_TYPE_ILLEGAL_VALUE is caused by a value outside of its bounds

    CONFIG_ERROR_TYPE_MISSING_REQUIRED6

    CONFIG_ERROR_TYPE_MISSING_REQUIRED is caused by a missing required attribute

    CONFIG_ERROR_TYPE_INVALID_TYPE7

    CONFIG_ERROR_TYPE_INVALID_TYPE is caused by the wrong type found in backing store

    CueSNMPAuthProtocol

    CueSNMPAuthProtocol represents the authentication protocol to be used

    NameNumberDescription
    CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED0

    CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

    CUE_SNMP_AUTH_PROTOCOL_MD51

    CUE_SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

    CUE_SNMP_AUTH_PROTOCOL_SHA2

    CUE_SNMP_AUTH_PROTOCOL_SHA use the sha protocol

    CueSNMPPrivProtocol

    CueSNMPPrivProtocol represents the privacy protocol to be used

    NameNumberDescription
    CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED0

    CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

    CUE_SNMP_PRIV_PROTOCOL_DES1

    CUE_SNMP_PRIV_PROTOCOL_DES use the des protocol

    CUE_SNMP_PRIV_PROTOCOL_AES2

    CUE_SNMP_PRIV_PROTOCOL_AES use the aes protocol

    CueSyslogMessageFormat

    CueSyslogMessageFormat is the message format for cue syslog messages

    NameNumberDescription
    CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED0

    CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED is the unspecified enum value

    CUE_SYSLOG_MESSAGE_FORMAT_PLAIN1

    CUE_SYSLOG_MESSAGE_FORMAT_PLAIN format uses the text format for constructing the syslog message

    CUE_SYSLOG_MESSAGE_FORMAT_IDMEF2

    CUE_SYSLOG_MESSAGE_FORMAT_IDMEF uses IDMEF message format as described here:

    https://datatracker.ietf.org/doc/html/rfc4765

    EndpointErrorType

    EndpointErrorType describe the set of possible endpoint types

    NameNumberDescription
    ENDPOINT_ERROR_TYPE_UNSPECIFIED0

    ENDPOINT_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

    ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR1

    ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR an error in sending HTTP request or reading a HTTP

    response

    ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR2

    ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR is caused by errors while encoding json

    ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR3

    ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR is an error caused by invalid config (missing,

    bad format, etc)

    ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR4

    ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR is caused by errors while executing templates

    ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR5

    ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR is caused by receiving a negative response from an

    endpoint indicating that the alert was not sent

    ENDPOINT_ERROR_TYPE_SMTP_ERROR6

    ENDPOINT_ERROR_TYPE_SMTP_ERROR is caused by errors with SMTP

    ENDPOINT_ERROR_TYPE_CONNECTION_ERROR7

    ENDPOINT_ERROR_TYPE_CONNECTION_ERROR is caused by errors with a connection

    ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR8

    ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR is caused by errors with a connection

    ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR9

    ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR is caused by an Alerter rate limit being exceeded

    ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR10

    ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR is caused by the number of alerts sent to a sender

    exceeding the built-in limit

    ENDPOINT_ERROR_TYPE_O_AUTH_ERROR11

    ENDPOINT_ERROR_TYPE_O_AUTH_ERROR is caused when we failed authenticating using the

    OAuth apis

    SNMPAuthProtocol

    SNMPAuthProtocol represents the authentication protocol to be used

    NameNumberDescription
    SNMP_AUTH_PROTOCOL_UNSPECIFIED0

    SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

    SNMP_AUTH_PROTOCOL_MD51

    SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

    SNMP_AUTH_PROTOCOL_SHA2

    SNMP_AUTH_PROTOCOL_SHA use the sha protocol

    SNMP_AUTH_PROTOCOL_SHA_2243

    SNMP_AUTH_PROTOCOL_SHA_224 use the sha224 protocol

    SNMP_AUTH_PROTOCOL_SHA_2564

    SNMP_AUTH_PROTOCOL_SHA_256 use the sha256 protocol

    SNMP_AUTH_PROTOCOL_SHA_3845

    SNMP_AUTH_PROTOCOL_SHA_384 use the sha384 protocol

    SNMP_AUTH_PROTOCOL_SHA_5126

    SNMP_AUTH_PROTOCOL_SHA_512 use the sha512 protocol

    SNMPPrivProtocol

    SNMPPrivProtocol represents the privacy protocol to be used

    NameNumberDescription
    SNMP_PRIV_PROTOCOL_UNSPECIFIED0

    SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

    SNMP_PRIV_PROTOCOL_DES1

    SNMP_PRIV_PROTOCOL_DES use the des protocol

    SNMP_PRIV_PROTOCOL_AES2

    SNMP_PRIV_PROTOCOL_AES use the aes protocol

    SNMP_PRIV_PROTOCOL_AES_1923

    SNMP_PRIV_PROTOCOL_AES_192 use the aes192 protocol

    SNMP_PRIV_PROTOCOL_AES_2564

    SNMP_PRIV_PROTOCOL_AES_256 use the aes256 protocol

    SNMP_PRIV_PROTOCOL_AES_192C5

    SNMP_PRIV_PROTOCOL_AES_192C use the aes192c protocol

    SNMP_PRIV_PROTOCOL_AES_256C6

    SNMP_PRIV_PROTOCOL_AES_256C use the aes256c protocol

    SNMPSecurityLevel

    SNMPSecurityLevel indicates what level of security should be used

    NameNumberDescription
    SNMP_SECURITY_LEVEL_UNSPECIFIED0

    SNMP_SECURITY_LEVEL_UNSPECIFIED is the unspecified enum value

    SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV1

    SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV use no security

    SNMP_SECURITY_LEVEL_AUTH_NO_PRIV2

    SNMP_SECURITY_LEVEL_AUTH_NO_PRIV use authentication without privacy

    SNMP_SECURITY_LEVEL_AUTH_PRIV3

    SNMP_SECURITY_LEVEL_AUTH_PRIV use both authentication and privacy

    TemplateOutput

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

    NameNumberDescription
    TEMPLATE_OUTPUT_UNSPECIFIED0

    TEMPLATE_OUTPUT_UNSPECIFIED is the unspecfied value.

    TEMPLATE_OUTPUT_TEXT1

    TEMPLATE_OUTPUT_TEXT indicates the the template outputs plain text.

    TEMPLATE_OUTPUT_JSON2

    TEMPLATE_OUTPUT_JSON indicates the the template outputs JSON.

    TEMPLATE_OUTPUT_HTML3

    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.

    TemplateType

    TemplateType describes the types of Templates that are usable

    NameNumberDescription
    TEMPLATE_TYPE_UNSPECIFIED0

    TEMPLATE_TYPE_UNSPECIFIED is the unspecified enum value

    TEMPLATE_TYPE_EMAIL_HTML1

    TEMPLATE_TYPE_EMAIL_HTML is the key of the html template for sent emails

    TEMPLATE_TYPE_EMAIL_TEXT2

    TEMPLATE_TYPE_EMAIL_TEXT is the key of the text template for sent emails

    TEMPLATE_TYPE_SLACK_MESSAGE3

    TEMPLATE_TYPE_SLACK_MESSAGE is the key of the message template for sent slack messages

    TEMPLATE_TYPE_PUSHOVER_MESSAGE4

    TEMPLATE_TYPE_PUSHOVER_MESSAGE is the key of the message template for sent pushover messages

    TEMPLATE_TYPE_PAGERDUTY_SUMMARY5

    TEMPLATE_TYPE_PAGERDUTY_SUMMARY is the key of the summary template for sent pagerduty messages

    TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME6

    TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME is the key of the display name template for sent victorops

    messages

    TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE7

    TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE is the key of the state message template for sent

    victorops messages

    TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE8

    TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE is the key of the message template for sent Google chat

    messages

    TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE9

    TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE is the key of the message template for sent Microsoft

    teams messages

    TEMPLATE_TYPE_EMAIL_SUBJECT10

    TEMPLATE_TYPE_EMAIL_SUBJECT is the key of the subject line template of a sent email

    TEMPLATE_TYPE_SYSLOG_MESSAGE11

    TEMPLATE_TYPE_SYSLOG_MESSAGE is the key of the message template for a syslog message part

    TEMPLATE_TYPE_OPSGENIE_MESSAGE12

    TEMPLATE_TYPE_OPSGENIE_MESSAGE is the key of the message template for a opsgenie alert

    TEMPLATE_TYPE_ZOOM_MESSAGE13

    TEMPLATE_TYPE_ZOOM_MESSAGE is the key of the message template for sent Zoom messages

    TEMPLATE_TYPE_EMAIL_SINGLE_HTML14

    TEMPLATE_TYPE_EMAIL_SINGLE_HTML is the key of the html template for sent emails when the

    single alert per email option is selected

    TEMPLATE_TYPE_EMAIL_SINGLE_TEXT15

    TEMPLATE_TYPE_EMAIL_SINGLE_TEXT is the key of the text template for sent emails when the

    single alert per email option is selected

    TEMPLATE_TYPE_EMAIL_SINGLE_SUBJECT16

    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

    TEMPLATE_TYPE_WEBHOOK_SINGLE17

    TEMPLATE_TYPE_WEBHOOK_SINGLE is the key of the template for webhook message body when the

    single_alert option is true

    TEMPLATE_TYPE_WEBHOOK_MULTIPLE18

    TEMPLATE_TYPE_WEBHOOK_MULTIPLE is the key of the template for webhook message body when the

    single_alert option is false

    Top

    arista/alert.v1/services.gen.proto

    AlertConfigRequest

    Field NameTypeDescription
    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.

    AlertConfigResponse

    Field NameTypeDescription
    valueAlertConfig

    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

    AlertConfig instance in this response.

    AlertConfigSetRequest

    Field NameTypeDescription
    valueAlertConfig

    AlertConfig carries the value to set into the datastore.

    See the documentation on the AlertConfig struct for which fields are required.

    AlertConfigSetResponse

    Field NameTypeDescription
    valueAlertConfig

    Value carries all the values given in the AlertConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    AlertConfigStreamRequest

    Field NameTypeDescription
    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.

    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.

    This field is not allowed in the Subscribe RPC.

    AlertConfigStreamResponse

    Field NameTypeDescription
    valueAlertConfig

    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 AlertConfig’s last modification.

    typearista.subscriptions.Operation

    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.

    AlertRequest

    Field NameTypeDescription
    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.

    AlertResponse

    Field NameTypeDescription
    valueAlert

    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

    Alert instance in this response.

    AlertStreamRequest

    Field NameTypeDescription
    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.

    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.

    This field is not allowed in the Subscribe RPC.

    AlertStreamResponse

    Field NameTypeDescription
    valueAlert

    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 Alert’s last modification.

    typearista.subscriptions.Operation

    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.

    DefaultTemplateRequest

    Field NameTypeDescription
    keyTemplateKey

    Key uniquely identifies a DefaultTemplate 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.

    DefaultTemplateResponse

    Field NameTypeDescription
    valueDefaultTemplate

    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

    DefaultTemplate instance in this response.

    DefaultTemplateSomeRequest

    Field NameTypeDescription
    keysTemplateKey[…]

    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.

    DefaultTemplateSomeResponse

    Field NameTypeDescription
    valueDefaultTemplate

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    DefaultTemplateStreamRequest

    Field NameTypeDescription
    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.

    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.

    This field is not allowed in the Subscribe RPC.

    DefaultTemplateStreamResponse

    Field NameTypeDescription
    valueDefaultTemplate

    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 DefaultTemplate’s last modification.

    typearista.subscriptions.Operation

    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.

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    TemplateConfigDeleteAllRequest

    TemplateConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTemplateKey

    This is the key of the TemplateConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    TemplateConfigDeleteRequest

    Field NameTypeDescription
    keyTemplateKey

    Key indicates which TemplateConfig instance to remove.

    This field must always be set.

    TemplateConfigDeleteResponse

    Field NameTypeDescription
    keyTemplateKey

    Key echoes back the key of the deleted TemplateConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    TemplateConfigDeleteSomeRequest

    Field NameTypeDescription
    keysTemplateKey[…]

    key contains a list of TemplateConfig keys to delete

    TemplateConfigDeleteSomeResponse

    TemplateConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyTemplateKey

    errorstring

    TemplateConfigRequest

    Field NameTypeDescription
    keyTemplateKey

    Key uniquely identifies a TemplateConfig 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.

    TemplateConfigResponse

    Field NameTypeDescription
    valueTemplateConfig

    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

    TemplateConfig instance in this response.

    TemplateConfigSetRequest

    Field NameTypeDescription
    valueTemplateConfig

    TemplateConfig carries the value to set into the datastore.

    See the documentation on the TemplateConfig struct for which fields are required.

    TemplateConfigSetResponse

    Field NameTypeDescription
    valueTemplateConfig

    Value carries all the values given in the TemplateConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    TemplateConfigSetSomeRequest

    Field NameTypeDescription
    valuesTemplateConfig[…]

    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.

    TemplateConfigSetSomeResponse

    Field NameTypeDescription
    keyTemplateKey

    errorstring

    TemplateConfigSomeRequest

    Field NameTypeDescription
    keysTemplateKey[…]

    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.

    TemplateConfigSomeResponse

    Field NameTypeDescription
    valueTemplateConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TemplateConfigStreamRequest

    Field NameTypeDescription
    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.

    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.

    This field is not allowed in the Subscribe RPC.

    TemplateConfigStreamResponse

    Field NameTypeDescription
    valueTemplateConfig

    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 TemplateConfig’s last modification.

    typearista.subscriptions.Operation

    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.

    AlertConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneAlertConfigRequestAlertConfigResponse

    GetAllAlertConfigStreamRequestAlertConfigStreamResponse stream

    SubscribeAlertConfigStreamRequestAlertConfigStreamResponse stream

    SubscribeMetaAlertConfigStreamRequestMetaResponse stream

    SetAlertConfigSetRequestAlertConfigSetResponse

    AlertService

    Method NameRequest TypeResponse TypeDescription
    GetOneAlertRequestAlertResponse

    GetAllAlertStreamRequestAlertStreamResponse stream

    SubscribeAlertStreamRequestAlertStreamResponse stream

    SubscribeMetaAlertStreamRequestMetaResponse stream

    DefaultTemplateService

    Method NameRequest TypeResponse TypeDescription
    GetOneDefaultTemplateRequestDefaultTemplateResponse

    GetSomeDefaultTemplateSomeRequestDefaultTemplateSomeResponse stream

    GetAllDefaultTemplateStreamRequestDefaultTemplateStreamResponse stream

    SubscribeDefaultTemplateStreamRequestDefaultTemplateStreamResponse stream

    GetMetaDefaultTemplateStreamRequestMetaResponse

    SubscribeMetaDefaultTemplateStreamRequestMetaResponse stream

    TemplateConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneTemplateConfigRequestTemplateConfigResponse

    GetSomeTemplateConfigSomeRequestTemplateConfigSomeResponse stream

    GetAllTemplateConfigStreamRequestTemplateConfigStreamResponse stream

    SubscribeTemplateConfigStreamRequestTemplateConfigStreamResponse stream

    GetMetaTemplateConfigStreamRequestMetaResponse

    SubscribeMetaTemplateConfigStreamRequestMetaResponse stream

    SetTemplateConfigSetRequestTemplateConfigSetResponse

    SetSomeTemplateConfigSetSomeRequestTemplateConfigSetSomeResponse stream

    DeleteTemplateConfigDeleteRequestTemplateConfigDeleteResponse

    DeleteSomeTemplateConfigDeleteSomeRequestTemplateConfigDeleteSomeResponse stream

    DeleteAllTemplateConfigDeleteAllRequestTemplateConfigDeleteAllResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/bugexposure.v1/index.html b/models/bugexposure.v1/index.html index ec4cd94f..3e3fda70 100644 --- a/models/bugexposure.v1/index.html +++ b/models/bugexposure.v1/index.html @@ -1,7 +1,7 @@ bugexposure.v1 :: Arista Networks FMP APIs -

    bugexposure.v1

    Top

    arista/bugexposure.v1/bugexposure.proto

    BugExposure

    BugExposure is the state model that represents @@ -12,4 +12,4 @@ computed bugs

    NameNumberDescription
    ACKNOWLEDGEMENT_UNSPECIFIED0

    Unacknowledged and acknowledged bugs will be computed

    ACKNOWLEDGEMENT_UNACKNOWLEDGED1

    Only unacknowledged bugs will be computed

    ACKNOWLEDGEMENT_ACKNOWLEDGED2

    Only acknowledged bugs will be computed

    HighestExposure

    HighestExposure is an enumeration that defines the options for highest exposure

    NameNumberDescription
    HIGHEST_EXPOSURE_UNSPECIFIED0

    If not given this will be the default value

    and it will compute devices with

    any highest exposure

    HIGHEST_EXPOSURE_NONE1

    Not exposed to bugs

    HIGHEST_EXPOSURE_LOW2

    Highest exposure is to a low priority bug

    HIGHEST_EXPOSURE_HIGH3

    Highest exposure is to a high priority bug

    Top

    arista/bugexposure.v1/services.gen.proto

    BugExposureRequest

    Field NameTypeDescription
    keyBugExposureKey

    Key uniquely identifies a BugExposure 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.

    BugExposureResponse

    Field NameTypeDescription
    valueBugExposure

    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

    BugExposure instance in this response.

    BugExposureStreamRequest

    Field NameTypeDescription
    partial_eq_filterBugExposure[…]

    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.

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

    * end: Returns the state of each BugExposure at end.

    * Each BugExposure response is fully-specified (all fields set).

    * start: Returns the state of each BugExposure at start, followed by updates until now.

    * Each BugExposure response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each BugExposure at start, followed by updates

    until end.

    * Each BugExposure response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    BugExposureStreamResponse

    Field NameTypeDescription
    valueBugExposure

    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 BugExposure’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    BugExposureService

    Method NameRequest TypeResponse TypeDescription
    GetOneBugExposureRequestBugExposureResponse

    GetAllBugExposureStreamRequestBugExposureStreamResponse stream

    SubscribeBugExposureStreamRequestBugExposureStreamResponse stream

    GetMetaBugExposureStreamRequestMetaResponse

    SubscribeMetaBugExposureStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/changecontrol.v1/index.html b/models/changecontrol.v1/index.html index ad1e6fde..1d191d3a 100644 --- a/models/changecontrol.v1/index.html +++ b/models/changecontrol.v1/index.html @@ -1,7 +1,7 @@ changecontrol.v1 :: Arista Networks FMP APIs -

    changecontrol.v1

    Top

    arista/changecontrol.v1/changecontrol.proto

    Action

    Action is an action to perform during the execution of @@ -38,4 +38,4 @@ plus some information about when and by whom is was set.

    Field NameTypeDescription
    valuegoogle.protobuf.Timestamp

    value is the value of the flag (some timestamp).

    notesgoogle.protobuf.StringValue

    notes are any notes associated with the setting of the flag.

    timegoogle.protobuf.Timestamp

    time is the time at which the flag was last updated.

    usergoogle.protobuf.StringValue

    user is the user by which the flag was last updated.

    TimestampFlagConfig

    TimestampFlagConfig is used to set a flag on a change control that takes a timestamp value (e.g. schedule/unschedule).

    Field NameTypeDescription
    valuegoogle.protobuf.Timestamp

    value is the value of the flag (some timestamp).

    notesgoogle.protobuf.StringValue

    notes are the notes associated with the flag value.

    ChangeControlStatus

    ChangeControlStatus defines the possible execution statuses of a change control.

    NameNumberDescription
    CHANGE_CONTROL_STATUS_UNSPECIFIED0

    CHANGE_CONTROL_STATUS_RUNNING1

    CHANGE_CONTROL_STATUS_RUNNING means the change control has begun

    execution.

    CHANGE_CONTROL_STATUS_COMPLETED2

    CHANGE_CONTROL_STATUS_COMPLETED means the change control has ceased

    execution. Success/failure of a change control cannot be inferred

    from this status alone but rather this status plus the change control

    error. That is, no error implies success and some error implies failure.

    CHANGE_CONTROL_STATUS_SCHEDULED3

    CHANGE_CONTROL_STATUS_SCHEDULED means the change control has been

    scheduled for execution at some time. Any failure that occurs during

    this process will cause a transition back to the unspecified status,

    a reset of the schedule flag by the system, and an error on the change

    control reporting the details of the failure.

    CHANGE_CONTROL_STATUS_NOT_STARTED4

    CHANGE_CONTROL_STATUS_NOT_STARTED means the change control has not been

    started. This would include approved and not approved change controls.

    StageStatus

    StageStatus defines the possible execution statuses of a stage.

    NameNumberDescription
    STAGE_STATUS_UNSPECIFIED0

    STAGE_STATUS_RUNNING1

    STAGE_STATUS_RUNNING means the stage has begun execution.

    STAGE_STATUS_COMPLETED2

    STAGE_STATUS_COMPLETED means the stage has ceased execution.

    Success/failure of a stage cannot be inferred from this status

    alone but rather this status plus the stage error. That is, no

    error implies success and some error implies failure.

    STAGE_STATUS_NOT_STARTED3

    STAGE_STATUS_NOT_STARTED means the stage has not been started.

    Top

    arista/changecontrol.v1/services.gen.proto

    ApproveConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterApproveConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    ApproveConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyChangeControlKey

    This is the key of the ApproveConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    ApproveConfigDeleteRequest

    Field NameTypeDescription
    keyChangeControlKey

    Key indicates which ApproveConfig instance to remove.

    This field must always be set.

    ApproveConfigDeleteResponse

    Field NameTypeDescription
    keyChangeControlKey

    Key echoes back the key of the deleted ApproveConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    ApproveConfigDeleteSomeRequest

    Field NameTypeDescription
    keysChangeControlKey[…]

    key contains a list of ApproveConfig keys to delete

    ApproveConfigDeleteSomeResponse

    ApproveConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyChangeControlKey

    errorstring

    ApproveConfigRequest

    Field NameTypeDescription
    keyChangeControlKey

    Key uniquely identifies a ApproveConfig 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.

    ApproveConfigResponse

    Field NameTypeDescription
    valueApproveConfig

    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

    ApproveConfig instance in this response.

    ApproveConfigSetRequest

    Field NameTypeDescription
    valueApproveConfig

    ApproveConfig carries the value to set into the datastore.

    See the documentation on the ApproveConfig struct for which fields are required.

    ApproveConfigSetResponse

    Field NameTypeDescription
    valueApproveConfig

    Value carries all the values given in the ApproveConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    ApproveConfigSetSomeRequest

    Field NameTypeDescription
    valuesApproveConfig[…]

    value contains a list of ApproveConfig 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.

    ApproveConfigSetSomeResponse

    Field NameTypeDescription
    keyChangeControlKey

    errorstring

    ApproveConfigSomeRequest

    Field NameTypeDescription
    keysChangeControlKey[…]

    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.

    ApproveConfigSomeResponse

    Field NameTypeDescription
    valueApproveConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ApproveConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterApproveConfig[…]

    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.

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

    * end: Returns the state of each ApproveConfig at end.

    * Each ApproveConfig response is fully-specified (all fields set).

    * start: Returns the state of each ApproveConfig at start, followed by updates until now.

    * Each ApproveConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ApproveConfig at start, followed by updates

    until end.

    * Each ApproveConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ApproveConfigStreamResponse

    Field NameTypeDescription
    valueApproveConfig

    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 ApproveConfig’s last modification.

    typearista.subscriptions.Operation

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

    ChangeControlConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterChangeControlConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    ChangeControlConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyChangeControlKey

    This is the key of the ChangeControlConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    ChangeControlConfigDeleteRequest

    Field NameTypeDescription
    keyChangeControlKey

    Key indicates which ChangeControlConfig instance to remove.

    This field must always be set.

    ChangeControlConfigDeleteResponse

    Field NameTypeDescription
    keyChangeControlKey

    Key echoes back the key of the deleted ChangeControlConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    ChangeControlConfigDeleteSomeRequest

    Field NameTypeDescription
    keysChangeControlKey[…]

    key contains a list of ChangeControlConfig keys to delete

    ChangeControlConfigDeleteSomeResponse

    ChangeControlConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyChangeControlKey

    errorstring

    ChangeControlConfigRequest

    Field NameTypeDescription
    keyChangeControlKey

    Key uniquely identifies a ChangeControlConfig 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.

    ChangeControlConfigResponse

    Field NameTypeDescription
    valueChangeControlConfig

    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

    ChangeControlConfig instance in this response.

    ChangeControlConfigSetRequest

    Field NameTypeDescription
    valueChangeControlConfig

    ChangeControlConfig carries the value to set into the datastore.

    See the documentation on the ChangeControlConfig struct for which fields are required.

    ChangeControlConfigSetResponse

    Field NameTypeDescription
    valueChangeControlConfig

    Value carries all the values given in the ChangeControlConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    ChangeControlConfigSetSomeRequest

    Field NameTypeDescription
    valuesChangeControlConfig[…]

    value contains a list of ChangeControlConfig 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.

    ChangeControlConfigSetSomeResponse

    Field NameTypeDescription
    keyChangeControlKey

    errorstring

    ChangeControlConfigSomeRequest

    Field NameTypeDescription
    keysChangeControlKey[…]

    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.

    ChangeControlConfigSomeResponse

    Field NameTypeDescription
    valueChangeControlConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ChangeControlConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterChangeControlConfig[…]

    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.

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

    * end: Returns the state of each ChangeControlConfig at end.

    * Each ChangeControlConfig response is fully-specified (all fields set).

    * start: Returns the state of each ChangeControlConfig at start, followed by updates until now.

    * Each ChangeControlConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ChangeControlConfig at start, followed by updates

    until end.

    * Each ChangeControlConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ChangeControlConfigStreamResponse

    Field NameTypeDescription
    valueChangeControlConfig

    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 ChangeControlConfig’s last modification.

    typearista.subscriptions.Operation

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

    ChangeControlRequest

    Field NameTypeDescription
    keyChangeControlKey

    Key uniquely identifies a ChangeControl 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.

    ChangeControlResponse

    Field NameTypeDescription
    valueChangeControl

    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

    ChangeControl instance in this response.

    ChangeControlSomeRequest

    Field NameTypeDescription
    keysChangeControlKey[…]

    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.

    ChangeControlSomeResponse

    Field NameTypeDescription
    valueChangeControl

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ChangeControlStreamRequest

    Field NameTypeDescription
    partial_eq_filterChangeControl[…]

    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.

    filterFilter

    For each ChangeControl 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 ChangeControl is streamed to the user.

    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.

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

    * end: Returns the state of each ChangeControl at end.

    * Each ChangeControl response is fully-specified (all fields set).

    * start: Returns the state of each ChangeControl at start, followed by updates until now.

    * Each ChangeControl response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ChangeControl at start, followed by updates

    until end.

    * Each ChangeControl response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ChangeControlStreamResponse

    Field NameTypeDescription
    valueChangeControl

    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 ChangeControl’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    ApproveConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneApproveConfigRequestApproveConfigResponse

    GetSomeApproveConfigSomeRequestApproveConfigSomeResponse stream

    GetAllApproveConfigStreamRequestApproveConfigStreamResponse stream

    SubscribeApproveConfigStreamRequestApproveConfigStreamResponse stream

    GetMetaApproveConfigStreamRequestMetaResponse

    SubscribeMetaApproveConfigStreamRequestMetaResponse stream

    SetApproveConfigSetRequestApproveConfigSetResponse

    SetSomeApproveConfigSetSomeRequestApproveConfigSetSomeResponse stream

    DeleteApproveConfigDeleteRequestApproveConfigDeleteResponse

    DeleteSomeApproveConfigDeleteSomeRequestApproveConfigDeleteSomeResponse stream

    DeleteAllApproveConfigDeleteAllRequestApproveConfigDeleteAllResponse stream

    ChangeControlConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneChangeControlConfigRequestChangeControlConfigResponse

    GetSomeChangeControlConfigSomeRequestChangeControlConfigSomeResponse stream

    GetAllChangeControlConfigStreamRequestChangeControlConfigStreamResponse stream

    SubscribeChangeControlConfigStreamRequestChangeControlConfigStreamResponse stream

    GetMetaChangeControlConfigStreamRequestMetaResponse

    SubscribeMetaChangeControlConfigStreamRequestMetaResponse stream

    SetChangeControlConfigSetRequestChangeControlConfigSetResponse

    SetSomeChangeControlConfigSetSomeRequestChangeControlConfigSetSomeResponse stream

    DeleteChangeControlConfigDeleteRequestChangeControlConfigDeleteResponse

    DeleteSomeChangeControlConfigDeleteSomeRequestChangeControlConfigDeleteSomeResponse stream

    DeleteAllChangeControlConfigDeleteAllRequestChangeControlConfigDeleteAllResponse stream

    ChangeControlService

    Method NameRequest TypeResponse TypeDescription
    GetOneChangeControlRequestChangeControlResponse

    GetSomeChangeControlSomeRequestChangeControlSomeResponse stream

    GetAllChangeControlStreamRequestChangeControlStreamResponse stream

    SubscribeChangeControlStreamRequestChangeControlStreamResponse stream

    GetMetaChangeControlStreamRequestMetaResponse

    SubscribeMetaChangeControlStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/configlet.v1/index.html b/models/configlet.v1/index.html index d28bca71..4d8e6ce4 100644 --- a/models/configlet.v1/index.html +++ b/models/configlet.v1/index.html @@ -1,7 +1,7 @@ configlet.v1 :: Arista Networks FMP APIs -

    configlet.v1

    Top

    arista/configlet.v1/configlet.proto

    Configlet

    Configlet is the state of a static configlet in a workspace or mainline. @@ -16,4 +16,4 @@ Devices resolved in child assignments but which do not resolve in that of its parent’s are skipped.

  • Match policy determines how the assignment’s devices get divied up amongst its children.
    • Field NameTypeDescription
    keyConfigletAssignmentKey

    display_namegoogle.protobuf.StringValue

    descriptiongoogle.protobuf.StringValue

    configlet_idsfmp.RepeatedString

    configlet_ids is the list of configlets to be assigned

    querygoogle.protobuf.StringValue

    query is a tag query string that conforms to the CloudVision

    tag query language. E.g., the query, "datacenter:NYC,SFO AND</p><p>sflow:enabled", matches all devices with sflow enabled in

    data centers NYC and SFO.

    malformed queries result in an error

    tags not matching devices are ignored

    removegoogle.protobuf.BoolValue

    remove indicates whether to remove (true) or add (false,

    unset) the tag assignments involving the studio identified

    by the key if the encompassing workspace merges. Other data

    fields are not allowed if this field is set to true.

    match_policyMatchPolicy

    match_policy is the discriminator for the query field

    child_assignment_idsfmp.RepeatedString

    list of child assignments

    ConfigletAssignmentKey

    ConfigletAssignmentKey uniquely identifies a configlet assignment

    Field NameTypeDescription
    workspace_idgoogle.protobuf.StringValue

    workspace_id is the unique identifier of the workspace.

    configlet_assignment_idgoogle.protobuf.StringValue

    configlet_assignment_id is the unique identifier of the configlet_assignment.

    ConfigletConfig

    ConfigletConfig updates a static configlet in a workspace.

    Field NameTypeDescription
    keyConfigletKey

    removegoogle.protobuf.BoolValue

    remove specifies the static configlet is to be removed from the workspace.

    Other data fields are not allowed when this field is set to true.

    display_namegoogle.protobuf.StringValue

    display_name is the display name of the static configlet.

    descriptiongoogle.protobuf.StringValue

    description is the description of the static configlet.

    migrated_fromgoogle.protobuf.StringValue

    migrated_from is populated with the source configlet name when migrated

    from network provisioning to studio.

    bodygoogle.protobuf.StringValue

    body is the static configlet body.

    ConfigletKey

    ConfigletKey uniquely identifies a static configlet.

    Field NameTypeDescription
    workspace_idgoogle.protobuf.StringValue

    workspace_id identifies the workspace within which the static configlet resides

    empty string ("") stands for the “mainline”.

    configlet_idgoogle.protobuf.StringValue

    configlet_id is the static configlet ID.

    Filter

    Filter is used to filter static configlets.

    Field NameTypeDescription
    include_bodygoogle.protobuf.BoolValue

    include_body specifies the static configlet body is to be included.

    MatchPolicy

    MatchPolicy specifies how the tag query of a configlet assignment should be used to resolve devices for its children

    NameNumberDescription
    MATCH_POLICY_UNSPECIFIED0

    MATCH_POLICY_MATCH_FIRST1

    MATCH_POLICY_MATCH_FIRST dictates that matching devices are used only for the first match amongst its children

    MATCH_POLICY_MATCH_ALL2

    MATCH_POLICY_MATCH_ALL dictates that matching devices are used across all children

    Top

    arista/configlet.v1/services.gen.proto

    ConfigletAssignmentConfigDeleteAllRequest

    ConfigletAssignmentConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyConfigletAssignmentKey

    This is the key of the ConfigletAssignmentConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    ConfigletAssignmentConfigDeleteRequest

    Field NameTypeDescription
    keyConfigletAssignmentKey

    Key indicates which ConfigletAssignmentConfig instance to remove.

    This field must always be set.

    ConfigletAssignmentConfigDeleteResponse

    Field NameTypeDescription
    keyConfigletAssignmentKey

    Key echoes back the key of the deleted ConfigletAssignmentConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    ConfigletAssignmentConfigDeleteSomeRequest

    Field NameTypeDescription
    keysConfigletAssignmentKey[…]

    key contains a list of ConfigletAssignmentConfig keys to delete

    ConfigletAssignmentConfigDeleteSomeResponse

    ConfigletAssignmentConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyConfigletAssignmentKey

    errorstring

    ConfigletAssignmentConfigRequest

    Field NameTypeDescription
    keyConfigletAssignmentKey

    Key uniquely identifies a ConfigletAssignmentConfig 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.

    ConfigletAssignmentConfigResponse

    Field NameTypeDescription
    valueConfigletAssignmentConfig

    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

    ConfigletAssignmentConfig instance in this response.

    ConfigletAssignmentConfigSetRequest

    Field NameTypeDescription
    valueConfigletAssignmentConfig

    ConfigletAssignmentConfig carries the value to set into the datastore.

    See the documentation on the ConfigletAssignmentConfig struct for which fields are required.

    ConfigletAssignmentConfigSetResponse

    Field NameTypeDescription
    valueConfigletAssignmentConfig

    Value carries all the values given in the ConfigletAssignmentConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    ConfigletAssignmentConfigSetSomeRequest

    Field NameTypeDescription
    valuesConfigletAssignmentConfig[…]

    value contains a list of ConfigletAssignmentConfig 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.

    ConfigletAssignmentConfigSetSomeResponse

    Field NameTypeDescription
    keyConfigletAssignmentKey

    errorstring

    ConfigletAssignmentConfigSomeRequest

    Field NameTypeDescription
    keysConfigletAssignmentKey[…]

    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.

    ConfigletAssignmentConfigSomeResponse

    Field NameTypeDescription
    valueConfigletAssignmentConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigletAssignmentConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfigletAssignmentConfig[…]

    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.

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

    * end: Returns the state of each ConfigletAssignmentConfig at end.

    * Each ConfigletAssignmentConfig response is fully-specified (all fields set).

    * start: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until now.

    * Each ConfigletAssignmentConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ConfigletAssignmentConfig at start, followed by updates

    until end.

    * Each ConfigletAssignmentConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigletAssignmentConfigStreamResponse

    Field NameTypeDescription
    valueConfigletAssignmentConfig

    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 ConfigletAssignmentConfig’s last modification.

    typearista.subscriptions.Operation

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

    ConfigletAssignmentRequest

    Field NameTypeDescription
    keyConfigletAssignmentKey

    Key uniquely identifies a ConfigletAssignment 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.

    ConfigletAssignmentResponse

    Field NameTypeDescription
    valueConfigletAssignment

    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

    ConfigletAssignment instance in this response.

    ConfigletAssignmentSomeRequest

    Field NameTypeDescription
    keysConfigletAssignmentKey[…]

    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.

    ConfigletAssignmentSomeResponse

    Field NameTypeDescription
    valueConfigletAssignment

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigletAssignmentStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfigletAssignment[…]

    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.

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

    * end: Returns the state of each ConfigletAssignment at end.

    * Each ConfigletAssignment response is fully-specified (all fields set).

    * start: Returns the state of each ConfigletAssignment at start, followed by updates until now.

    * Each ConfigletAssignment response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ConfigletAssignment at start, followed by updates

    until end.

    * Each ConfigletAssignment response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigletAssignmentStreamResponse

    Field NameTypeDescription
    valueConfigletAssignment

    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 ConfigletAssignment’s last modification.

    typearista.subscriptions.Operation

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

    ConfigletConfigDeleteAllRequest

    ConfigletConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyConfigletKey

    This is the key of the ConfigletConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    ConfigletConfigDeleteRequest

    Field NameTypeDescription
    keyConfigletKey

    Key indicates which ConfigletConfig instance to remove.

    This field must always be set.

    ConfigletConfigDeleteResponse

    Field NameTypeDescription
    keyConfigletKey

    Key echoes back the key of the deleted ConfigletConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    ConfigletConfigDeleteSomeRequest

    Field NameTypeDescription
    keysConfigletKey[…]

    key contains a list of ConfigletConfig keys to delete

    ConfigletConfigDeleteSomeResponse

    ConfigletConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyConfigletKey

    errorstring

    ConfigletConfigRequest

    Field NameTypeDescription
    keyConfigletKey

    Key uniquely identifies a ConfigletConfig 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.

    ConfigletConfigResponse

    Field NameTypeDescription
    valueConfigletConfig

    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

    ConfigletConfig instance in this response.

    ConfigletConfigSetRequest

    Field NameTypeDescription
    valueConfigletConfig

    ConfigletConfig carries the value to set into the datastore.

    See the documentation on the ConfigletConfig struct for which fields are required.

    ConfigletConfigSetResponse

    Field NameTypeDescription
    valueConfigletConfig

    Value carries all the values given in the ConfigletConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    ConfigletConfigSetSomeRequest

    Field NameTypeDescription
    valuesConfigletConfig[…]

    value contains a list of ConfigletConfig 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.

    ConfigletConfigSetSomeResponse

    Field NameTypeDescription
    keyConfigletKey

    errorstring

    ConfigletConfigSomeRequest

    Field NameTypeDescription
    keysConfigletKey[…]

    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.

    ConfigletConfigSomeResponse

    Field NameTypeDescription
    valueConfigletConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigletConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfigletConfig[…]

    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.

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

    * end: Returns the state of each ConfigletConfig at end.

    * Each ConfigletConfig response is fully-specified (all fields set).

    * start: Returns the state of each ConfigletConfig at start, followed by updates until now.

    * Each ConfigletConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ConfigletConfig at start, followed by updates

    until end.

    * Each ConfigletConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigletConfigStreamResponse

    Field NameTypeDescription
    valueConfigletConfig

    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 ConfigletConfig’s last modification.

    typearista.subscriptions.Operation

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

    ConfigletRequest

    Field NameTypeDescription
    keyConfigletKey

    Key uniquely identifies a Configlet 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.

    ConfigletResponse

    Field NameTypeDescription
    valueConfiglet

    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

    Configlet instance in this response.

    ConfigletSomeRequest

    Field NameTypeDescription
    keysConfigletKey[…]

    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.

    ConfigletSomeResponse

    Field NameTypeDescription
    valueConfiglet

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigletStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfiglet[…]

    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.

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

    * end: Returns the state of each Configlet at end.

    * Each Configlet response is fully-specified (all fields set).

    * start: Returns the state of each Configlet at start, followed by updates until now.

    * Each Configlet response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Configlet at start, followed by updates

    until end.

    * Each Configlet response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigletStreamResponse

    Field NameTypeDescription
    valueConfiglet

    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 Configlet’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    ConfigletAssignmentConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigletAssignmentConfigRequestConfigletAssignmentConfigResponse

    GetSomeConfigletAssignmentConfigSomeRequestConfigletAssignmentConfigSomeResponse stream

    GetAllConfigletAssignmentConfigStreamRequestConfigletAssignmentConfigStreamResponse stream

    SubscribeConfigletAssignmentConfigStreamRequestConfigletAssignmentConfigStreamResponse stream

    GetMetaConfigletAssignmentConfigStreamRequestMetaResponse

    SubscribeMetaConfigletAssignmentConfigStreamRequestMetaResponse stream

    SetConfigletAssignmentConfigSetRequestConfigletAssignmentConfigSetResponse

    SetSomeConfigletAssignmentConfigSetSomeRequestConfigletAssignmentConfigSetSomeResponse stream

    DeleteConfigletAssignmentConfigDeleteRequestConfigletAssignmentConfigDeleteResponse

    DeleteSomeConfigletAssignmentConfigDeleteSomeRequestConfigletAssignmentConfigDeleteSomeResponse stream

    DeleteAllConfigletAssignmentConfigDeleteAllRequestConfigletAssignmentConfigDeleteAllResponse stream

    ConfigletAssignmentService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigletAssignmentRequestConfigletAssignmentResponse

    GetSomeConfigletAssignmentSomeRequestConfigletAssignmentSomeResponse stream

    GetAllConfigletAssignmentStreamRequestConfigletAssignmentStreamResponse stream

    SubscribeConfigletAssignmentStreamRequestConfigletAssignmentStreamResponse stream

    GetMetaConfigletAssignmentStreamRequestMetaResponse

    SubscribeMetaConfigletAssignmentStreamRequestMetaResponse stream

    ConfigletConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigletConfigRequestConfigletConfigResponse

    GetSomeConfigletConfigSomeRequestConfigletConfigSomeResponse stream

    GetAllConfigletConfigStreamRequestConfigletConfigStreamResponse stream

    SubscribeConfigletConfigStreamRequestConfigletConfigStreamResponse stream

    GetMetaConfigletConfigStreamRequestMetaResponse

    SubscribeMetaConfigletConfigStreamRequestMetaResponse stream

    SetConfigletConfigSetRequestConfigletConfigSetResponse

    SetSomeConfigletConfigSetSomeRequestConfigletConfigSetSomeResponse stream

    DeleteConfigletConfigDeleteRequestConfigletConfigDeleteResponse

    DeleteSomeConfigletConfigDeleteSomeRequestConfigletConfigDeleteSomeResponse stream

    DeleteAllConfigletConfigDeleteAllRequestConfigletConfigDeleteAllResponse stream

    ConfigletService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigletRequestConfigletResponse

    GetSomeConfigletSomeRequestConfigletSomeResponse stream

    GetAllConfigletStreamRequestConfigletStreamResponse stream

    SubscribeConfigletStreamRequestConfigletStreamResponse stream

    GetMetaConfigletStreamRequestMetaResponse

    SubscribeMetaConfigletStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/configstatus.v1/index.html b/models/configstatus.v1/index.html index 5147c637..69fe7813 100644 --- a/models/configstatus.v1/index.html +++ b/models/configstatus.v1/index.html @@ -1,10 +1,10 @@ configstatus.v1 :: Arista Networks FMP APIs -

    configstatus.v1

    Top

    arista/configstatus.v1/configstatus.proto

    ConfigDiff

    Field NameTypeDescription
    keyConfigDiffKey

    Key represents config diff key

    urigoogle.protobuf.StringValue

    Uri represents the HTTP URI client can use to GET config diff and associated errors

    ConfigDiffKey

    ConfigDiffKey uniquely identifies a configuration diff request

    Field NameTypeDescription
    a_device_idgoogle.protobuf.StringValue

    A_device_id is the serial number of the device on A side (left hand side)

    a_typeConfigType

    A_type is the config type on A side (left hand side)

    a_timegoogle.protobuf.Timestamp

    A_time is the time at which to fetch config on A side (left hand side)

    b_device_idgoogle.protobuf.StringValue

    B_device_id is the serial number of the device on B side (right hand side)

    b_typeConfigType

    B_type is the config type on B side (right hand side)

    b_timegoogle.protobuf.Timestamp

    B_time is the time at which to fetch config on B side (right hand side)

    ConfigError

    ConfigError represents errors reported by CVP when handling device configuration

    Field NameTypeDescription
    error_codeErrorCode

    error_msggoogle.protobuf.StringValue

    line_numgoogle.protobuf.Int32Value

    Line_num represents line number, if any

    configlet_namegoogle.protobuf.StringValue

    Configlet_name represents the originating configlet name. Configlet_name

    and line_num point to the line where config warning or config error originate.

    ConfigErrors

    Field NameTypeDescription
    valuesConfigError[…]

    ConfigKey

    ConfigKey uniquely identifies a config request.

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    Device_id is the serial number of the device

    typeConfigType

    Type describes the config type

    ConfigSource

    ConfigSource describes an individual source of the proposed/designed config

    Field NameTypeDescription
    source_typeConfigSourceType

    source_idgoogle.protobuf.StringValue

    source_id identifier to distinguish between multiple instances of the source type

    source_id is :

    configlet name for CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET

    studio id for CONFIG_SOURCE_TYPE_STUDIO

    configlet id for CONFIG_SOURCE_TYPE_STUDIO_STATIC

    ConfigSources

    ConfigSources is the list of sources of the proposed/designed config

    Field NameTypeDescription
    valuesConfigSource[…]

    ConfigSummary

    ConfigSummary represents device configuration summary.

    Field NameTypeDescription
    syncConfigSyncCode

    nop_linesgoogle.protobuf.Int32Value

    Number of lines with code no-operation

    ignored_linesgoogle.protobuf.Int32Value

    Number of lines with code IGNORE

    added_linesgoogle.protobuf.Int32Value

    Number of lines with code ADD

    deleted_linesgoogle.protobuf.Int32Value

    Number of lines with code DELETE

    changed_linesgoogle.protobuf.Int32Value

    Number of lines with code CHANGE

    designed_config_errorsgoogle.protobuf.Int32Value

    Number of designed config errors

    designed_config_warningsgoogle.protobuf.Int32Value

    Number of designed config warnings

    running_config_update_timegoogle.protobuf.Timestamp

    Timestamp at which running config is updated

    designed_config_update_timegoogle.protobuf.Timestamp

    Timestamp at which designed config is updated

    running_config_urigoogle.protobuf.StringValue

    The HTTP URI client can use to GET running config and associated errors

    designed_config_urigoogle.protobuf.StringValue

    The HTTP URI client can use to GET designed config and associated errors

    diff_urigoogle.protobuf.StringValue

    The HTTP URI client can use to GET config diff and associated errors

    digestgoogle.protobuf.StringValue

    Digest (SHA-256) of the config diff.

    Configuration

    Configuration represents device’s CLI configuration

    Field NameTypeDescription
    keyConfigKey

    urigoogle.protobuf.StringValue

    Uri represents the HTTP URI client can use to GET config body and associated errors

    DiffEntries

    DiffEntries indicates potential multiple lines of config diff

    Field NameTypeDescription
    valuesDiffEntry[…]

    DiffEntry

    DiffEntry represents one entry in a Diff

    Field NameTypeDescription
    opDiffOp

    a_line_numgoogle.protobuf.Int32Value

    line number in A this diff applies to

    b_line_numgoogle.protobuf.Int32Value

    line number in B this diff applies to

    b_parent_line_numgoogle.protobuf.Int32Value

    line number of the parent command in B

    a_linegoogle.protobuf.StringValue

    content of config line in A

    b_linegoogle.protobuf.StringValue

    content of config line in B

    a_filter_codeConfigFilterCode

    Config filter code of the line in A

    b_filter_codeConfigFilterCode

    Config filter code of the line in B

    a_parent_line_numgoogle.protobuf.Int32Value

    line number of the parent command in A

    SecurityProfile

    SecurityProfile holds the EOS configuration for the security profile.

    Field NameTypeDescription
    keyConfigKey

    key uniquely identifies the configuration

    configgoogle.protobuf.StringValue

    config describes the security profile config body

    SecurityProfileComplianceSummary

    SecurityProfileComplianceSummary holds the compliance summary for security profile configuration.

    Field NameTypeDescription
    syncConfigSyncCode

    nop_linesgoogle.protobuf.Int32Value

    nop_lines is the number of lines with code no-operation

    ignored_linesgoogle.protobuf.Int32Value

    ignored_lines is the number of lines with code IGNORE

    added_linesgoogle.protobuf.Int32Value

    added_lines is the number of lines with code ADD

    deleted_linesgoogle.protobuf.Int32Value

    deleted_lines is the number of lines with code DELETE

    changed_linesgoogle.protobuf.Int32Value

    changed_lines is the Number of lines with code CHANGE

    digestgoogle.protobuf.StringValue

    digest is the digest (SHA-256 hash) of the security profile configuration diff

    running_config_update_timegoogle.protobuf.Timestamp

    running_config_update_time is the timestamp at which running security profile

    or running config is updated

    designed_config_update_timegoogle.protobuf.Timestamp

    designed_config_update_time is the timestamp at which designed security profile or

    designed config is updated

    SecurityProfileDiff

    SecurityProfileDiff holds the security profile configuration diff.

    Field NameTypeDescription
    keyConfigDiffKey

    key represents security profile config diff key

    diffDiffEntries

    diff represents diff entries

    SecurityProfileDiffSummary

    SecurityProfileDiffSummary holds device compliance summary w.r.t security profile.

    Field NameTypeDescription
    keySummaryKey

    key uniquely identifies the Summary

    summarySecurityProfileComplianceSummary

    summary is the security profile configuration compliance summary

    Summary

    Field NameTypeDescription
    keySummaryKey

    summaryConfigSummary

    SummaryKey

    SummaryKey uniquely identifies a device summary request

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    Device_id is the serial number of the device

    ConfigFilterCode

    ConfigFilterCode indicates if a config line matches PCM filter(s)

    NameNumberDescription
    CONFIG_FILTER_CODE_UNSPECIFIED0

    UNSPECIFIED indicates config line did not match any partial config management (PCM) filter

    CONFIG_FILTER_CODE_MANAGED_LINE1

    MANAGED_LINE indicates config line matches managed PCM filter hence is managed

    CONFIG_FILTER_CODE_UNMANAGED_LINE2

    UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed

    ConfigSourceType

    ConfigSourceType indicates the type of source for the proposed/designed configuration for the device

    NameNumberDescription
    CONFIG_SOURCE_TYPE_UNSPECIFIED0

    CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET1

    CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from

    the network provisioning workflow.

    CONFIG_SOURCE_TYPE_STUDIO2

    CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio

    CONFIG_SOURCE_TYPE_STUDIO_STATIC3

    SCONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework

    ConfigSyncCode

    ConfigSyncCode indicates config synchronization status

    NameNumberDescription
    CONFIG_SYNC_CODE_UNSPECIFIED0

    CONFIG_SYNC_CODE_IN_SYNC1

    IN_SYNC indicates designed config and running config are identical

    CONFIG_SYNC_CODE_OUT_OF_SYNC2

    OUT_OF_SYNC indicates designed config and running config are not identical

    ConfigType

    NameNumberDescription
    CONFIG_TYPE_UNSPECIFIED0

    CONFIG_TYPE_RUNNING_CONFIG1

    CONFIG_TYPE_DESIGNED_CONFIG2

    DiffOp

    DiffOp is the operation to a line from one side of diff to get to another

    NameNumberDescription
    DIFF_OP_UNSPECIFIED0

    DIFF_OP_NOP1

    NOP indicates no change. A and B are identical at this line

    DIFF_OP_IGNORE2

    IGNORE indicates a line that’s ignored in either A or B.

    One of a_line_num or b_line_num will be -1

    DIFF_OP_ADD3

    ADD is an addition of a line from A

    DIFF_OP_DELETE4

    DELETE is deletion of a line from B

    DIFF_OP_CHANGE5

    CHANGE is a modification to a line in A

    ErrorCode

    ErrorCode indicates warnings and errors produced during computing config

    NameNumberDescription
    ERROR_CODE_UNSPECIFIED0

    ERROR_CODE_DEVICE_WARNING1

    DEVICE_WARNING indicates device warning

    ERROR_CODE_DEVICE_ERROR2

    DEVICE_ERROR indicates device error

    ERROR_CODE_UNREACHABLE_DEVICE3

    UNREACHABLE_DEVICE indicates the device cannot be reached

    ERROR_CODE_CONFIG_FILTER_ERROR4

    CONFIG_FILTER_ERROR indicates error from partial config management filters

    ERROR_CODE_INTERNAL5

    INTERNAL indicates internal errors

    Top

    arista/configstatus.v1/services.gen.proto

    ConfigDiffRequest

    Field NameTypeDescription
    keyConfigDiffKey

    Key uniquely identifies a ConfigDiff 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.

    ConfigDiffResponse

    Field NameTypeDescription
    valueConfigDiff

    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

    ConfigDiff instance in this response.

    ConfigDiffSomeRequest

    Field NameTypeDescription
    keysConfigDiffKey[…]

    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.

    ConfigDiffSomeResponse

    Field NameTypeDescription
    valueConfigDiff

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigDiffStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfigDiff[…]

    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.

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

    * end: Returns the state of each ConfigDiff at end.

    * Each ConfigDiff response is fully-specified (all fields set).

    * start: Returns the state of each ConfigDiff at start, followed by updates until now.

    * Each ConfigDiff response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ConfigDiff at start, followed by updates

    until end.

    * Each ConfigDiff response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigDiffStreamResponse

    Field NameTypeDescription
    valueConfigDiff

    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 ConfigDiff’s last modification.

    typearista.subscriptions.Operation

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

    ConfigurationRequest

    Field NameTypeDescription
    keyConfigKey

    Key uniquely identifies a Configuration 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.

    ConfigurationResponse

    Field NameTypeDescription
    valueConfiguration

    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

    Configuration instance in this response.

    ConfigurationSomeRequest

    Field NameTypeDescription
    keysConfigKey[…]

    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.

    ConfigurationSomeResponse

    Field NameTypeDescription
    valueConfiguration

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ConfigurationStreamRequest

    Field NameTypeDescription
    partial_eq_filterConfiguration[…]

    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.

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

    * end: Returns the state of each Configuration at end.

    * Each Configuration response is fully-specified (all fields set).

    * start: Returns the state of each Configuration at start, followed by updates until now.

    * Each Configuration response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Configuration at start, followed by updates

    until end.

    * Each Configuration response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ConfigurationStreamResponse

    Field NameTypeDescription
    valueConfiguration

    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 Configuration’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    SecurityProfileDiffRequest

    Field NameTypeDescription
    keyConfigDiffKey

    Key uniquely identifies a SecurityProfileDiff 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.

    SecurityProfileDiffResponse

    Field NameTypeDescription
    valueSecurityProfileDiff

    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

    SecurityProfileDiff instance in this response.

    SecurityProfileDiffSomeRequest

    Field NameTypeDescription
    keysConfigDiffKey[…]

    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.

    SecurityProfileDiffSomeResponse

    Field NameTypeDescription
    valueSecurityProfileDiff

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SecurityProfileDiffStreamRequest

    Field NameTypeDescription
    partial_eq_filterSecurityProfileDiff[…]

    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.

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

    * end: Returns the state of each SecurityProfileDiff at end.

    * Each SecurityProfileDiff response is fully-specified (all fields set).

    * start: Returns the state of each SecurityProfileDiff at start, followed by updates until now.

    * Each SecurityProfileDiff response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each SecurityProfileDiff at start, followed by updates

    until end.

    * Each SecurityProfileDiff response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SecurityProfileDiffStreamResponse

    Field NameTypeDescription
    valueSecurityProfileDiff

    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 SecurityProfileDiff’s last modification.

    typearista.subscriptions.Operation

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

    SecurityProfileDiffSummaryRequest

    Field NameTypeDescription
    keySummaryKey

    Key uniquely identifies a SecurityProfileDiffSummary 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.

    SecurityProfileDiffSummaryResponse

    Field NameTypeDescription
    valueSecurityProfileDiffSummary

    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

    SecurityProfileDiffSummary instance in this response.

    SecurityProfileDiffSummarySomeRequest

    Field NameTypeDescription
    keysSummaryKey[…]

    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.

    SecurityProfileDiffSummarySomeResponse

    Field NameTypeDescription
    valueSecurityProfileDiffSummary

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SecurityProfileDiffSummaryStreamRequest

    Field NameTypeDescription
    partial_eq_filterSecurityProfileDiffSummary[…]

    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.

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

    * end: Returns the state of each SecurityProfileDiffSummary at end.

    * Each SecurityProfileDiffSummary response is fully-specified (all fields set).

    * start: Returns the state of each SecurityProfileDiffSummary at start, followed by updates until now.

    * Each SecurityProfileDiffSummary response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each SecurityProfileDiffSummary at start, followed by updates

    until end.

    * Each SecurityProfileDiffSummary response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SecurityProfileDiffSummaryStreamResponse

    Field NameTypeDescription
    valueSecurityProfileDiffSummary

    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 SecurityProfileDiffSummary’s last modification.

    typearista.subscriptions.Operation

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

    SecurityProfileRequest

    Field NameTypeDescription
    keyConfigKey

    Key uniquely identifies a SecurityProfile 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.

    SecurityProfileResponse

    Field NameTypeDescription
    valueSecurityProfile

    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

    SecurityProfile instance in this response.

    SecurityProfileSomeRequest

    Field NameTypeDescription
    keysConfigKey[…]

    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.

    SecurityProfileSomeResponse

    Field NameTypeDescription
    valueSecurityProfile

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SecurityProfileStreamRequest

    Field NameTypeDescription
    partial_eq_filterSecurityProfile[…]

    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.

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

    * end: Returns the state of each SecurityProfile at end.

    * Each SecurityProfile response is fully-specified (all fields set).

    * start: Returns the state of each SecurityProfile at start, followed by updates until now.

    * Each SecurityProfile response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each SecurityProfile at start, followed by updates

    until end.

    * Each SecurityProfile response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SecurityProfileStreamResponse

    Field NameTypeDescription
    valueSecurityProfile

    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 SecurityProfile’s last modification.

    typearista.subscriptions.Operation

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

    SummaryRequest

    Field NameTypeDescription
    keySummaryKey

    Key uniquely identifies a Summary 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.

    SummaryResponse

    Field NameTypeDescription
    valueSummary

    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

    Summary instance in this response.

    SummarySomeRequest

    Field NameTypeDescription
    keysSummaryKey[…]

    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.

    SummarySomeResponse

    Field NameTypeDescription
    valueSummary

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SummaryStreamRequest

    Field NameTypeDescription
    partial_eq_filterSummary[…]

    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.

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

    * end: Returns the state of each Summary at end.

    * Each Summary response is fully-specified (all fields set).

    * start: Returns the state of each Summary at start, followed by updates until now.

    * Each Summary response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Summary at start, followed by updates

    until end.

    * Each Summary response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SummaryStreamResponse

    Field NameTypeDescription
    valueSummary

    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 Summary’s last modification.

    typearista.subscriptions.Operation

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

    ConfigDiffService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigDiffRequestConfigDiffResponse

    GetSomeConfigDiffSomeRequestConfigDiffSomeResponse stream

    GetAllConfigDiffStreamRequestConfigDiffStreamResponse stream

    SubscribeConfigDiffStreamRequestConfigDiffStreamResponse stream

    GetMetaConfigDiffStreamRequestMetaResponse

    SubscribeMetaConfigDiffStreamRequestMetaResponse stream

    ConfigurationService

    Method NameRequest TypeResponse TypeDescription
    GetOneConfigurationRequestConfigurationResponse

    GetSomeConfigurationSomeRequestConfigurationSomeResponse stream

    GetAllConfigurationStreamRequestConfigurationStreamResponse stream

    SubscribeConfigurationStreamRequestConfigurationStreamResponse stream

    GetMetaConfigurationStreamRequestMetaResponse

    SubscribeMetaConfigurationStreamRequestMetaResponse stream

    SecurityProfileDiffService

    Method NameRequest TypeResponse TypeDescription
    GetOneSecurityProfileDiffRequestSecurityProfileDiffResponse

    GetSomeSecurityProfileDiffSomeRequestSecurityProfileDiffSomeResponse stream

    GetAllSecurityProfileDiffStreamRequestSecurityProfileDiffStreamResponse stream

    SubscribeSecurityProfileDiffStreamRequestSecurityProfileDiffStreamResponse stream

    GetMetaSecurityProfileDiffStreamRequestMetaResponse

    SubscribeMetaSecurityProfileDiffStreamRequestMetaResponse stream

    SecurityProfileDiffSummaryService

    Method NameRequest TypeResponse TypeDescription
    GetOneSecurityProfileDiffSummaryRequestSecurityProfileDiffSummaryResponse

    GetSomeSecurityProfileDiffSummarySomeRequestSecurityProfileDiffSummarySomeResponse stream

    GetAllSecurityProfileDiffSummaryStreamRequestSecurityProfileDiffSummaryStreamResponse stream

    SubscribeSecurityProfileDiffSummaryStreamRequestSecurityProfileDiffSummaryStreamResponse stream

    GetMetaSecurityProfileDiffSummaryStreamRequestMetaResponse

    SubscribeMetaSecurityProfileDiffSummaryStreamRequestMetaResponse stream

    SecurityProfileService

    Method NameRequest TypeResponse TypeDescription
    GetOneSecurityProfileRequestSecurityProfileResponse

    GetSomeSecurityProfileSomeRequestSecurityProfileSomeResponse stream

    GetAllSecurityProfileStreamRequestSecurityProfileStreamResponse stream

    SubscribeSecurityProfileStreamRequestSecurityProfileStreamResponse stream

    GetMetaSecurityProfileStreamRequestMetaResponse

    SubscribeMetaSecurityProfileStreamRequestMetaResponse stream

    SummaryService

    Method NameRequest TypeResponse TypeDescription
    GetOneSummaryRequestSummaryResponse

    GetSomeSummarySomeRequestSummarySomeResponse stream

    GetAllSummaryStreamRequestSummaryStreamResponse stream

    SubscribeSummaryStreamRequestSummaryStreamResponse stream

    GetMetaSummaryStreamRequestMetaResponse

    SubscribeMetaSummaryStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/connectivitymonitor.v1/index.html b/models/connectivitymonitor.v1/index.html index 3b1af84c..a17b6502 100644 --- a/models/connectivitymonitor.v1/index.html +++ b/models/connectivitymonitor.v1/index.html @@ -1,11 +1,11 @@ connectivitymonitor.v1 :: Arista Networks FMP APIs -

    connectivitymonitor.v1

    Top

    arista/connectivitymonitor.v1/connectivitymonitor.proto

    Probe

    Probe is identifying information of a connectivity monitor probe. It is used to retrieve probe information without getting the corresponding stats so that probe information can be displayed without streaming all related data, such as in the UI.

    Field NameTypeDescription
    keyProbeKey

    key uniquely identifies the connectivity monitor probe.

    ip_addrgoogle.protobuf.StringValue

    ip_addr is the IP Address of the probe.

    host_namegoogle.protobuf.StringValue

    host_name is the name of the host of the probe.

    descriptiongoogle.protobuf.StringValue

    description is the description of the probe.

    ProbeKey

    ProbeKey uniquely identifies a connectivity monitor probe.

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    device_id is the id of the device in the probe.

    hostgoogle.protobuf.StringValue

    host is the hostname used in the probe.

    vrfgoogle.protobuf.StringValue

    vrf is the name of the VRF in the probe.

    ProbeStats

    ProbeStats is the connectivity monitor statistics related to the specified probe.

    Field NameTypeDescription
    keyProbeStatsKey

    key uniquely identifies the connectivity monitor probe.

    latency_millisgoogle.protobuf.DoubleValue

    latency_millis is the latency between the device interface and the host.

    Value is in milliseconds.

    jitter_millisgoogle.protobuf.DoubleValue

    jitter_millis is the amount of jitter experienced by requests

    between the device interface and host.

    Value is in milliseconds.

    http_response_time_millisgoogle.protobuf.DoubleValue

    http_response_time_millis is the amount of time taken to respond to a http

    request between the device interface and the host.

    Value is in milliseconds.

    packet_loss_percentgoogle.protobuf.Int64Value

    packet_loss_percent is the amount of packet loss experienced

    by requests between the device interface and host.

    Value is a percentage.

    errorgoogle.protobuf.StringValue

    error is the error reported on the connection.

    ProbeStatsKey

    ProbeStatsKey uniquely identifies a connectivity monitor probe’s statistics, per source interface.

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    device_id is the id of the device in the probe.

    hostgoogle.protobuf.StringValue

    host is the hostname used in the probe.

    vrfgoogle.protobuf.StringValue

    vrf is the name of the VRF in the probe.

    source_intfgoogle.protobuf.StringValue

    source_intf is the name of the interface in the probe.

    Top

    arista/connectivitymonitor.v1/services.gen.proto

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    ProbeRequest

    Field NameTypeDescription
    keyProbeKey

    Key uniquely identifies a Probe 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.

    ProbeResponse

    Field NameTypeDescription
    valueProbe

    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

    Probe instance in this response.

    ProbeSomeRequest

    Field NameTypeDescription
    keysProbeKey[…]

    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.

    ProbeSomeResponse

    Field NameTypeDescription
    valueProbe

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ProbeStatsRequest

    Field NameTypeDescription
    keyProbeStatsKey

    Key uniquely identifies a ProbeStats 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.

    ProbeStatsResponse

    Field NameTypeDescription
    valueProbeStats

    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

    ProbeStats instance in this response.

    ProbeStatsSomeRequest

    Field NameTypeDescription
    keysProbeStatsKey[…]

    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.

    ProbeStatsSomeResponse

    Field NameTypeDescription
    valueProbeStats

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    ProbeStatsStreamRequest

    Field NameTypeDescription
    partial_eq_filterProbeStats[…]

    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.

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

    * end: Returns the state of each ProbeStats at end.

    * Each ProbeStats response is fully-specified (all fields set).

    * start: Returns the state of each ProbeStats at start, followed by updates until now.

    * Each ProbeStats response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each ProbeStats at start, followed by updates

    until end.

    * Each ProbeStats response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ProbeStatsStreamResponse

    Field NameTypeDescription
    valueProbeStats

    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 ProbeStats’s last modification.

    typearista.subscriptions.Operation

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

    ProbeStreamRequest

    Field NameTypeDescription
    partial_eq_filterProbe[…]

    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.

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

    * end: Returns the state of each Probe at end.

    * Each Probe response is fully-specified (all fields set).

    * start: Returns the state of each Probe at start, followed by updates until now.

    * Each Probe response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Probe at start, followed by updates

    until end.

    * Each Probe response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    ProbeStreamResponse

    Field NameTypeDescription
    valueProbe

    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 Probe’s last modification.

    typearista.subscriptions.Operation

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

    ProbeService

    Method NameRequest TypeResponse TypeDescription
    GetOneProbeRequestProbeResponse

    GetSomeProbeSomeRequestProbeSomeResponse stream

    GetAllProbeStreamRequestProbeStreamResponse stream

    SubscribeProbeStreamRequestProbeStreamResponse stream

    GetMetaProbeStreamRequestMetaResponse

    SubscribeMetaProbeStreamRequestMetaResponse stream

    ProbeStatsService

    Method NameRequest TypeResponse TypeDescription
    GetOneProbeStatsRequestProbeStatsResponse

    GetSomeProbeStatsSomeRequestProbeStatsSomeResponse stream

    GetAllProbeStatsStreamRequestProbeStatsStreamResponse stream

    SubscribeProbeStatsStreamRequestProbeStatsStreamResponse stream

    GetMetaProbeStatsStreamRequestMetaResponse

    SubscribeMetaProbeStatsStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/dashboard.v1/index.html b/models/dashboard.v1/index.html index 8b6ea414..d8609599 100644 --- a/models/dashboard.v1/index.html +++ b/models/dashboard.v1/index.html @@ -1,10 +1,10 @@ dashboard.v1 :: Arista Networks FMP APIs -

    dashboard.v1

    Top

    arista/dashboard.v1/dashboard.proto

    Dashboard

    Dashboard state contains all dashboard data.

    Field NameTypeDescription
    keyDashboardKey

    key is the unique identifier. It will always be defined.

    created_atgoogle.protobuf.Timestamp

    created_at represents the date the dashboard was first created.

    Old dashboards may not have this field set.

    created_bygoogle.protobuf.StringValue

    created_by keeps the name of the user who first created this dashboard.

    Old dashboards may not have this field set.

    last_modified_atgoogle.protobuf.Timestamp

    last_modified_at holds the timestamp this dashboard was last updated by an user.

    Old dashboards may not have this field set.

    last_modified_bygoogle.protobuf.StringValue

    last_modified_by holds the username who last updated this dashboard.

    Old dashboards may not have this field set.

    meta_dataDashboardMetadata

    meta_data includes version metadata about the dashboard.

    namegoogle.protobuf.StringValue

    name is the dashboard name, displayed at the top of the dashboard.

    descriptiongoogle.protobuf.StringValue

    description may include details about what is displayed in the dashboard.

    widgetsWidgets

    widgets list of widgets in the dashboard.

    DashboardConfig

    DashboardConfig includes all user-editable dashboard fields.

    Field NameTypeDescription
    keyDashboardKey

    key is the unique identifier. It always must be defined.

    If set, will create or update a dashboard.

    namegoogle.protobuf.StringValue

    name is the dashboard name, displayed at the top of the dashboard.

    descriptiongoogle.protobuf.StringValue

    description may include details about what is displayed in the dashboard.

    widgetsWidgets

    widgets list of widgets in the dashboard.

    DashboardKey

    DashboardKey represents the dashboard unique identifier.

    Field NameTypeDescription
    dashboard_idgoogle.protobuf.StringValue

    dashboard_id holds the id of the dashboard

    DashboardMetadata

    DashboardMetadata includes versioning metadata. All the data here is managed internally, and is read-only.

    Field NameTypeDescription
    schema_versiongoogle.protobuf.StringValue

    schema_version is managed internally.

    legacy_keygoogle.protobuf.StringValue

    legacy_key holds the key of a previous version of the dashboard, in case it was migrated.

    legacy_versiongoogle.protobuf.StringValue

    legacy_version tells from which version the dashboard was migrated from.

    from_packagegoogle.protobuf.StringValue

    from_package records the contributing package key and version, if applicable.

    Dimensions

    Dimensions represents the dimensions in cells of the widgets in the UI.

    Field NameTypeDescription
    widthgoogle.protobuf.UInt32Value

    width of the widget in the UI, represented in number of cells.

    heightgoogle.protobuf.UInt32Value

    height of the widget in the UI, represented in number of cells.

    Filter

    Filter is used to filter dashboards for non exact match cases.

    Field NameTypeDescription
    tagsfmp.RepeatedString

    tags includes the values to be matched in the dashboard description.

    Tags are matched by word. Generally, a tag is prefixed by a ‘#’,

    which must be omitted when provided here.

    All provided tags must match inside a dashboard for it to be returned.

    E.g., to match “#devices”, the tag should be set to “devices”.

    GlobalDashboardConfig

    GlobalDashboardConfig holds global configs related to Dashboards.

    Field NameTypeDescription
    default_dashboardDashboardKey

    default_dashboard is the default dashboard shown to a user.

    To unset, use an empty key ({dashboard_id: nil}) in a Set() call.

    Position

    Position represents a cell position in the UI.

    Field NameTypeDescription
    xgoogle.protobuf.UInt32Value

    x represents a position in the horizontal axis.

    ygoogle.protobuf.UInt32Value

    y represents a position in the vertical axis.

    Widget

    Widget is used to create a dashboard. Each widget is responsible to display some type of data.

    Field NameTypeDescription
    idgoogle.protobuf.StringValue

    id holds the unique identifier for the widget inside a dashboard

    namegoogle.protobuf.StringValue

    name of the widget is displayed at the top of the widget.

    positionPosition

    position of the widget, represented as a (x,y) coordinate in a grid.

    Top left is at (0,0).

    dimensionsDimensions

    dimensions of the widget represents how many cell in the grid it takes.

    typegoogle.protobuf.StringValue

    type is the widget type. Each type is handled differently in the UI,

    and can use different inputs.

    inputsgoogle.protobuf.StringValue

    inputs contains metadata about the data the widget will display, encoded in a JSON string.

    Internal data vary based on the widget type type and is managed by the client.

    locationgoogle.protobuf.StringValue

    location is used as a position display hint, used and managed by the UI.

    stylesWidgetStyles

    styles represents the widget’s panel appearance.

    parentgoogle.protobuf.StringValue

    parent stores the id of its parent widget.

    WidgetStyles

    WidgetStyles represents the widget’s panel appearance.

    Field NameTypeDescription
    hide_titlegoogle.protobuf.BoolValue

    hide_title is used to hint the dashboard that the widget title must be hidden.

    background_colorgoogle.protobuf.StringValue

    background_color is used to set the widget’s background color.

    hide_horizontal_bargoogle.protobuf.BoolValue

    hide_horizontal_bar is used to hint the dashboard that the title separator must be hidden.

    title_sizegoogle.protobuf.UInt32Value

    title_size is used to set widget’s title size.

    Widgets

    Widgets holds a list of Widgets.

    Field NameTypeDescription
    valuesWidget[…]

    values holds a list of widgets

    Top

    arista/dashboard.v1/services.gen.proto

    DashboardConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterDashboardConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    DashboardConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyDashboardKey

    This is the key of the DashboardConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    DashboardConfigDeleteRequest

    Field NameTypeDescription
    keyDashboardKey

    Key indicates which DashboardConfig instance to remove.

    This field must always be set.

    DashboardConfigDeleteResponse

    Field NameTypeDescription
    keyDashboardKey

    Key echoes back the key of the deleted DashboardConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    DashboardConfigDeleteSomeRequest

    Field NameTypeDescription
    keysDashboardKey[…]

    key contains a list of DashboardConfig keys to delete

    DashboardConfigDeleteSomeResponse

    DashboardConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyDashboardKey

    errorstring

    DashboardConfigRequest

    Field NameTypeDescription
    keyDashboardKey

    Key uniquely identifies a DashboardConfig 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.

    DashboardConfigResponse

    Field NameTypeDescription
    valueDashboardConfig

    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

    DashboardConfig instance in this response.

    DashboardConfigSetRequest

    Field NameTypeDescription
    valueDashboardConfig

    DashboardConfig carries the value to set into the datastore.

    See the documentation on the DashboardConfig struct for which fields are required.

    DashboardConfigSetResponse

    Field NameTypeDescription
    valueDashboardConfig

    Value carries all the values given in the DashboardConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    DashboardConfigSetSomeRequest

    Field NameTypeDescription
    valuesDashboardConfig[…]

    value contains a list of DashboardConfig 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.

    DashboardConfigSetSomeResponse

    Field NameTypeDescription
    keyDashboardKey

    errorstring

    DashboardConfigSomeRequest

    Field NameTypeDescription
    keysDashboardKey[…]

    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.

    DashboardConfigSomeResponse

    Field NameTypeDescription
    valueDashboardConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    DashboardConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterDashboardConfig[…]

    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.

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

    * end: Returns the state of each DashboardConfig at end.

    * Each DashboardConfig response is fully-specified (all fields set).

    * start: Returns the state of each DashboardConfig at start, followed by updates until now.

    * Each DashboardConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each DashboardConfig at start, followed by updates

    until end.

    * Each DashboardConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    DashboardConfigStreamResponse

    Field NameTypeDescription
    valueDashboardConfig

    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 DashboardConfig’s last modification.

    typearista.subscriptions.Operation

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

    DashboardRequest

    Field NameTypeDescription
    keyDashboardKey

    Key uniquely identifies a Dashboard 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.

    DashboardResponse

    Field NameTypeDescription
    valueDashboard

    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

    Dashboard instance in this response.

    DashboardSomeRequest

    Field NameTypeDescription
    keysDashboardKey[…]

    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.

    DashboardSomeResponse

    Field NameTypeDescription
    valueDashboard

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    DashboardStreamRequest

    Field NameTypeDescription
    partial_eq_filterDashboard[…]

    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.

    filterFilter[…]

    For each Dashboard 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 Dashboard is streamed to the user.

    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.

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

    * end: Returns the state of each Dashboard at end.

    * Each Dashboard response is fully-specified (all fields set).

    * start: Returns the state of each Dashboard at start, followed by updates until now.

    * Each Dashboard response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Dashboard at start, followed by updates

    until end.

    * Each Dashboard response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    DashboardStreamResponse

    Field NameTypeDescription
    valueDashboard

    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 Dashboard’s last modification.

    typearista.subscriptions.Operation

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

    GlobalDashboardConfigRequest

    Field NameTypeDescription
    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.

    GlobalDashboardConfigResponse

    Field NameTypeDescription
    valueGlobalDashboardConfig

    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

    GlobalDashboardConfig instance in this response.

    GlobalDashboardConfigSetRequest

    Field NameTypeDescription
    valueGlobalDashboardConfig

    GlobalDashboardConfig carries the value to set into the datastore.

    See the documentation on the GlobalDashboardConfig struct for which fields are required.

    GlobalDashboardConfigSetResponse

    Field NameTypeDescription
    valueGlobalDashboardConfig

    Value carries all the values given in the GlobalDashboardConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    GlobalDashboardConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterGlobalDashboardConfig[…]

    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.

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

    * end: Returns the state of each GlobalDashboardConfig at end.

    * Each GlobalDashboardConfig response is fully-specified (all fields set).

    * start: Returns the state of each GlobalDashboardConfig at start, followed by updates until now.

    * Each GlobalDashboardConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each GlobalDashboardConfig at start, followed by updates

    until end.

    * Each GlobalDashboardConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    GlobalDashboardConfigStreamResponse

    Field NameTypeDescription
    valueGlobalDashboardConfig

    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 GlobalDashboardConfig’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    DashboardConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneDashboardConfigRequestDashboardConfigResponse

    GetSomeDashboardConfigSomeRequestDashboardConfigSomeResponse stream

    GetAllDashboardConfigStreamRequestDashboardConfigStreamResponse stream

    SubscribeDashboardConfigStreamRequestDashboardConfigStreamResponse stream

    GetMetaDashboardConfigStreamRequestMetaResponse

    SubscribeMetaDashboardConfigStreamRequestMetaResponse stream

    SetDashboardConfigSetRequestDashboardConfigSetResponse

    SetSomeDashboardConfigSetSomeRequestDashboardConfigSetSomeResponse stream

    DeleteDashboardConfigDeleteRequestDashboardConfigDeleteResponse

    DeleteSomeDashboardConfigDeleteSomeRequestDashboardConfigDeleteSomeResponse stream

    DeleteAllDashboardConfigDeleteAllRequestDashboardConfigDeleteAllResponse stream

    DashboardService

    Method NameRequest TypeResponse TypeDescription
    GetOneDashboardRequestDashboardResponse

    GetSomeDashboardSomeRequestDashboardSomeResponse stream

    GetAllDashboardStreamRequestDashboardStreamResponse stream

    SubscribeDashboardStreamRequestDashboardStreamResponse stream

    GetMetaDashboardStreamRequestMetaResponse

    SubscribeMetaDashboardStreamRequestMetaResponse stream

    GlobalDashboardConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneGlobalDashboardConfigRequestGlobalDashboardConfigResponse

    GetAllGlobalDashboardConfigStreamRequestGlobalDashboardConfigStreamResponse stream

    SubscribeGlobalDashboardConfigStreamRequestGlobalDashboardConfigStreamResponse stream

    SubscribeMetaGlobalDashboardConfigStreamRequestMetaResponse stream

    SetGlobalDashboardConfigSetRequestGlobalDashboardConfigSetResponse

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/endpointlocation.v1/index.html b/models/endpointlocation.v1/index.html index b606c6f8..b35dae13 100644 --- a/models/endpointlocation.v1/index.html +++ b/models/endpointlocation.v1/index.html @@ -1,7 +1,7 @@ endpointlocation.v1 :: Arista Networks FMP APIs -

    endpointlocation.v1

    Top

    arista/endpointlocation.v1/endpointlocation.proto

    Device

    Device holds information for a device matching a search term.

    Field NameTypeDescription
    identifier_listIdentifierList

    identifier_list holds the unique identifiers for the device.

    device_typeDeviceType

    device_type is the broad category of the device.

    location_listLocationList

    location_list is the list of possible locations of the device.

    It is ordered from most likely to least likely.

    device_statusDeviceStatus

    device_status is the network status of the device.

    device_infoDeviceInfo

    device_info holds various attributes of the device.

    DeviceInfo

    DeviceInfo holds various attributes of a device (typically an endpoint) from Fingerbank.

    Field NameTypeDescription
    device_namegoogle.protobuf.StringValue

    device_name is the name of the device.

    mobilegoogle.protobuf.BoolValue

    mobile indicates whether the device is a mobile.

    tabletgoogle.protobuf.BoolValue

    tablet indicates whether the device is a tablet.

    scoregoogle.protobuf.UInt32Value

    score is a value from 0 to 100 that indicates how confident we are

    that the device has device_name.

    Fingerbank API documentation of score: https://api.fingerbank.org/api_doc/2/combinations.html

    versiongoogle.protobuf.StringValue

    version is the version of device_name.

    mac_vendorgoogle.protobuf.StringValue

    mac_vendor is the enterprise that assigns the MAC address of the device.

    classificationgoogle.protobuf.StringValue

    classification is the broadest category to which device_name belongs.

    This is the highest level in hierarchy.

    hierarchyfmp.RepeatedString

    hierarchy is a list of categorizations of the device from most broad

    to most specific. The first element is always classification and the

    last element is always device_name.

    For example,

    [“VoIP Device”, “FooInc VoIP”, “FooInc PhoneSet IP”, “FooInc PhoneSet IP Model123”]

    In this hierarchy, “VoIP Device” is classification and “FooInc PhoneSet IP Model123”

    is device_name.

    DeviceMap

    DeviceMap is a collection of Device.

    Field NameTypeDescription
    valuesDeviceMap.ValuesEntry[…]

    values is a map from most specific identifier to Device.

    The key could be device serial number or MAC address.

    DeviceMap.ValuesEntry

    Field NameTypeDescription
    keystring

    valueDevice

    EndpointLocation

    EndpointLocation is the entrypoint to searching for @@ -11,4 +11,4 @@ Some explanations apply to queried endpoints while others apply to queried devices in the CloudVision device inventory.

    NameNumberDescription
    EXPLANATION_UNSPECIFIED0

    EXPLANATION_UNSPECIFIED is the default unspecified explanation.

    EXPLANATION_DIRECT_CONNECTION1

    EXPLANATION_DIRECT_CONNECTION indicates a direct connection to the queried

    endpoint device discovered via LLDP.

    EXPLANATION_NON_INVENTORY_CONNECTION2

    EXPLANATION_NON_INVENTORY_CONNECTION indicates a direct connection to at least

    one non-inventory device (likely discovered via LLDP).

    EXPLANATION_NO_CONNECTION3

    EXPLANATION_NO_CONNECTION indicates that a location has no direct connection to

    any known device.

    EXPLANATION_INVENTORY_CONNECTION4

    EXPLANATION_INVENTORY_CONNECTION indicates that all of a location’s known connections

    are to devices in the inventory.

    EXPLANATION_OWN_PORT_INVENTORY_DEVICE5

    EXPLANATION_OWN_PORT_INVENTORY_DEVICE indicates a location on the queried inventory

    device itself.

    EXPLANATION_DIRECT_CONNECTION_INVENTORY_DEVICE6

    EXPLANATION_DIRECT_CONNECTION_INVENTORY_DEVICE indicates a direct connection to the

    queried inventory device discovered via LLDP.

    EXPLANATION_NO_CONNECTION_INVENTORY_DEVICE7

    EXPLANATION_NO_CONNECTION_INVENTORY_DEVICE indicates that a location has no direct

    connection to any known device (for queried inventory devices).

    EXPLANATION_OTHER_CONNECTION_INVENTORY_DEVICE8

    EXPLANATION_OTHER_CONNECTION_INVENTORY_DEVICE indicates that a location only has

    connections to other devices besides the queried inventory device.

    EXPLANATION_VIRTUAL9

    EXPLANATION_VIRTUAL indicates that a location contains a virtual interface.

    EXPLANATION_WIRELESS_CONNECTION10

    EXPLANATION_WIRELESS_CONNECTION indicates a direct connection from a wireless access

    point in the device inventory to a wireless client.

    EXPLANATION_ACCESS_PORT11

    EXPLANATION_ACCESS_PORT indicates that a location is an access port.

    IdentifierSource

    IdentifierSource defines the set of network protocols and other information sources where an identifier was found.

    NameNumberDescription
    IDENTIFIER_SOURCE_UNSPECIFIED0

    IDENTIFIER_SOURCE_UNSPECIFIED is the default unspecified identifier source.

    IDENTIFIER_SOURCE_FDB1

    IDENTIFIER_SOURCE_FDB indicates a forwarding table.

    IDENTIFIER_SOURCE_ARP2

    IDENTIFIER_SOURCE_ARP indicates ARP (IPv4).

    IDENTIFIER_SOURCE_NEIGHBOR3

    IDENTIFIER_SOURCE_NEIGHBOR indicates NDP (IPv6).

    IDENTIFIER_SOURCE_DEVICE_INVENTORY4

    IDENTIFIER_SOURCE_DEVICE_INVENTORY indicates that an endpoint is in the

    CloudVision inventory.

    IDENTIFIER_SOURCE_LLDP5

    IDENTIFIER_SOURCE_LLDP indicates LLDP.

    IDENTIFIER_SOURCE_DHCP6

    IDENTIFIER_SOURCE_DHCP indicates DHCP.

    IDENTIFIER_SOURCE_WIFI7

    IDENTIFIER_SOURCE_WIFI indicates a WiFi endpoint that was learned through

    a wireless manager.

    IdentifierType

    IdentifierType defines the set of ways for identifying endpoints.

    NameNumberDescription
    IDENTIFIER_TYPE_UNSPECIFIED0

    IDENTIFIER_TYPE_UNSPECIFIED is the default unspecified identifier.

    IDENTIFIER_TYPE_MAC_ADDR1

    IDENTIFIER_TYPE_MAC_ADDR indicates a MAC address identifier.

    IDENTIFIER_TYPE_IPV4_ADDR2

    IDENTIFIER_TYPE_IPV4_ADDR indicates an IPv4 address identifier.

    IDENTIFIER_TYPE_IPV6_ADDR3

    IDENTIFIER_TYPE_IPV6_ADDR indicates an IPv6 address identifier.

    IDENTIFIER_TYPE_INVENTORY_DEVICE_ID4

    IDENTIFIER_TYPE_INVENTORY_DEVICE_ID indicates an inventory device identifier.

    IDENTIFIER_TYPE_PRIMARY_MANAGEMENT_IP5

    IDENTIFIER_TYPE_PRIMARY_MANAGEMENT_IP indicates a primary management IP identifier.

    IDENTIFIER_TYPE_HOSTNAME6

    IDENTIFIER_TYPE_HOSTNAME indicates a hostname identifier.

    IDENTIFIER_TYPE_USERNAME7

    IDENTIFIER_TYPE_USERNAME indicates a username identifier.

    IDENTIFIER_TYPE_OTHER99999

    IDENTIFIER_TYPE_OTHER is used for an unknown identifier.

    Likelihood

    Likelihood indicates a level of confidence.

    NameNumberDescription
    LIKELIHOOD_UNSPECIFIED0

    LIKELIHOOD_UNSPECIFIED is the default unspecified likelihood.

    LIKELIHOOD_VERY_LIKELY1

    LIKELIHOOD_VERY_LIKELY indicates very high confidence.

    LIKELIHOOD_LIKELY2

    LIKELIHOOD_LIKELY indicates high confidence.

    LIKELIHOOD_SOMEWHAT_LIKELY3

    LIKELIHOOD_SOMEWHAT_LIKELY indicates medium confidence.

    LIKELIHOOD_LESS_LIKELY4

    LIKELIHOOD_LESS_LIKELY indicates low confidence.

    MacType

    MacType describes how the MAC address was learned on the port location.

    NameNumberDescription
    MAC_TYPE_UNSPECIFIED0

    MAC_TYPE_UNSPECIFIED is the default unspecified MAC type.

    MAC_TYPE_LEARNED_DYNAMIC1

    MAC_TYPE_LEARNED_DYNAMIC indicates a MAC that is dynamically learned in hardware.

    MAC_TYPE_LEARNED_SECURE2

    MAC_TYPE_LEARNED_SECURE indicates a MAC that is learned in hardware on a port-security protect interface.

    MAC_TYPE_CONFIGURED_DYNAMIC3

    MAC_TYPE_CONFIGURED_DYNAMIC indicates a configured dynamic MAC.

    MAC_TYPE_CONFIGURED_SECURE4

    MAC_TYPE_CONFIGURED_SECURE indicates a MAC configured on an interface with Port Security: Protect mode enabled

    MAC_TYPE_CONFIGURED_STATIC5

    MAC_TYPE_CONFIGURED_STATIC indicates a statically configured MAC.

    MAC_TYPE_PEER_DYNAMIC6

    MAC_TYPE_PEER_DYNAMIC indicates a dynamically learned MAC discovered via an MLAG peer.

    MAC_TYPE_PEER_STATIC7

    MAC_TYPE_PEER_STATIC indicates a statically configured MAC discovered via an MLAG peer.

    MAC_TYPE_PEER_SECURE8

    MAC_TYPE_PEER_SECURE indicates a secure MAC learned from an MLAG peer.

    MAC_TYPE_LEARNED_REMOTE9

    MAC_TYPE_LEARNED_REMOTE indicates a MAC learned remotely behind a VxLAN VTEP.

    MAC_TYPE_CONFIGURED_REMOTE10

    MAC_TYPE_CONFIGURED_REMOTE indicates a MAC configured behind a VxLAN VTEP.

    MAC_TYPE_RECEIVED_REMOTE11

    MAC_TYPE_RECEIVED_REMOTE indicates a MAC received from a VxLAN controller.

    MAC_TYPE_PEER_LEARNED_REMOTE12

    MAC_TYPE_PEER_LEARNED_REMOTE indicates a remote MAC learned on a peer VTEP.

    MAC_TYPE_PEER_CONFIGURED_REMOTE13

    MAC_TYPE_PEER_CONFIGURED_REMOTE indicates an MLAG peer configured remote MAC.

    MAC_TYPE_PEER_RECEIVED_REMOTE14

    MAC_TYPE_PEER_RECEIVED_REMOTE indicates a remote MAC received from a VxLAN controller by the MLAG peer.

    MAC_TYPE_EVPN_DYNAMIC_REMOTE15

    MAC_TYPE_EVPN_DYNAMIC_REMOTE indicates an EVPN dynamic remote MAC.

    MAC_TYPE_EVPN_CONFIGURED_REMOTE16

    MAC_TYPE_EVPN_CONFIGURED_REMOTE indicates an EVPN configured remote MAC.

    MAC_TYPE_PEER_EVPN_REMOTE17

    MAC_TYPE_PEER_EVPN_REMOTE indicates an MLAG peer EVPN remote MAC.

    MAC_TYPE_CONFIGURED_ROUTER18

    MAC_TYPE_CONFIGURED_ROUTER indicates a configured MAC used in routing.

    MAC_TYPE_PEER_ROUTER19

    MAC_TYPE_PEER_ROUTER indicates an MLAG peer specific router MAC.

    MAC_TYPE_EVPN_INTF_DYNAMIC20

    MAC_TYPE_EVPN_INTF_DYNAMIC indicates a MAC advertised by EVPN when a dynamic MAC is learned on ESI (Ethernet Segment Identifier).

    MAC_TYPE_EVPN_INTF_STATIC21

    MAC_TYPE_EVPN_INTF_STATIC indicates a MAC configured on EVPN ESI.

    MAC_TYPE_AUTHENTICATED22

    MAC_TYPE_AUTHENTICATED indicates a MAC authenticated via 802.1X.

    MAC_TYPE_PEER_AUTHENTICATED23

    MAC_TYPE_PEER_AUTHENTICATED indicates a MAC authenticated by 802.1X and learned on an MLAG peer.

    MAC_TYPE_PENDING_SECURE24

    MAC_TYPE_PENDING_SECURE indicates a secure MAC in a pending state.

    MAC_TYPE_SOFTWARE_LEARNED_DYNAMIC25

    MAC_TYPE_SOFTWARE_LEARNED_DYNAMIC indicates a MAC learned behind VTEP in software in the case of a VxLAN remote MAC.

    MAC_TYPE_OTHER99999

    MAC_TYPE_OTHER 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.

    EndpointLocationSomeRequest

    Field NameTypeDescription
    keysEndpointLocationKey[…]

    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.

    EndpointLocationSomeResponse

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    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.

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

    * end: Returns the state of each EndpointLocation at end.

    * Each EndpointLocation response is fully-specified (all fields set).

    * start: Returns the state of each EndpointLocation at start, followed by updates until now.

    * Each EndpointLocation response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each EndpointLocation at start, followed by updates

    until end.

    * Each EndpointLocation response at start is fully-specified, but updates until end may

    be partial.

    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.

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    EndpointLocationService

    Method NameRequest TypeResponse TypeDescription
    GetOneEndpointLocationRequestEndpointLocationResponse

    GetSomeEndpointLocationSomeRequestEndpointLocationSomeResponse stream

    GetAllEndpointLocationStreamRequestEndpointLocationStreamResponse stream

    SubscribeEndpointLocationStreamRequestEndpointLocationStreamResponse stream

    GetMetaEndpointLocationStreamRequestMetaResponse

    SubscribeMetaEndpointLocationStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/event.v1/index.html b/models/event.v1/index.html index ddf9f842..9f6ebe11 100644 --- a/models/event.v1/index.html +++ b/models/event.v1/index.html @@ -1,7 +1,7 @@ event.v1 :: Arista Networks FMP APIs -

    event.v1

    Top

    arista/event.v1/event.proto

    Event

    Event is a telemetry event

    Field NameTypeDescription
    keyEventKey

    key is the event instance identifier

    severityEventSeverity

    severity is the severity of the event

    titlegoogle.protobuf.StringValue

    title is the title of the event

    descriptiongoogle.protobuf.StringValue

    description is the description of the event

    event_typegoogle.protobuf.StringValue

    event_type is the type of the event

    dataEventData

    data is the data of the event

    componentsEventComponents

    components is the components on which the event occurred

    ackEventAck

    ack is the acknowledgement status of the event

    notesEventNotes

    notes is the notes of the event

    last_updated_timegoogle.protobuf.Timestamp

    last_updated_time is the time of the most recent update to the event

    readEventRead

    read is the read status of the event

    rule_idgoogle.protobuf.StringValue

    rule_id is the label of the rule associated with the event

    EventAck

    EventAck contains acknowledgement information of an event

    Field NameTypeDescription
    ackgoogle.protobuf.BoolValue

    ack is the acknowledgement state of an event

    ackergoogle.protobuf.StringValue

    acker is the user that acknowledged the event

    ack_timegoogle.protobuf.Timestamp

    ack_time is the time of acknowledgement

    EventAnnotationConfig

    EventAnnotationConfig configures an event annotation

    NOTE: Either 1) key and ack or 2) key and notes or 3) key and read are @@ -11,4 +11,4 @@ to Set.

    Field NameTypeDescription
    notesEventNotesConfig.NotesEntry[…]

    notes is keyed by desired note time in Unix time, in milliseconds

    EventNotesConfig.NotesEntry

    Field NameTypeDescription
    keyint64

    valueEventNoteConfig

    EventRead

    EventRead contains read information of an event

    Field NameTypeDescription
    readgoogle.protobuf.BoolValue

    read is the read state of an event

    readergoogle.protobuf.StringValue

    reader is the user that read the event

    read_timegoogle.protobuf.Timestamp

    read_time is the time of read

    UserEventCreationConfig

    UserEventCreationConfig is the basis for the manual creation of new events.

    NOTE: Set is the only valid operation. Objects are immediately deleted upon event creation. All fields are required to create a well-formed event.

    Field NameTypeDescription
    keyUserEventCreationKey

    key is the event instance identifier

    severityEventSeverity

    severity is the severity of the event

    titlegoogle.protobuf.StringValue

    title is the title of the event

    descriptiongoogle.protobuf.StringValue

    description is the description of the event

    event_typegoogle.protobuf.StringValue

    event_type is the type of the event

    rule_idgoogle.protobuf.StringValue

    rule_id is the label of the rule associated with the event

    componentsEventComponents

    components is the components on which the event occurred

    start_timegoogle.protobuf.Timestamp

    start_time is the time point at which the event occurred

    UserEventCreationKey

    UserEventCreationKey uniquely identifies a user event request.

    Field NameTypeDescription
    keygoogle.protobuf.StringValue

    key is a unique string identifier

    ComponentType

    ComponentType describes the type of entity on which the event occurred

    NameNumberDescription
    COMPONENT_TYPE_UNSPECIFIED0

    COMPONENT_TYPE_UNSPECIFIED is the default value, if the type is not specified.

    COMPONENT_TYPE_DEVICE1

    COMPONENT_TYPE_DEVICE is used for device events.

    COMPONENT_TYPE_INTERFACE2

    COMPONENT_TYPE_INTERFACE is used for device interface events.

    COMPONENT_TYPE_TURBINE3

    COMPONENT_TYPE_TURBINE is used for events on the internal CVP turbine

    components. A turbine is an internal CV streaming analytics backend process.

    COMPONENT_TYPE_VDS4

    COMPONENT_TYPE_VDS is used for VDS events.

    A vSphere Distributed Switch provides centralized management and

    monitoring of the networking configuration of all workload servers that are

    associated with the switch.

    COMPONENT_TYPE_VDS_INTERFACE5

    COMPONENT_TYPE_VDS_INTERFACE is used for VDS interface events.

    COMPONENT_TYPE_VM6

    COMPONENT_TYPE_VM is used for VM events.

    A VM is a software computer that, like a physical computer, runs an

    operating system and applications.

    COMPONENT_TYPE_VM_INTERFACE7

    COMPONENT_TYPE_VM_INTERFACE is used for VM interface events.

    COMPONENT_TYPE_WORKLOAD_SERVER8

    COMPONENT_TYPE_WORKLOAD_SERVER is used for workload server events.

    A workload server is a server/data storage device on which the hypervisor is installed.

    COMPONENT_TYPE_WORKLOAD_SERVER_INTERFACE9

    COMPONENT_TYPE_WORKLOAD_SERVER_INTERFACE is used for workload server interface events.

    COMPONENT_TYPE_APPLICATION10

    COMPONENT_TYPE_APPLICATION is used for application-service events.

    COMPONENT_TYPE_CVP_NODE11

    COMPONENT_TYPE_CVP_NODE is used for CVP node events.

    EventSeverity

    EventSeverity is the severity level of the event

    NameNumberDescription
    EVENT_SEVERITY_UNSPECIFIED0

    EVENT_SEVERITY_UNSPECIFIED is the default value, if the severity is not specified.

    EVENT_SEVERITY_INFO1

    EVENT_SEVERITY_INFO is used for generally useful information.

    EVENT_SEVERITY_WARNING2

    EVENT_SEVERITY_WARNING is used for potentially harmful conditions.

    EVENT_SEVERITY_ERROR3

    EVENT_SEVERITY_ERROR is used for errors events that may allow for continued functioning.

    EVENT_SEVERITY_CRITICAL4

    EVENT_SEVERITY_CRITICAL is used to designate severe errors that impede functioning.

    EVENT_SEVERITY_DEBUG5

    EVENT_SEVERITY_DEBUG is used for debugging useful information.

    Top

    arista/event.v1/services.gen.proto

    EventAnnotationConfigDeleteAllRequest

    EventAnnotationConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyEventKey

    This is the key of the EventAnnotationConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    EventAnnotationConfigDeleteRequest

    Field NameTypeDescription
    keyEventKey

    Key indicates which EventAnnotationConfig instance to remove.

    This field must always be set.

    EventAnnotationConfigDeleteResponse

    Field NameTypeDescription
    keyEventKey

    Key echoes back the key of the deleted EventAnnotationConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    EventAnnotationConfigDeleteSomeRequest

    Field NameTypeDescription
    keysEventKey[…]

    key contains a list of EventAnnotationConfig keys to delete

    EventAnnotationConfigDeleteSomeResponse

    EventAnnotationConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyEventKey

    errorstring

    EventAnnotationConfigRequest

    Field NameTypeDescription
    keyEventKey

    Key uniquely identifies a EventAnnotationConfig 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.

    EventAnnotationConfigResponse

    Field NameTypeDescription
    valueEventAnnotationConfig

    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

    EventAnnotationConfig instance in this response.

    EventAnnotationConfigSetRequest

    Field NameTypeDescription
    valueEventAnnotationConfig

    EventAnnotationConfig carries the value to set into the datastore.

    See the documentation on the EventAnnotationConfig struct for which fields are required.

    EventAnnotationConfigSetResponse

    Field NameTypeDescription
    valueEventAnnotationConfig

    Value carries all the values given in the EventAnnotationConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    EventAnnotationConfigSetSomeRequest

    Field NameTypeDescription
    valuesEventAnnotationConfig[…]

    value contains a list of EventAnnotationConfig 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.

    EventAnnotationConfigSetSomeResponse

    Field NameTypeDescription
    keyEventKey

    errorstring

    EventAnnotationConfigSomeRequest

    Field NameTypeDescription
    keysEventKey[…]

    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.

    EventAnnotationConfigSomeResponse

    Field NameTypeDescription
    valueEventAnnotationConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    EventAnnotationConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterEventAnnotationConfig[…]

    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.

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

    * end: Returns the state of each EventAnnotationConfig at end.

    * Each EventAnnotationConfig response is fully-specified (all fields set).

    * start: Returns the state of each EventAnnotationConfig at start, followed by updates until now.

    * Each EventAnnotationConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each EventAnnotationConfig at start, followed by updates

    until end.

    * Each EventAnnotationConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    EventAnnotationConfigStreamResponse

    Field NameTypeDescription
    valueEventAnnotationConfig

    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 EventAnnotationConfig’s last modification.

    typearista.subscriptions.Operation

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

    EventRequest

    Field NameTypeDescription
    keyEventKey

    Key uniquely identifies a Event 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.

    EventResponse

    Field NameTypeDescription
    valueEvent

    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

    Event instance in this response.

    EventSomeRequest

    Field NameTypeDescription
    keysEventKey[…]

    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.

    EventSomeResponse

    Field NameTypeDescription
    valueEvent

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    EventStreamRequest

    Field NameTypeDescription
    partial_eq_filterEvent[…]

    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.

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

    * end: Returns the state of each Event at end.

    * Each Event response is fully-specified (all fields set).

    * start: Returns the state of each Event at start, followed by updates until now.

    * Each Event response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Event at start, followed by updates

    until end.

    * Each Event response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    EventStreamResponse

    Field NameTypeDescription
    valueEvent

    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 Event’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    UserEventCreationConfigDeleteAllRequest

    UserEventCreationConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyUserEventCreationKey

    This is the key of the UserEventCreationConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    UserEventCreationConfigDeleteRequest

    Field NameTypeDescription
    keyUserEventCreationKey

    Key indicates which UserEventCreationConfig instance to remove.

    This field must always be set.

    UserEventCreationConfigDeleteResponse

    Field NameTypeDescription
    keyUserEventCreationKey

    Key echoes back the key of the deleted UserEventCreationConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    UserEventCreationConfigDeleteSomeRequest

    Field NameTypeDescription
    keysUserEventCreationKey[…]

    key contains a list of UserEventCreationConfig keys to delete

    UserEventCreationConfigDeleteSomeResponse

    UserEventCreationConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyUserEventCreationKey

    errorstring

    UserEventCreationConfigRequest

    Field NameTypeDescription
    keyUserEventCreationKey

    Key uniquely identifies a UserEventCreationConfig 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.

    UserEventCreationConfigResponse

    Field NameTypeDescription
    valueUserEventCreationConfig

    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

    UserEventCreationConfig instance in this response.

    UserEventCreationConfigSetRequest

    Field NameTypeDescription
    valueUserEventCreationConfig

    UserEventCreationConfig carries the value to set into the datastore.

    See the documentation on the UserEventCreationConfig struct for which fields are required.

    UserEventCreationConfigSetResponse

    Field NameTypeDescription
    valueUserEventCreationConfig

    Value carries all the values given in the UserEventCreationConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    UserEventCreationConfigSetSomeRequest

    Field NameTypeDescription
    valuesUserEventCreationConfig[…]

    value contains a list of UserEventCreationConfig 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.

    UserEventCreationConfigSetSomeResponse

    Field NameTypeDescription
    keyUserEventCreationKey

    errorstring

    UserEventCreationConfigSomeRequest

    Field NameTypeDescription
    keysUserEventCreationKey[…]

    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.

    UserEventCreationConfigSomeResponse

    Field NameTypeDescription
    valueUserEventCreationConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    UserEventCreationConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterUserEventCreationConfig[…]

    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.

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

    * end: Returns the state of each UserEventCreationConfig at end.

    * Each UserEventCreationConfig response is fully-specified (all fields set).

    * start: Returns the state of each UserEventCreationConfig at start, followed by updates until now.

    * Each UserEventCreationConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each UserEventCreationConfig at start, followed by updates

    until end.

    * Each UserEventCreationConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    UserEventCreationConfigStreamResponse

    Field NameTypeDescription
    valueUserEventCreationConfig

    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 UserEventCreationConfig’s last modification.

    typearista.subscriptions.Operation

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

    EventAnnotationConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneEventAnnotationConfigRequestEventAnnotationConfigResponse

    GetSomeEventAnnotationConfigSomeRequestEventAnnotationConfigSomeResponse stream

    GetAllEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

    SubscribeEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

    GetMetaEventAnnotationConfigStreamRequestMetaResponse

    SubscribeMetaEventAnnotationConfigStreamRequestMetaResponse stream

    SetEventAnnotationConfigSetRequestEventAnnotationConfigSetResponse

    SetSomeEventAnnotationConfigSetSomeRequestEventAnnotationConfigSetSomeResponse stream

    DeleteEventAnnotationConfigDeleteRequestEventAnnotationConfigDeleteResponse

    DeleteSomeEventAnnotationConfigDeleteSomeRequestEventAnnotationConfigDeleteSomeResponse stream

    DeleteAllEventAnnotationConfigDeleteAllRequestEventAnnotationConfigDeleteAllResponse stream

    EventService

    Method NameRequest TypeResponse TypeDescription
    GetOneEventRequestEventResponse

    GetSomeEventSomeRequestEventSomeResponse stream

    GetAllEventStreamRequestEventStreamResponse stream

    SubscribeEventStreamRequestEventStreamResponse stream

    GetMetaEventStreamRequestMetaResponse

    SubscribeMetaEventStreamRequestMetaResponse stream

    UserEventCreationConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneUserEventCreationConfigRequestUserEventCreationConfigResponse

    GetSomeUserEventCreationConfigSomeRequestUserEventCreationConfigSomeResponse stream

    GetAllUserEventCreationConfigStreamRequestUserEventCreationConfigStreamResponse stream

    SubscribeUserEventCreationConfigStreamRequestUserEventCreationConfigStreamResponse stream

    GetMetaUserEventCreationConfigStreamRequestMetaResponse

    SubscribeMetaUserEventCreationConfigStreamRequestMetaResponse stream

    SetUserEventCreationConfigSetRequestUserEventCreationConfigSetResponse

    SetSomeUserEventCreationConfigSetSomeRequestUserEventCreationConfigSetSomeResponse stream

    DeleteUserEventCreationConfigDeleteRequestUserEventCreationConfigDeleteResponse

    DeleteSomeUserEventCreationConfigDeleteSomeRequestUserEventCreationConfigDeleteSomeResponse stream

    DeleteAllUserEventCreationConfigDeleteAllRequestUserEventCreationConfigDeleteAllResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/identityprovider.v1/index.html b/models/identityprovider.v1/index.html index 47d2d4fb..ba192d20 100644 --- a/models/identityprovider.v1/index.html +++ b/models/identityprovider.v1/index.html @@ -1,8 +1,8 @@ identityprovider.v1 :: Arista Networks FMP APIs -

    identityprovider.v1

    Top

    arista/identityprovider.v1/identityprovider.proto

    OAuthConfig

    OAuthConfig holds the configuration for an OAuth provider.

    Field NameTypeDescription
    keyOAuthKey

    key is the ID of the OAuth provider.

    endpointgoogle.protobuf.StringValue

    endpoint is the URL that identifies an OAuth authorization server.

    This endpoint is used to interact with the provider. It must be a

    URI [RFC3986] with a scheme component that must be https, a host component,

    and optionally, port and path components, but no query or fragment components.

    client_idgoogle.protobuf.StringValue

    client_id is the ID that the OAuth authorization server issues to the

    registered client.

    client_secretgoogle.protobuf.StringValue

    client_secret is the secret that the OAuth authorization server issues

    to the registered client.

    algorithmsfmp.RepeatedString

    algorithms is the set of signing algorithms. This is an optional field.

    If specified, only this set of algorithms may be used to sign the JWT.

    Otherwise, this defaults to the set of algorithms that the provider supports.

    link_to_shared_providergoogle.protobuf.BoolValue

    link_to_shared_provider indicates whether or not use the provider as a shared

    provider. This is an optional field and set to false by default.

    jwks_urigoogle.protobuf.StringValue

    jwks_uri is where signing keys are downloaded. This is an optional field.

    Only needed if the default construction from endpoint would be incorrect.

    permitted_email_domainsfmp.RepeatedString

    permitted_email_domains are domains of emails that users are allowed to use.

    This is an optional field. If not set, all domains are accepted by default.

    roles_scope_namegoogle.protobuf.StringValue

    roles_scope_name is the name for a scope tied to a claim that holds

    CloudVision roles in ID Token. CloudVision uses scope values to specify

    what access privileges are being requested for id token. CloudVision

    appends this value to scope query parameter in the authorization request URL.

    This is an optional field. If not set, CloudVision determines that

    mapping roles from the provider is disabled. If it’s set, roles_claim_name

    also needs to be set.

    bearer_token_introspection_endpointgoogle.protobuf.StringValue

    bearer_token_introspection_endpoint is the provider instrospection endpoint used

    in Bearer Token based login support for CloudVision. This is an optional field.

    If specified, this endpoint will be used to verify bearer tokens generated via

    the provider to log in automated user accounts.

    roles_claim_namegoogle.protobuf.StringValue

    roles_claim_name is the name for a claim that holds CloudVision roles in ID Token.

    CloudVision uses this value to look up roles in the ID Token.

    This is an optional field. If not set, CloudVision determines that

    mapping roles from the provider is disabled. If it’s set, roles_scope_name

    also needs to be set.

    OAuthKey

    OAuthKey contains OAuth provider ID.

    Field NameTypeDescription
    provider_idgoogle.protobuf.StringValue

    provider_id is the ID of the OAuth provider.

    SAMLConfig

    SAMLConfig holds the configuration for a SAML provider.

    Field NameTypeDescription
    keySAMLKey

    key is the ID of the SAML provider.

    idp_issuergoogle.protobuf.StringValue

    idp_issuer identifies the SAML provider. There is no restriction on its format

    other than a string to carry the issuer’s name.

    idp_metadata_urlgoogle.protobuf.StringValue

    idp_metadata_url is the URL that CloudVision uses to fetch the

    SAML provider metadata.

    authreq_bindingProtocolBinding

    authreq_binding specifies the ProtocolBinding used to send SAML authentication

    request to the SAML provider.

    email_attrnamegoogle.protobuf.StringValue

    email_attrname specifies the Attribute name for email ID in Assertion of SAMLResponse

    from the SAML provider.

    link_to_shared_providergoogle.protobuf.BoolValue

    link_to_shared_provider indicates whether or not use the provider as a shared

    provider. This is an optional field and set to false by default.

    permitted_email_domainsfmp.RepeatedString

    permitted_email_domains are domains of emails that users are allowed to use.

    This is an optional field. If not set, all domains are accepted by default.

    force_saml_authngoogle.protobuf.BoolValue

    force_saml_authn indicates wether or not enable force authentication in SAML login.

    This is an optional field. If not set, it defaults to false.

    roles_attrnamegoogle.protobuf.StringValue

    roles_attrname specifies the Attribute name for CloudVision roles in the Assertion

    of SAMLResponse. This is an optional field. If not set, CloudVision determines that

    mapping roles from the provider is disabled.

    org_attrnamegoogle.protobuf.StringValue

    org_attrname specifies the Attribute name for CloudVision organization/tenant in

    the Assertion of SAMLResponse. This is an optional field. CloudVision supports use

    of certain shared SAML Identity Providers for authenticating users across multiple

    CloudVision organizations/tenants. In case a given organization uses a shared provider,

    then, CloudVision needs this attribute to determine if the organization that

    the shared SAML Identity Provider is sending the assertion for is the same as the

    one the user requested to be logged into. For an existing user on CloudVision,

    the user’s email is used to determine which organization the user belongs to do

    the same verification but in case a dynamic user creation is needed and the given

    user doesn’t exist on CloudVision currently then the matching organization attribute

    from the shared Identity Privder becomes necessary. Dynamic user creation is

    disabled for a given organization using shared Identity Provider if this attribute

    is not specified.

    username_attrnamegoogle.protobuf.StringValue

    username_attrname specifies Attribute name for CloudVision users’ username in the

    Assertion of SAMLResponse. This is an optional field as long as mapping roles from

    provider is not enabled. Once enabled, this field becomes mandatory.

    SAMLKey

    SAMLKey contains SAML Provider ID.

    Field NameTypeDescription
    provider_idgoogle.protobuf.StringValue

    provider_id is the ID of the SAML provider.

    ProtocolBinding

    ProtocolBinding indicates SAML protocol binding to be used.

    NameNumberDescription
    PROTOCOL_BINDING_UNSPECIFIED0

    PROTOCOL_BINDING_UNSPECIFIED indicates that a protocol binding is unspecified.

    PROTOCOL_BINDING_HTTP_POST1

    PROTOCOL_BINDING_HTTP_POST indicates HTTP-POST SAML protocol binding.

    PROTOCOL_BINDING_HTTP_REDIRECT2

    PROTOCOL_BINDING_HTTP_REDIRECT indicates HTTP-Redirect SAML protocol binding.

    Top

    arista/identityprovider.v1/services.gen.proto

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    OAuthConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterOAuthConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    OAuthConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyOAuthKey

    This is the key of the OAuthConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    OAuthConfigDeleteRequest

    Field NameTypeDescription
    keyOAuthKey

    Key indicates which OAuthConfig instance to remove.

    This field must always be set.

    OAuthConfigDeleteResponse

    Field NameTypeDescription
    keyOAuthKey

    Key echoes back the key of the deleted OAuthConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    OAuthConfigDeleteSomeRequest

    Field NameTypeDescription
    keysOAuthKey[…]

    key contains a list of OAuthConfig keys to delete

    OAuthConfigDeleteSomeResponse

    OAuthConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyOAuthKey

    errorstring

    OAuthConfigRequest

    Field NameTypeDescription
    keyOAuthKey

    Key uniquely identifies a OAuthConfig 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.

    OAuthConfigResponse

    Field NameTypeDescription
    valueOAuthConfig

    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

    OAuthConfig instance in this response.

    OAuthConfigSetRequest

    Field NameTypeDescription
    valueOAuthConfig

    OAuthConfig carries the value to set into the datastore.

    See the documentation on the OAuthConfig struct for which fields are required.

    OAuthConfigSetResponse

    Field NameTypeDescription
    valueOAuthConfig

    Value carries all the values given in the OAuthConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    OAuthConfigSetSomeRequest

    Field NameTypeDescription
    valuesOAuthConfig[…]

    value contains a list of OAuthConfig 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.

    OAuthConfigSetSomeResponse

    Field NameTypeDescription
    keyOAuthKey

    errorstring

    OAuthConfigSomeRequest

    Field NameTypeDescription
    keysOAuthKey[…]

    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.

    OAuthConfigSomeResponse

    Field NameTypeDescription
    valueOAuthConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    OAuthConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterOAuthConfig[…]

    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.

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

    * end: Returns the state of each OAuthConfig at end.

    * Each OAuthConfig response is fully-specified (all fields set).

    * start: Returns the state of each OAuthConfig at start, followed by updates until now.

    * Each OAuthConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each OAuthConfig at start, followed by updates

    until end.

    * Each OAuthConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    OAuthConfigStreamResponse

    Field NameTypeDescription
    valueOAuthConfig

    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 OAuthConfig’s last modification.

    typearista.subscriptions.Operation

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

    SAMLConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterSAMLConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    SAMLConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keySAMLKey

    This is the key of the SAMLConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    SAMLConfigDeleteRequest

    Field NameTypeDescription
    keySAMLKey

    Key indicates which SAMLConfig instance to remove.

    This field must always be set.

    SAMLConfigDeleteResponse

    Field NameTypeDescription
    keySAMLKey

    Key echoes back the key of the deleted SAMLConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    SAMLConfigDeleteSomeRequest

    Field NameTypeDescription
    keysSAMLKey[…]

    key contains a list of SAMLConfig keys to delete

    SAMLConfigDeleteSomeResponse

    SAMLConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keySAMLKey

    errorstring

    SAMLConfigRequest

    Field NameTypeDescription
    keySAMLKey

    Key uniquely identifies a SAMLConfig 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.

    SAMLConfigResponse

    Field NameTypeDescription
    valueSAMLConfig

    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

    SAMLConfig instance in this response.

    SAMLConfigSetRequest

    Field NameTypeDescription
    valueSAMLConfig

    SAMLConfig carries the value to set into the datastore.

    See the documentation on the SAMLConfig struct for which fields are required.

    SAMLConfigSetResponse

    Field NameTypeDescription
    valueSAMLConfig

    Value carries all the values given in the SAMLConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    SAMLConfigSetSomeRequest

    Field NameTypeDescription
    valuesSAMLConfig[…]

    value contains a list of SAMLConfig 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.

    SAMLConfigSetSomeResponse

    Field NameTypeDescription
    keySAMLKey

    errorstring

    SAMLConfigSomeRequest

    Field NameTypeDescription
    keysSAMLKey[…]

    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.

    SAMLConfigSomeResponse

    Field NameTypeDescription
    valueSAMLConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SAMLConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterSAMLConfig[…]

    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.

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

    * end: Returns the state of each SAMLConfig at end.

    * Each SAMLConfig response is fully-specified (all fields set).

    * start: Returns the state of each SAMLConfig at start, followed by updates until now.

    * Each SAMLConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each SAMLConfig at start, followed by updates

    until end.

    * Each SAMLConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SAMLConfigStreamResponse

    Field NameTypeDescription
    valueSAMLConfig

    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 SAMLConfig’s last modification.

    typearista.subscriptions.Operation

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

    OAuthConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneOAuthConfigRequestOAuthConfigResponse

    GetSomeOAuthConfigSomeRequestOAuthConfigSomeResponse stream

    GetAllOAuthConfigStreamRequestOAuthConfigStreamResponse stream

    SubscribeOAuthConfigStreamRequestOAuthConfigStreamResponse stream

    GetMetaOAuthConfigStreamRequestMetaResponse

    SubscribeMetaOAuthConfigStreamRequestMetaResponse stream

    SetOAuthConfigSetRequestOAuthConfigSetResponse

    SetSomeOAuthConfigSetSomeRequestOAuthConfigSetSomeResponse stream

    DeleteOAuthConfigDeleteRequestOAuthConfigDeleteResponse

    DeleteSomeOAuthConfigDeleteSomeRequestOAuthConfigDeleteSomeResponse stream

    DeleteAllOAuthConfigDeleteAllRequestOAuthConfigDeleteAllResponse stream

    SAMLConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneSAMLConfigRequestSAMLConfigResponse

    GetSomeSAMLConfigSomeRequestSAMLConfigSomeResponse stream

    GetAllSAMLConfigStreamRequestSAMLConfigStreamResponse stream

    SubscribeSAMLConfigStreamRequestSAMLConfigStreamResponse stream

    GetMetaSAMLConfigStreamRequestMetaResponse

    SubscribeMetaSAMLConfigStreamRequestMetaResponse stream

    SetSAMLConfigSetRequestSAMLConfigSetResponse

    SetSomeSAMLConfigSetSomeRequestSAMLConfigSetSomeResponse stream

    DeleteSAMLConfigDeleteRequestSAMLConfigDeleteResponse

    DeleteSomeSAMLConfigDeleteSomeRequestSAMLConfigDeleteSomeResponse stream

    DeleteAllSAMLConfigDeleteAllRequestSAMLConfigDeleteAllResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/imagestatus.v1/index.html b/models/imagestatus.v1/index.html index 14a5bda9..6fdd825b 100644 --- a/models/imagestatus.v1/index.html +++ b/models/imagestatus.v1/index.html @@ -1,7 +1,7 @@ imagestatus.v1 :: Arista Networks FMP APIs -

    imagestatus.v1

    Top

    arista/imagestatus.v1/imagestatus.proto

    ComplianceStatus

    ComplianceStatus indicates compliance status for software image, terminattr @@ -14,4 +14,4 @@ supervisor.

    Field NameTypeDescription
    valuesSoftwareImageDiffsBySup.ValuesEntry[…]

    values is the mapping of supervisor type to image diff.

    SoftwareImageDiffsBySup.ValuesEntry

    Field NameTypeDescription
    keystring

    valueSoftwareImageDiff

    Summary

    Summary represents the device image summary.

    Field NameTypeDescription
    keySummaryKey

    key represents the image summary key.

    summaryImageSummary

    summary is the image diff summary.

    errorsImageErrors

    errors are the image errors encountered while validating the image. These are

    displayed on the change control review page (for changes made outside the workspace).

    warningsImageWarnings

    warnings are the image warnings encountered while validating the image. These are

    displayed on the change control review page (for changes made outside the workspace).

    SummaryKey

    SummaryKey uniquely identifies a device summary request.

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    device_id is the serial number of the device

    TerminAttrDiffsBySup

    TerminAttrDiffsBySup is the terminattr diff information for each supervisor.

    Field NameTypeDescription
    valuesTerminAttrDiffsBySup.ValuesEntry[…]

    values is the mapping of supervisor type to terminattr diff.

    TerminAttrDiffsBySup.ValuesEntry

    Field NameTypeDescription
    keystring

    valueExtensionDiff

    DiffOp

    DiffOp represents the operation performed to get from one side of the diff to the other.

    NameNumberDescription
    DIFF_OP_UNSPECIFIED0

    DIFF_OP_UNSPECIFIED indicates op code is unspecified.

    DIFF_OP_NOP1

    DIFF_OP_NOP indicates no change.

    DIFF_OP_ADD2

    DIFF_OP_ADD is an addition of a software.

    DIFF_OP_DELETE3

    DIFF_OP_DELETE is deletion of a software.

    DIFF_OP_CHANGE4

    DIFF_OP_CHANGE is an update to the software.

    ErrorCode

    ErrorCode indicates errors produced during image validations.

    NameNumberDescription
    ERROR_CODE_UNSPECIFIED0

    ERROR_CODE_UNSPECIFIED indicates error code is unspecified.

    ERROR_CODE_SUPPORT_NOT_INTRODUCED1

    ERROR_CODE_SUPPORT_NOT_INTRODUCED represents case where the given EOS version does

    not support the SKU.

    Deprecated - use ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED

    ERROR_CODE_SUPPORT_REMOVED2

    ERROR_CODE_SUPPORT_REMOVED represents case where the given EOS version no longer

    supports the SKU.

    Deprecated - use ERROR_CODE_EOS_SUPPORT_REMOVED

    ERROR_CODE_DEVICE_UNREACHABLE3

    ERROR_CODE_DEVICE_UNREACHABLE represents the case where the device

    is unreachable during a compliance computation.

    ERROR_CODE_VALIDATION_FAILED4

    ERROR_CODE_VALIDATION_FAILED represents case where the validations checks

    failed.

    ERROR_CODE_GET_PROPOSED_IMAGE_INFO_FAILED5

    ERROR_CODE_GET_PROPOSED_IMAGE_INFO_FAILED represents case where we are

    unable to get proposed image information for a device.

    ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED6

    ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED represents case where we

    fail to get running image information from an active supervisor.

    ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED7

    ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED represents case when we

    fail to get information from peer supervisor.

    ERROR_CODE_EOS_TA_ARCHITECTURE_INCOMPATIBLE8

    ERROR_CODE_EOS_TA_ARCHITECTURE_INCOMPATIBLE represents the case where EOS architecture and

    TerminAttr architecture are incompatible.

    ERROR_CODE_TA_CV_INCOMPATIBLE9

    ERROR_CODE_TA_CV_INCOMPATIBLE represents the case where TerminAttr is incompatible with

    CloudVision; i.e., the TerminAttr version is below CloudVision’s minimum supported version.

    ERROR_CODE_EOS_CV_INCOMPATIBLE10

    ERROR_CODE_EOS_CV_INCOMPATIBLE represents the case where the EOS version is incompatible with

    CloudVision; i.e., the EOS version is outside of CloudVision’s supported range of versions.

    ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED11

    ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED represents the case where the given EOS version does

    not support the SKU.

    ERROR_CODE_EOS_SUPPORT_REMOVED12

    ERROR_CODE_EOS_SUPPORT_REMOVED represents the case where the given EOS version no longer

    supports the SKU.

    ERROR_CODE_PHYSICAL_DEVICE_EOS_INCOMPATIBLE13

    ERROR_CODE_PHYSICAL_DEVICE_EOS_INCOMPATIBLE represents the case where the physical device

    does not support the given EOS type.

    ERROR_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE14

    ERROR_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents the case where the extension TerminAttr

    version is lower than the embedded TerminAttr version in SWI.

    ExtensionInstallStatus

    ExtensionInstallStatus indicates whether an extension is installed, not installed or force installed.

    NameNumberDescription
    EXTENSION_INSTALL_STATUS_UNSPECIFIED0

    EXTENSION_INSTALL_STATUS_UNSPECIFIED indicates extensions install status is unspecified.

    EXTENSION_INSTALL_STATUS_NOT_INSTALLED1

    EXTENSION_INSTALL_STATUS_NOT_INSTALLED indicates extension is not installed on the device.

    EXTENSION_INSTALL_STATUS_INSTALLED2

    EXTENSION_INSTALL_STATUS_INSTALLED indicates extension is installed on the device.

    EXTENSION_INSTALL_STATUS_FORCE_INSTALLED3

    EXTENSION_INSTALL_STATUS_FORCE_INSTALLED indicates extension is force installed on

    device.

    SoftwareComplianceCode

    SoftwareComplianceCode indicates possible compliance status.

    NameNumberDescription
    SOFTWARE_COMPLIANCE_CODE_UNSPECIFIED0

    SOFTWARE_COMPLIANCE_CODE_UNSPECIFIED indicates compliance code is unspecified.

    SOFTWARE_COMPLIANCE_CODE_IN_SYNC1

    SOFTWARE_COMPLIANCE_CODE_IN_SYNC indicates designed and running images/extensions

    are identical.

    SOFTWARE_COMPLIANCE_CODE_OUT_OF_SYNC2

    SOFTWARE_COMPLIANCE_CODE_OUT_OF_SYNC indicates designed and running images/extensions

    are not identical.

    WarningCode

    WarningCode indicates warnings produced during image validations.

    NameNumberDescription
    WARNING_CODE_UNSPECIFIED0

    WARNING_CODE_UNSPECIFIED indicates warning code is unspecified.

    WARNING_CODE_NOT_APPLICABLE1

    WARNING_CODE_NOT_APPLICABLE represents cases where EOS <-> SKU/TA compatibility

    is not applicable for non physical switches like vEos.

    WARNING_CODE_SKUINFO_UNAVAILABLE2

    WARNING_CODE_SKUINFO_UNAVAILABLE represents case where

    information about certain skus is missing.

    WARNING_CODE_DEVICE_SKU_UNAVAILABLE3

    WARNING_CODE_DEVICE_SKU_UNAVAILABLE represents unavailability of skus for an EOS Device.

    WARNING_CODE_SWI_UNKNOWN4

    WARNING_CODE_SWI_UNKNOWN represents cases where EOS version is not found in release database.

    WARNING_CODE_TA_EOS_INCOMPATIBLE5

    WARNING_CODE_TA_EOS_INCOMPATIBLE represents cases where TA and EOS are not compatible.

    TA is lower than embedded TA in swi or given TA is unsupported by the EOS.

    WARNING_CODE_TA_CV_INCOMPATIBLE6

    WARNING_CODE_TA_CV_INCOMPATIBLE represents cases where TA is incompatible with CV.

    TA is lower than minimum supported TA on CV.

    Deprecated - use ERROR_CODE_TA_CV_INCOMPATIBLE.

    WARNING_CODE_EOS_CV_INCOMPATIBLE7

    WARNING_CODE_EOS_CV_INCOMPATIBLE represents cases where EOS is no longer or not yet

    supported by CV. Given EOS is outside range of CV’s minimum and maximum EOS.

    Deprecated - use ERROR_CODE_EOS_CV_INCOMPATIBLE.

    WARNING_CODE_EOS_ARCH_UNKNOWN8

    WARNING_CODE_EOS_ARCH_UNKNOWN represents cases where the specified architecture is

    not valid for EOS.

    WARNING_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE9

    WARNING_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents cases where TA extension is lower

    in version than embedded TA in SWI.

    WARNING_CODE_ARCH_INCOMPATIBLE10

    WARNING_CODE_ARCH_INCOMPATIBLE represents cases where EOS arch and TA arch are

    different. Deprecated.

    WARNING_CODE_EOS_END_OF_LIFE_DATE_PASSED11

    WARNING_CODE_EOS_END_OF_LIFE_DATE_PASSED represents cases where the given EOS has passed

    its end of life date.

    WARNING_CODE_SUPPORT_NOT_INTRODUCED12

    WARNING_CODE_SUPPORT_NOT_INTRODUCED represents cases where the given EOS version does

    not support the SKUs.

    WARNING_CODE_SUPPORT_REMOVED13

    WARNING_CODE_SUPPORT_REMOVED represents cases where the given EOS version no longer

    supports the SKUs.

    WARNING_CODE_RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION14

    WARNING_CODE_RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION represents cases where the running

    TerminAttr version is below CloudVision’s minimum supported version.

    Top

    arista/imagestatus.v1/services.gen.proto

    SummaryRequest

    Field NameTypeDescription
    keySummaryKey

    Key uniquely identifies a Summary 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.

    SummaryResponse

    Field NameTypeDescription
    valueSummary

    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

    Summary instance in this response.

    SummaryStreamRequest

    Field NameTypeDescription
    partial_eq_filterSummary[…]

    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.

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

    * end: Returns the state of each Summary at end.

    * Each Summary response is fully-specified (all fields set).

    * start: Returns the state of each Summary at start, followed by updates until now.

    * Each Summary response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Summary at start, followed by updates

    until end.

    * Each Summary response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SummaryStreamResponse

    Field NameTypeDescription
    valueSummary

    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 Summary’s last modification.

    typearista.subscriptions.Operation

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

    SummaryService

    Method NameRequest TypeResponse TypeDescription
    GetOneSummaryRequestSummaryResponse

    GetAllSummaryStreamRequestSummaryStreamResponse stream

    SubscribeSummaryStreamRequestSummaryStreamResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/index.html b/models/index.html index 1a335b05..80923027 100644 --- a/models/index.html +++ b/models/index.html @@ -1,8 +1,8 @@ Models :: Arista Networks FMP APIs -

    Models

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/inventory.v1/index.html b/models/inventory.v1/index.html index 3bca36e9..c8a3a48e 100644 --- a/models/inventory.v1/index.html +++ b/models/inventory.v1/index.html @@ -1,7 +1,7 @@ inventory.v1 :: Arista Networks FMP APIs -

    inventory.v1

    Top

    arista/inventory.v1/inventory.proto

    Device

    Device describes an onboarded device.

    Field NameTypeDescription
    keyDeviceKey

    key uniquely identifies the device.

    software_versiongoogle.protobuf.StringValue

    software_version gives the currently running device software version.

    model_namegoogle.protobuf.StringValue

    model_name describes the hardware model of this device.

    hardware_revisiongoogle.protobuf.StringValue

    hardware_revision describes any revisional data to the model name.

    fqdngoogle.protobuf.StringValue

    fqdn gives the device’s fully qualified domain name.

    hostnamegoogle.protobuf.StringValue

    hostname is the hostname as reported on the device.

    domain_namegoogle.protobuf.StringValue

    domain_name provides the domain name on which the device is registered.

    system_mac_addressgoogle.protobuf.StringValue

    system_mac_address provides the MAC address of the management port.

    boot_timegoogle.protobuf.Timestamp

    boot_time indicates when the device was last booted.

    streaming_statusStreamingStatus

    streaming_status is the status of telemetry streaming for this device.

    extended_attributesExtendedAttributes

    extended_attributes wraps any additional, potentially non-standard, features

    or attributes that the device reports.

    DeviceConfiguration

    DeviceConfiguration holds the device-specific configuration for a third-party @@ -21,4 +21,4 @@ process for a device.

    NameNumberDescription
    DECOMMISSIONING_STATUS_UNSPECIFIED0

    DECOMMISSIONING_STATUS_IN_PROGRESS1

    DECOMMISSIONING_STATUS_IN_PROGRESS indicates decommissioning is in progress.

    DECOMMISSIONING_STATUS_FAILURE2

    DECOMMISSIONING_STATUS_FAILURE indicates decommissioning failed.

    DECOMMISSIONING_STATUS_SUCCESS3

    DECOMMISSIONING_STATUS_SUCCESS indicates decommissioning succeeded.

    OnboardingStatus

    OnboardingStatus defines the set of possible states in the onboarding process for a device.

    NameNumberDescription
    ONBOARDING_STATUS_UNSPECIFIED0

    ONBOARDING_STATUS_IN_PROGRESS1

    ONBOARDING_STATUS_IN_PROGRESS indicates onboarding is in progress.

    ONBOARDING_STATUS_FAILURE2

    ONBOARDING_STATUS_FAILURE indicates onboarding failed.

    ONBOARDING_STATUS_SUCCESS3

    ONBOARDING_STATUS_SUCCESS indicates onboarding succeeded.

    ProvisioningStatus

    ProvisioningStatus defines the set of possible states in the provisioning process for a device.

    NameNumberDescription
    PROVISIONING_STATUS_UNSPECIFIED0

    PROVISIONING_STATUS_IN_PROGRESS1

    PROVISIONING_STATUS_IN_PROGRESS indicates provisioning is in progress.

    PROVISIONING_STATUS_FAILURE2

    PROVISIONING_STATUS_FAILURE indicates provisioning failed.

    PROVISIONING_STATUS_SUCCESS3

    PROVISIONING_STATUS_SUCCESS indicates provisioning succeeded.

    StreamingStatus

    StreamingStatus defines the status of telemetry streaming for a device.

    NameNumberDescription
    STREAMING_STATUS_UNSPECIFIED0

    STREAMING_STATUS_INACTIVE1

    STREAMING_STATUS_INACTIVE indicates the device is not streaming telemetry.

    STREAMING_STATUS_ACTIVE2

    STREAMING_STATUS_ACTIVE indicates the device is streaming telemetry.

    Top

    arista/inventory.v1/services.gen.proto

    DeviceDecommissioningConfigDeleteAllRequest

    DeviceDecommissioningConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyUUIDKey

    This is the key of the DeviceDecommissioningConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    DeviceDecommissioningConfigDeleteRequest

    Field NameTypeDescription
    keyUUIDKey

    Key indicates which DeviceDecommissioningConfig instance to remove.

    This field must always be set.

    DeviceDecommissioningConfigDeleteResponse

    Field NameTypeDescription
    keyUUIDKey

    Key echoes back the key of the deleted DeviceDecommissioningConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    DeviceDecommissioningConfigRequest

    Field NameTypeDescription
    keyUUIDKey

    Key uniquely identifies a DeviceDecommissioningConfig 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.

    DeviceDecommissioningConfigResponse

    Field NameTypeDescription
    valueDeviceDecommissioningConfig

    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

    DeviceDecommissioningConfig instance in this response.

    DeviceDecommissioningConfigSetRequest

    Field NameTypeDescription
    valueDeviceDecommissioningConfig

    DeviceDecommissioningConfig carries the value to set into the datastore.

    See the documentation on the DeviceDecommissioningConfig struct for which fields are required.

    DeviceDecommissioningConfigSetResponse

    Field NameTypeDescription
    valueDeviceDecommissioningConfig

    Value carries all the values given in the DeviceDecommissioningConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    DeviceDecommissioningConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceDecommissioningConfig[…]

    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.

    DeviceDecommissioningConfigStreamResponse

    Field NameTypeDescription
    valueDeviceDecommissioningConfig

    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 DeviceDecommissioningConfig’s last modification.

    typearista.subscriptions.Operation

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

    DeviceDecommissioningRequest

    Field NameTypeDescription
    keyUUIDKey

    Key uniquely identifies a DeviceDecommissioning 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.

    DeviceDecommissioningResponse

    Field NameTypeDescription
    valueDeviceDecommissioning

    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

    DeviceDecommissioning instance in this response.

    DeviceDecommissioningStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceDecommissioning[…]

    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.

    DeviceDecommissioningStreamResponse

    Field NameTypeDescription
    valueDeviceDecommissioning

    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 DeviceDecommissioning’s last modification.

    typearista.subscriptions.Operation

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

    DeviceOnboardingConfigDeleteAllRequest

    DeviceOnboardingConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyUUIDKey

    This is the key of the DeviceOnboardingConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    DeviceOnboardingConfigDeleteRequest

    Field NameTypeDescription
    keyUUIDKey

    Key indicates which DeviceOnboardingConfig instance to remove.

    This field must always be set.

    DeviceOnboardingConfigDeleteResponse

    Field NameTypeDescription
    keyUUIDKey

    Key echoes back the key of the deleted DeviceOnboardingConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    DeviceOnboardingConfigRequest

    Field NameTypeDescription
    keyUUIDKey

    Key uniquely identifies a DeviceOnboardingConfig 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.

    DeviceOnboardingConfigResponse

    Field NameTypeDescription
    valueDeviceOnboardingConfig

    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

    DeviceOnboardingConfig instance in this response.

    DeviceOnboardingConfigSetRequest

    Field NameTypeDescription
    valueDeviceOnboardingConfig

    DeviceOnboardingConfig carries the value to set into the datastore.

    See the documentation on the DeviceOnboardingConfig struct for which fields are required.

    DeviceOnboardingConfigSetResponse

    Field NameTypeDescription
    valueDeviceOnboardingConfig

    Value carries all the values given in the DeviceOnboardingConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    DeviceOnboardingConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceOnboardingConfig[…]

    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.

    DeviceOnboardingConfigStreamResponse

    Field NameTypeDescription
    valueDeviceOnboardingConfig

    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 DeviceOnboardingConfig’s last modification.

    typearista.subscriptions.Operation

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

    DeviceOnboardingRequest

    Field NameTypeDescription
    keyUUIDKey

    Key uniquely identifies a DeviceOnboarding 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.

    DeviceOnboardingResponse

    Field NameTypeDescription
    valueDeviceOnboarding

    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

    DeviceOnboarding instance in this response.

    DeviceOnboardingStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceOnboarding[…]

    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.

    DeviceOnboardingStreamResponse

    Field NameTypeDescription
    valueDeviceOnboarding

    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 DeviceOnboarding’s last modification.

    typearista.subscriptions.Operation

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

    DeviceRequest

    Field NameTypeDescription
    keyDeviceKey

    Key uniquely identifies a Device 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.

    DeviceResponse

    Field NameTypeDescription
    valueDevice

    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

    Device instance in this response.

    DeviceStreamRequest

    Field NameTypeDescription
    partial_eq_filterDevice[…]

    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.

    DeviceStreamResponse

    Field NameTypeDescription
    valueDevice

    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 Device’s last modification.

    typearista.subscriptions.Operation

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

    ProvisionedDeviceRequest

    Field NameTypeDescription
    keyDeviceKey

    Key uniquely identifies a ProvisionedDevice 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.

    ProvisionedDeviceResponse

    Field NameTypeDescription
    valueProvisionedDevice

    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

    ProvisionedDevice instance in this response.

    ProvisionedDeviceStreamRequest

    Field NameTypeDescription
    partial_eq_filterProvisionedDevice[…]

    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.

    ProvisionedDeviceStreamResponse

    Field NameTypeDescription
    valueProvisionedDevice

    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 ProvisionedDevice’s last modification.

    typearista.subscriptions.Operation

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

    DeviceDecommissioningConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceDecommissioningConfigRequestDeviceDecommissioningConfigResponse

    GetAllDeviceDecommissioningConfigStreamRequestDeviceDecommissioningConfigStreamResponse stream

    SubscribeDeviceDecommissioningConfigStreamRequestDeviceDecommissioningConfigStreamResponse stream

    SetDeviceDecommissioningConfigSetRequestDeviceDecommissioningConfigSetResponse

    DeleteDeviceDecommissioningConfigDeleteRequestDeviceDecommissioningConfigDeleteResponse

    DeleteAllDeviceDecommissioningConfigDeleteAllRequestDeviceDecommissioningConfigDeleteAllResponse stream

    DeviceDecommissioningService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceDecommissioningRequestDeviceDecommissioningResponse

    GetAllDeviceDecommissioningStreamRequestDeviceDecommissioningStreamResponse stream

    SubscribeDeviceDecommissioningStreamRequestDeviceDecommissioningStreamResponse stream

    DeviceOnboardingConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceOnboardingConfigRequestDeviceOnboardingConfigResponse

    GetAllDeviceOnboardingConfigStreamRequestDeviceOnboardingConfigStreamResponse stream

    SubscribeDeviceOnboardingConfigStreamRequestDeviceOnboardingConfigStreamResponse stream

    SetDeviceOnboardingConfigSetRequestDeviceOnboardingConfigSetResponse

    DeleteDeviceOnboardingConfigDeleteRequestDeviceOnboardingConfigDeleteResponse

    DeleteAllDeviceOnboardingConfigDeleteAllRequestDeviceOnboardingConfigDeleteAllResponse stream

    DeviceOnboardingService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceOnboardingRequestDeviceOnboardingResponse

    GetAllDeviceOnboardingStreamRequestDeviceOnboardingStreamResponse stream

    SubscribeDeviceOnboardingStreamRequestDeviceOnboardingStreamResponse stream

    DeviceService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceRequestDeviceResponse

    GetAllDeviceStreamRequestDeviceStreamResponse stream

    SubscribeDeviceStreamRequestDeviceStreamResponse stream

    ProvisionedDeviceService

    Method NameRequest TypeResponse TypeDescription
    GetOneProvisionedDeviceRequestProvisionedDeviceResponse

    GetAllProvisionedDeviceStreamRequestProvisionedDeviceStreamResponse stream

    SubscribeProvisionedDeviceStreamRequestProvisionedDeviceStreamResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/lifecycle.v1/index.html b/models/lifecycle.v1/index.html index 50eb9433..c8c122b7 100644 --- a/models/lifecycle.v1/index.html +++ b/models/lifecycle.v1/index.html @@ -1,11 +1,11 @@ lifecycle.v1 :: Arista Networks FMP APIs -

    lifecycle.v1

    Top

    arista/lifecycle.v1/lifecycle.proto

    DateAndModels

    DateAndModels has an “end of” date along with the models that has this exact “end of” date

    Field NameTypeDescription
    dategoogle.protobuf.Timestamp

    “end of” date

    modelsfmp.MapStringInt32

    models with this exact “end of” date

    mapped to its count

    DeviceLifecycleSummary

    DeviceLifecycleSummary is the state model that represents the lifecycle summary of a device

    Field NameTypeDescription
    keyDeviceLifecycleSummaryKey

    DeviceLifecycleSummaryKey is the key of

    DeviceLifecycleSummary

    software_eolSoftwareEOL

    software_eol is the software end of life of

    a device

    hardware_lifecycle_summaryHardwareLifecycleSummary

    hardware_lifecycle_summary is the hardware lifecycle summary

    of a device

    DeviceLifecycleSummaryKey

    DeviceLifecycleSummaryKey is the key type for DeviceLifecycleSummary model

    Field NameTypeDescription
    device_idgoogle.protobuf.StringValue

    device_id is the device ID

    HardwareLifecycleSummary

    HardwareLifecycleSummary represents a hardware lifecycle summary

    Field NameTypeDescription
    end_of_lifeDateAndModels

    end_of_life of a HardwareLifecycleSummary

    end_of_saleDateAndModels

    end_of_sale of a HardwareLifecycleSummary

    end_of_tac_supportDateAndModels

    end_of_tac_support of a HardwareLifecycleSummary

    end_of_hardware_rma_requestsDateAndModels

    end_of_hardware_rma_requests of a HardwareLifecycleSummary

    SoftwareEOL

    SoftwareEOL represents a software end of life

    Field NameTypeDescription
    versiongoogle.protobuf.StringValue

    version of a SoftwareEOL

    end_of_supportgoogle.protobuf.Timestamp

    end_of_support of a SoftwareEOL

    Top

    arista/lifecycle.v1/services.gen.proto

    DeviceLifecycleSummaryRequest

    Field NameTypeDescription
    keyDeviceLifecycleSummaryKey

    Key uniquely identifies a DeviceLifecycleSummary 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.

    DeviceLifecycleSummaryResponse

    Field NameTypeDescription
    valueDeviceLifecycleSummary

    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

    DeviceLifecycleSummary instance in this response.

    DeviceLifecycleSummaryStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceLifecycleSummary[…]

    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.

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

    * end: Returns the state of each DeviceLifecycleSummary at end.

    * Each DeviceLifecycleSummary response is fully-specified (all fields set).

    * start: Returns the state of each DeviceLifecycleSummary at start, followed by updates until now.

    * Each DeviceLifecycleSummary response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each DeviceLifecycleSummary at start, followed by updates

    until end.

    * Each DeviceLifecycleSummary response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    DeviceLifecycleSummaryStreamResponse

    Field NameTypeDescription
    valueDeviceLifecycleSummary

    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 DeviceLifecycleSummary’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    DeviceLifecycleSummaryService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceLifecycleSummaryRequestDeviceLifecycleSummaryResponse

    GetAllDeviceLifecycleSummaryStreamRequestDeviceLifecycleSummaryStreamResponse stream

    SubscribeDeviceLifecycleSummaryStreamRequestDeviceLifecycleSummaryStreamResponse stream

    GetMetaDeviceLifecycleSummaryStreamRequestMetaResponse

    SubscribeMetaDeviceLifecycleSummaryStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/redirector.v1/index.html b/models/redirector.v1/index.html index 257c9aa1..7de9bfab 100644 --- a/models/redirector.v1/index.html +++ b/models/redirector.v1/index.html @@ -1,10 +1,10 @@ redirector.v1 :: Arista Networks FMP APIs -

    redirector.v1

    Top

    arista/redirector.v1/redirector.proto

    Assignment

    Assignment returns the information about the regional clusters that the system is assigned to. Each cluster consists of a series of hosts, each of which the client can use to connect.

    Field NameTypeDescription
    keyAssignmentKey

    key uniquely identifies the assignment of system_id to the cluster.

    clustersClusters

    clusters that the system is assigned to.

    AssignmentKey

    AssignmentKey allows to uniquely identify an assignment.

    Field NameTypeDescription
    system_idgoogle.protobuf.StringValue

    system_id is the unique identifier of a device.

    Cluster

    Field NameTypeDescription
    namegoogle.protobuf.StringValue

    name of the cluster. The name can change over time as new clusters

    are added or removed.

    hostsfmp.RepeatedString

    hosts in the cluster that the devices can connect to.

    Clusters

    Clusters wraps a cluster list which contain the information about the hosts.

    Field NameTypeDescription
    valuesCluster[…]

    values contains the list of clusters associated with the region

    Top

    arista/redirector.v1/services.gen.proto

    AssignmentRequest

    Field NameTypeDescription
    keyAssignmentKey

    Key uniquely identifies a Assignment 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.

    AssignmentResponse

    Field NameTypeDescription
    valueAssignment

    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

    Assignment instance in this response.

    AssignmentSomeRequest

    Field NameTypeDescription
    keysAssignmentKey[…]

    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.

    AssignmentSomeResponse

    Field NameTypeDescription
    valueAssignment

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AssignmentStreamRequest

    Field NameTypeDescription
    partial_eq_filterAssignment[…]

    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.

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

    * end: Returns the state of each Assignment at end.

    * Each Assignment response is fully-specified (all fields set).

    * start: Returns the state of each Assignment at start, followed by updates until now.

    * Each Assignment response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Assignment at start, followed by updates

    until end.

    * Each Assignment response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AssignmentStreamResponse

    Field NameTypeDescription
    valueAssignment

    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 Assignment’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    AssignmentService

    Method NameRequest TypeResponse TypeDescription
    GetOneAssignmentRequestAssignmentResponse

    GetSomeAssignmentSomeRequestAssignmentSomeResponse stream

    GetAllAssignmentStreamRequestAssignmentStreamResponse stream

    SubscribeAssignmentStreamRequestAssignmentStreamResponse stream

    GetMetaAssignmentStreamRequestMetaResponse

    SubscribeMetaAssignmentStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/serviceaccount.v1/index.html b/models/serviceaccount.v1/index.html index 79a17082..8000dc75 100644 --- a/models/serviceaccount.v1/index.html +++ b/models/serviceaccount.v1/index.html @@ -1,9 +1,9 @@ serviceaccount.v1 :: Arista Networks FMP APIs -

    serviceaccount.v1

    Top

    arista/serviceaccount.v1/serviceaccount.proto

    Account

    Account describes a service account.

    Field NameTypeDescription
    keyAccountKey

    key uniquely identifies the service account.

    statusAccountStatus

    status determines whether the service account is enabled or disabled.

    descriptiongoogle.protobuf.StringValue

    description is a comment describing the service account.

    groupsfmp.RepeatedString

    groups is a list of roles that the service account inherits permissions from.

    created_bygoogle.protobuf.StringValue

    created_by is the name of the entity that created the service account.

    last_accessgoogle.protobuf.Timestamp

    last_access is the time when the service account was last fetched.

    AccountConfig

    AccountConfig holds the configuration for a service account.

    Field NameTypeDescription
    keyAccountKey

    key contains the name of the service account.

    statusAccountStatus

    status determines if the service account is enabled or disabled. New service accounts are

    enabled by default.

    descriptiongoogle.protobuf.StringValue

    description is a comment describing the service account.

    groupsfmp.RepeatedString

    groups is a list of roles that the service account inherits permissions from.

    AccountKey

    AccountKey contains the name of the service account.

    Field NameTypeDescription
    namegoogle.protobuf.StringValue

    name is the unique identifier of the service account.

    Token

    Token describes a service account token.

    Field NameTypeDescription
    keyTokenKey

    key uniquely identifies the service account token.

    usergoogle.protobuf.StringValue

    user is the name of the service account that the token is generated for.

    descriptiongoogle.protobuf.StringValue

    description is a short name or comment used to identify the service account token.

    valid_untilgoogle.protobuf.Timestamp

    valid_until is the time that the service account token will be valid until.

    created_bygoogle.protobuf.StringValue

    created_by is the name of the entity that created the service account token.

    last_usedgoogle.protobuf.Timestamp

    last_used is the time when the service account token was last used to authenticate.

    TokenConfig

    TokenConfig holds the configuration for a service account token. The token is a signed JWT which can be used as a credential for REST and WRPC endpoints.

    Field NameTypeDescription
    keyTokenKey

    key uniquely identifies the service account token.

    usergoogle.protobuf.StringValue

    user is the name of the service account that the token is generated for.

    descriptiongoogle.protobuf.StringValue

    description is a short name or comment used to identify the service account token.

    valid_forgoogle.protobuf.Duration

    valid_for determines the duration that the service account token will be valid for.

    tokengoogle.protobuf.StringValue

    token is the JWT token generated for a service account token.

    It is only populated in Set response.

    TokenKey

    TokenKey contains service account token ID.

    Field NameTypeDescription
    idgoogle.protobuf.StringValue

    id is the unique identifier of the service account token.

    AccountStatus

    AccountStatus determines whether an service account is enabled or disabled.

    NameNumberDescription
    ACCOUNT_STATUS_UNSPECIFIED0

    ACCOUNT_STATUS_UNSPECIFIED indicates the service account status is unspecified.

    ACCOUNT_STATUS_ENABLED1

    ACCOUNT_STATUS_ENABLED indicates the service account is enabled.

    ACCOUNT_STATUS_DISABLED2

    ACCOUNT_STATUS_DISABLED indicates the service account is disabled.

    Top

    arista/serviceaccount.v1/services.gen.proto

    AccountConfigDeleteAllRequest

    AccountConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyAccountKey

    This is the key of the AccountConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    AccountConfigDeleteRequest

    Field NameTypeDescription
    keyAccountKey

    Key indicates which AccountConfig instance to remove.

    This field must always be set.

    AccountConfigDeleteResponse

    Field NameTypeDescription
    keyAccountKey

    Key echoes back the key of the deleted AccountConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    AccountConfigDeleteSomeRequest

    Field NameTypeDescription
    keysAccountKey[…]

    key contains a list of AccountConfig keys to delete

    AccountConfigDeleteSomeResponse

    AccountConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyAccountKey

    errorstring

    AccountConfigRequest

    Field NameTypeDescription
    keyAccountKey

    Key uniquely identifies a AccountConfig 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.

    AccountConfigResponse

    Field NameTypeDescription
    valueAccountConfig

    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

    AccountConfig instance in this response.

    AccountConfigSetRequest

    Field NameTypeDescription
    valueAccountConfig

    AccountConfig carries the value to set into the datastore.

    See the documentation on the AccountConfig struct for which fields are required.

    AccountConfigSetResponse

    Field NameTypeDescription
    valueAccountConfig

    Value carries all the values given in the AccountConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    AccountConfigSetSomeRequest

    Field NameTypeDescription
    valuesAccountConfig[…]

    value contains a list of AccountConfig 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.

    AccountConfigSetSomeResponse

    Field NameTypeDescription
    keyAccountKey

    errorstring

    AccountConfigSomeRequest

    Field NameTypeDescription
    keysAccountKey[…]

    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.

    AccountConfigSomeResponse

    Field NameTypeDescription
    valueAccountConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AccountConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterAccountConfig[…]

    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.

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

    * end: Returns the state of each AccountConfig at end.

    * Each AccountConfig response is fully-specified (all fields set).

    * start: Returns the state of each AccountConfig at start, followed by updates until now.

    * Each AccountConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each AccountConfig at start, followed by updates

    until end.

    * Each AccountConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AccountConfigStreamResponse

    Field NameTypeDescription
    valueAccountConfig

    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 AccountConfig’s last modification.

    typearista.subscriptions.Operation

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

    AccountRequest

    Field NameTypeDescription
    keyAccountKey

    Key uniquely identifies a Account 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.

    AccountResponse

    Field NameTypeDescription
    valueAccount

    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

    Account instance in this response.

    AccountSomeRequest

    Field NameTypeDescription
    keysAccountKey[…]

    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.

    AccountSomeResponse

    Field NameTypeDescription
    valueAccount

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AccountStreamRequest

    Field NameTypeDescription
    partial_eq_filterAccount[…]

    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.

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

    * end: Returns the state of each Account at end.

    * Each Account response is fully-specified (all fields set).

    * start: Returns the state of each Account at start, followed by updates until now.

    * Each Account response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Account at start, followed by updates

    until end.

    * Each Account response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AccountStreamResponse

    Field NameTypeDescription
    valueAccount

    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 Account’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    TokenConfigDeleteAllRequest

    TokenConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTokenKey

    This is the key of the TokenConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    TokenConfigDeleteRequest

    Field NameTypeDescription
    keyTokenKey

    Key indicates which TokenConfig instance to remove.

    This field must always be set.

    TokenConfigDeleteResponse

    Field NameTypeDescription
    keyTokenKey

    Key echoes back the key of the deleted TokenConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    TokenConfigDeleteSomeRequest

    Field NameTypeDescription
    keysTokenKey[…]

    key contains a list of TokenConfig keys to delete

    TokenConfigDeleteSomeResponse

    TokenConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyTokenKey

    errorstring

    TokenConfigRequest

    Field NameTypeDescription
    keyTokenKey

    Key uniquely identifies a TokenConfig 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.

    TokenConfigResponse

    Field NameTypeDescription
    valueTokenConfig

    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

    TokenConfig instance in this response.

    TokenConfigSetRequest

    Field NameTypeDescription
    valueTokenConfig

    TokenConfig carries the value to set into the datastore.

    See the documentation on the TokenConfig struct for which fields are required.

    TokenConfigSetResponse

    Field NameTypeDescription
    valueTokenConfig

    Value carries all the values given in the TokenConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    TokenConfigSetSomeRequest

    Field NameTypeDescription
    valuesTokenConfig[…]

    value contains a list of TokenConfig 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.

    TokenConfigSetSomeResponse

    Field NameTypeDescription
    keyTokenKey

    errorstring

    TokenConfigSomeRequest

    Field NameTypeDescription
    keysTokenKey[…]

    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.

    TokenConfigSomeResponse

    Field NameTypeDescription
    valueTokenConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TokenConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterTokenConfig[…]

    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.

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

    * end: Returns the state of each TokenConfig at end.

    * Each TokenConfig response is fully-specified (all fields set).

    * start: Returns the state of each TokenConfig at start, followed by updates until now.

    * Each TokenConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each TokenConfig at start, followed by updates

    until end.

    * Each TokenConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TokenConfigStreamResponse

    Field NameTypeDescription
    valueTokenConfig

    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 TokenConfig’s last modification.

    typearista.subscriptions.Operation

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

    TokenRequest

    Field NameTypeDescription
    keyTokenKey

    Key uniquely identifies a Token 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.

    TokenResponse

    Field NameTypeDescription
    valueToken

    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

    Token instance in this response.

    TokenSomeRequest

    Field NameTypeDescription
    keysTokenKey[…]

    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.

    TokenSomeResponse

    Field NameTypeDescription
    valueToken

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TokenStreamRequest

    Field NameTypeDescription
    partial_eq_filterToken[…]

    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.

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

    * end: Returns the state of each Token at end.

    * Each Token response is fully-specified (all fields set).

    * start: Returns the state of each Token at start, followed by updates until now.

    * Each Token response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Token at start, followed by updates

    until end.

    * Each Token response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TokenStreamResponse

    Field NameTypeDescription
    valueToken

    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 Token’s last modification.

    typearista.subscriptions.Operation

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

    AccountConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneAccountConfigRequestAccountConfigResponse

    GetSomeAccountConfigSomeRequestAccountConfigSomeResponse stream

    GetAllAccountConfigStreamRequestAccountConfigStreamResponse stream

    SubscribeAccountConfigStreamRequestAccountConfigStreamResponse stream

    GetMetaAccountConfigStreamRequestMetaResponse

    SubscribeMetaAccountConfigStreamRequestMetaResponse stream

    SetAccountConfigSetRequestAccountConfigSetResponse

    SetSomeAccountConfigSetSomeRequestAccountConfigSetSomeResponse stream

    DeleteAccountConfigDeleteRequestAccountConfigDeleteResponse

    DeleteSomeAccountConfigDeleteSomeRequestAccountConfigDeleteSomeResponse stream

    DeleteAllAccountConfigDeleteAllRequestAccountConfigDeleteAllResponse stream

    AccountService

    Method NameRequest TypeResponse TypeDescription
    GetOneAccountRequestAccountResponse

    GetSomeAccountSomeRequestAccountSomeResponse stream

    GetAllAccountStreamRequestAccountStreamResponse stream

    SubscribeAccountStreamRequestAccountStreamResponse stream

    GetMetaAccountStreamRequestMetaResponse

    SubscribeMetaAccountStreamRequestMetaResponse stream

    TokenConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneTokenConfigRequestTokenConfigResponse

    GetSomeTokenConfigSomeRequestTokenConfigSomeResponse stream

    GetAllTokenConfigStreamRequestTokenConfigStreamResponse stream

    SubscribeTokenConfigStreamRequestTokenConfigStreamResponse stream

    GetMetaTokenConfigStreamRequestMetaResponse

    SubscribeMetaTokenConfigStreamRequestMetaResponse stream

    SetTokenConfigSetRequestTokenConfigSetResponse

    SetSomeTokenConfigSetSomeRequestTokenConfigSetSomeResponse stream

    DeleteTokenConfigDeleteRequestTokenConfigDeleteResponse

    DeleteSomeTokenConfigDeleteSomeRequestTokenConfigDeleteSomeResponse stream

    DeleteAllTokenConfigDeleteAllRequestTokenConfigDeleteAllResponse stream

    TokenService

    Method NameRequest TypeResponse TypeDescription
    GetOneTokenRequestTokenResponse

    GetSomeTokenSomeRequestTokenSomeResponse stream

    GetAllTokenStreamRequestTokenStreamResponse stream

    SubscribeTokenStreamRequestTokenStreamResponse stream

    GetMetaTokenStreamRequestMetaResponse

    SubscribeMetaTokenStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/studio.v1/index.html b/models/studio.v1/index.html index 2c48517a..167f6644 100644 --- a/models/studio.v1/index.html +++ b/models/studio.v1/index.html @@ -1,7 +1,7 @@ studio.v1 :: Arista Networks FMP APIs -

    studio.v1

    Top

    arista/studio.v1/studio.proto

    NOTE: This is a workspace-aware Resource API. @@ -29,4 +29,4 @@ can be specified in a studio.

    NameNumberDescription
    RESOLVER_FIELD_INPUT_MODE_UNSPECIFIED0

    RESOLVER_FIELD_INPUT_MODE_UNSPECIFIED indicates an unspecified resolver input mode.

    RESOLVER_FIELD_INPUT_MODE_SINGLE_DEVICE_TAG1

    RESOLVER_FIELD_INPUT_MODE_SINGLE_DEVICE_TAG allows devices to be

    selected based on a single tag label.

    RESOLVER_FIELD_INPUT_MODE_SINGLE_INTERFACE_TAG2

    RESOLVER_FIELD_INPUT_MODE_SINGLE_INTERFACE_TAG allows interfaces

    to be selected based on a single tag label.

    RESOLVER_FIELD_INPUT_MODE_MULTI_DEVICE_TAG3

    RESOLVER_FIELD_INPUT_MODE_MULTI_DEVICE_TAG allows devices to be

    selected based on any tag label.

    RESOLVER_FIELD_INPUT_MODE_MULTI_INTERFACE_TAG4

    RESOLVER_FIELD_INPUT_MODE_MULTI_INTERFACE_TAG allows interfaces

    to be selected based on any tag label.

    TagMatcherFieldMode

    TagMatcherFieldMode defines the set of ways a tag query for matching device or interfaces can be specified in a studio.

    NameNumberDescription
    TAG_MATCHER_FIELD_MODE_UNSPECIFIED0

    TAG_MATCHER_FIELD_MODE_UNSPECIFIED indicates an unspecified tag matcher mode.

    TAG_MATCHER_FIELD_MODE_SINGLE_DEVICE_TAG1

    TAG_MATCHER_FIELD_MODE_SINGLE_DEVICE_TAG allows devices to be

    selected based on a single tag label.

    TAG_MATCHER_FIELD_MODE_SINGLE_INTERFACE_TAG2

    TAG_MATCHER_FIELD_MODE_SINGLE_INTERFACE_TAG allows interfaces

    to be selected based on a single tag label.

    TAG_MATCHER_FIELD_MODE_MULTI_DEVICE_TAG3

    TAG_MATCHER_FIELD_MODE_MULTI_DEVICE_TAG allows devices to be

    selected based on any tag label.

    TAG_MATCHER_FIELD_MODE_MULTI_INTERFACE_TAG4

    TAG_MATCHER_FIELD_MODE_MULTI_INTERFACE_TAG allows interfaces

    to be selected based on any tag label.

    TemplateType

    TemplateType defines the set of supported languages that can be used in studio templates.

    NameNumberDescription
    TEMPLATE_TYPE_UNSPECIFIED0

    TEMPLATE_TYPE_UNSPECIFIED indicates an unspecified template type.

    TEMPLATE_TYPE_MAKO1

    TEMPLATE_TYPE_MAKO is the Mako templating language for Python.

    More information: https://www.makotemplates.org

    TEMPLATE_TYPE_JINJA2

    TEMPLATE_TYPE_JINJA is the Jinja templating language for Python.

    More information: https://palletsprojects.com/p/jinja

    TEMPLATE_TYPE_GO3

    TEMPLATE_TYPE_GO is the Go templating language.

    More information: https://pkg.go.dev/text/template

    NOTE: Not all template functions are supported for this type.

    Top

    arista/studio.v1/services.gen.proto

    AssignedTagsConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterAssignedTagsConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    AssignedTagsConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyStudioKey

    This is the key of the AssignedTagsConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    AssignedTagsConfigDeleteRequest

    Field NameTypeDescription
    keyStudioKey

    Key indicates which AssignedTagsConfig instance to remove.

    This field must always be set.

    AssignedTagsConfigDeleteResponse

    Field NameTypeDescription
    keyStudioKey

    Key echoes back the key of the deleted AssignedTagsConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    AssignedTagsConfigDeleteSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    key contains a list of AssignedTagsConfig keys to delete

    AssignedTagsConfigDeleteSomeResponse

    AssignedTagsConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyStudioKey

    errorstring

    AssignedTagsConfigRequest

    Field NameTypeDescription
    keyStudioKey

    Key uniquely identifies a AssignedTagsConfig 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.

    AssignedTagsConfigResponse

    Field NameTypeDescription
    valueAssignedTagsConfig

    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

    AssignedTagsConfig instance in this response.

    AssignedTagsConfigSetRequest

    Field NameTypeDescription
    valueAssignedTagsConfig

    AssignedTagsConfig carries the value to set into the datastore.

    See the documentation on the AssignedTagsConfig struct for which fields are required.

    AssignedTagsConfigSetResponse

    Field NameTypeDescription
    valueAssignedTagsConfig

    Value carries all the values given in the AssignedTagsConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    AssignedTagsConfigSetSomeRequest

    Field NameTypeDescription
    valuesAssignedTagsConfig[…]

    value contains a list of AssignedTagsConfig 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.

    AssignedTagsConfigSetSomeResponse

    Field NameTypeDescription
    keyStudioKey

    errorstring

    AssignedTagsConfigSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    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.

    AssignedTagsConfigSomeResponse

    Field NameTypeDescription
    valueAssignedTagsConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AssignedTagsConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterAssignedTagsConfig[…]

    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.

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

    * end: Returns the state of each AssignedTagsConfig at end.

    * Each AssignedTagsConfig response is fully-specified (all fields set).

    * start: Returns the state of each AssignedTagsConfig at start, followed by updates until now.

    * Each AssignedTagsConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each AssignedTagsConfig at start, followed by updates

    until end.

    * Each AssignedTagsConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AssignedTagsConfigStreamResponse

    Field NameTypeDescription
    valueAssignedTagsConfig

    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 AssignedTagsConfig’s last modification.

    typearista.subscriptions.Operation

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

    AssignedTagsRequest

    Field NameTypeDescription
    keyStudioKey

    Key uniquely identifies a AssignedTags 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.

    AssignedTagsResponse

    Field NameTypeDescription
    valueAssignedTags

    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

    AssignedTags instance in this response.

    AssignedTagsSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    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.

    AssignedTagsSomeResponse

    Field NameTypeDescription
    valueAssignedTags

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AssignedTagsStreamRequest

    Field NameTypeDescription
    partial_eq_filterAssignedTags[…]

    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.

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

    * end: Returns the state of each AssignedTags at end.

    * Each AssignedTags response is fully-specified (all fields set).

    * start: Returns the state of each AssignedTags at start, followed by updates until now.

    * Each AssignedTags response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each AssignedTags at start, followed by updates

    until end.

    * Each AssignedTags response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AssignedTagsStreamResponse

    Field NameTypeDescription
    valueAssignedTags

    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 AssignedTags’s last modification.

    typearista.subscriptions.Operation

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

    AutofillActionConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterAutofillActionConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    AutofillActionConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyAutofillActionKey

    This is the key of the AutofillActionConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    AutofillActionConfigDeleteRequest

    Field NameTypeDescription
    keyAutofillActionKey

    Key indicates which AutofillActionConfig instance to remove.

    This field must always be set.

    AutofillActionConfigDeleteResponse

    Field NameTypeDescription
    keyAutofillActionKey

    Key echoes back the key of the deleted AutofillActionConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    AutofillActionConfigDeleteSomeRequest

    Field NameTypeDescription
    keysAutofillActionKey[…]

    key contains a list of AutofillActionConfig keys to delete

    AutofillActionConfigDeleteSomeResponse

    AutofillActionConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyAutofillActionKey

    errorstring

    AutofillActionConfigRequest

    Field NameTypeDescription
    keyAutofillActionKey

    Key uniquely identifies a AutofillActionConfig 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.

    AutofillActionConfigResponse

    Field NameTypeDescription
    valueAutofillActionConfig

    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

    AutofillActionConfig instance in this response.

    AutofillActionConfigSetRequest

    Field NameTypeDescription
    valueAutofillActionConfig

    AutofillActionConfig carries the value to set into the datastore.

    See the documentation on the AutofillActionConfig struct for which fields are required.

    AutofillActionConfigSetResponse

    Field NameTypeDescription
    valueAutofillActionConfig

    Value carries all the values given in the AutofillActionConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    AutofillActionConfigSetSomeRequest

    Field NameTypeDescription
    valuesAutofillActionConfig[…]

    value contains a list of AutofillActionConfig 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.

    AutofillActionConfigSetSomeResponse

    Field NameTypeDescription
    keyAutofillActionKey

    errorstring

    AutofillActionConfigSomeRequest

    Field NameTypeDescription
    keysAutofillActionKey[…]

    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.

    AutofillActionConfigSomeResponse

    Field NameTypeDescription
    valueAutofillActionConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AutofillActionConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterAutofillActionConfig[…]

    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.

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

    * end: Returns the state of each AutofillActionConfig at end.

    * Each AutofillActionConfig response is fully-specified (all fields set).

    * start: Returns the state of each AutofillActionConfig at start, followed by updates until now.

    * Each AutofillActionConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each AutofillActionConfig at start, followed by updates

    until end.

    * Each AutofillActionConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AutofillActionConfigStreamResponse

    Field NameTypeDescription
    valueAutofillActionConfig

    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 AutofillActionConfig’s last modification.

    typearista.subscriptions.Operation

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

    AutofillActionRequest

    Field NameTypeDescription
    keyAutofillActionKey

    Key uniquely identifies a AutofillAction 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.

    AutofillActionResponse

    Field NameTypeDescription
    valueAutofillAction

    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

    AutofillAction instance in this response.

    AutofillActionSomeRequest

    Field NameTypeDescription
    keysAutofillActionKey[…]

    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.

    AutofillActionSomeResponse

    Field NameTypeDescription
    valueAutofillAction

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    AutofillActionStreamRequest

    Field NameTypeDescription
    partial_eq_filterAutofillAction[…]

    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.

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

    * end: Returns the state of each AutofillAction at end.

    * Each AutofillAction response is fully-specified (all fields set).

    * start: Returns the state of each AutofillAction at start, followed by updates until now.

    * Each AutofillAction response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each AutofillAction at start, followed by updates

    until end.

    * Each AutofillAction response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    AutofillActionStreamResponse

    Field NameTypeDescription
    valueAutofillAction

    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 AutofillAction’s last modification.

    typearista.subscriptions.Operation

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

    InputsConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterInputsConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    InputsConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyInputsKey

    This is the key of the InputsConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    InputsConfigDeleteRequest

    Field NameTypeDescription
    keyInputsKey

    Key indicates which InputsConfig instance to remove.

    This field must always be set.

    InputsConfigDeleteResponse

    Field NameTypeDescription
    keyInputsKey

    Key echoes back the key of the deleted InputsConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    InputsConfigDeleteSomeRequest

    Field NameTypeDescription
    keysInputsKey[…]

    key contains a list of InputsConfig keys to delete

    InputsConfigDeleteSomeResponse

    InputsConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyInputsKey

    errorstring

    InputsConfigRequest

    Field NameTypeDescription
    keyInputsKey

    Key uniquely identifies a InputsConfig 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.

    InputsConfigResponse

    Field NameTypeDescription
    valueInputsConfig

    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

    InputsConfig instance in this response.

    InputsConfigSetRequest

    Field NameTypeDescription
    valueInputsConfig

    InputsConfig carries the value to set into the datastore.

    See the documentation on the InputsConfig struct for which fields are required.

    InputsConfigSetResponse

    Field NameTypeDescription
    valueInputsConfig

    Value carries all the values given in the InputsConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    InputsConfigSetSomeRequest

    Field NameTypeDescription
    valuesInputsConfig[…]

    value contains a list of InputsConfig 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.

    InputsConfigSetSomeResponse

    Field NameTypeDescription
    keyInputsKey

    errorstring

    InputsConfigSomeRequest

    Field NameTypeDescription
    keysInputsKey[…]

    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.

    InputsConfigSomeResponse

    Field NameTypeDescription
    valueInputsConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    InputsConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterInputsConfig[…]

    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.

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

    * end: Returns the state of each InputsConfig at end.

    * Each InputsConfig response is fully-specified (all fields set).

    * start: Returns the state of each InputsConfig at start, followed by updates until now.

    * Each InputsConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each InputsConfig at start, followed by updates

    until end.

    * Each InputsConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    InputsConfigStreamResponse

    Field NameTypeDescription
    valueInputsConfig

    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 InputsConfig’s last modification.

    typearista.subscriptions.Operation

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

    InputsRequest

    Field NameTypeDescription
    keyInputsKey

    Key uniquely identifies a Inputs 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.

    InputsResponse

    Field NameTypeDescription
    valueInputs

    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

    Inputs instance in this response.

    InputsSomeRequest

    Field NameTypeDescription
    keysInputsKey[…]

    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.

    InputsSomeResponse

    Field NameTypeDescription
    valueInputs

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    InputsStreamRequest

    Field NameTypeDescription
    partial_eq_filterInputs[…]

    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.

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

    * end: Returns the state of each Inputs at end.

    * Each Inputs response is fully-specified (all fields set).

    * start: Returns the state of each Inputs at start, followed by updates until now.

    * Each Inputs response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Inputs at start, followed by updates

    until end.

    * Each Inputs response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    InputsStreamResponse

    Field NameTypeDescription
    valueInputs

    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 Inputs’s last modification.

    typearista.subscriptions.Operation

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

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    SecretInputRequest

    Field NameTypeDescription
    keyInputsKey

    Key uniquely identifies a SecretInput 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.

    SecretInputResponse

    Field NameTypeDescription
    valueSecretInput

    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

    SecretInput instance in this response.

    SecretInputSomeRequest

    Field NameTypeDescription
    keysInputsKey[…]

    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.

    SecretInputSomeResponse

    Field NameTypeDescription
    valueSecretInput

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    SecretInputStreamRequest

    Field NameTypeDescription
    partial_eq_filterSecretInput[…]

    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.

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

    * end: Returns the state of each SecretInput at end.

    * Each SecretInput response is fully-specified (all fields set).

    * start: Returns the state of each SecretInput at start, followed by updates until now.

    * Each SecretInput response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each SecretInput at start, followed by updates

    until end.

    * Each SecretInput response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    SecretInputStreamResponse

    Field NameTypeDescription
    valueSecretInput

    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 SecretInput’s last modification.

    typearista.subscriptions.Operation

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

    StudioConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterStudioConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    StudioConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyStudioKey

    This is the key of the StudioConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    StudioConfigDeleteRequest

    Field NameTypeDescription
    keyStudioKey

    Key indicates which StudioConfig instance to remove.

    This field must always be set.

    StudioConfigDeleteResponse

    Field NameTypeDescription
    keyStudioKey

    Key echoes back the key of the deleted StudioConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    StudioConfigDeleteSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    key contains a list of StudioConfig keys to delete

    StudioConfigDeleteSomeResponse

    StudioConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyStudioKey

    errorstring

    StudioConfigRequest

    Field NameTypeDescription
    keyStudioKey

    Key uniquely identifies a StudioConfig 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.

    StudioConfigResponse

    Field NameTypeDescription
    valueStudioConfig

    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

    StudioConfig instance in this response.

    StudioConfigSetRequest

    Field NameTypeDescription
    valueStudioConfig

    StudioConfig carries the value to set into the datastore.

    See the documentation on the StudioConfig struct for which fields are required.

    StudioConfigSetResponse

    Field NameTypeDescription
    valueStudioConfig

    Value carries all the values given in the StudioConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    StudioConfigSetSomeRequest

    Field NameTypeDescription
    valuesStudioConfig[…]

    value contains a list of StudioConfig 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.

    StudioConfigSetSomeResponse

    Field NameTypeDescription
    keyStudioKey

    errorstring

    StudioConfigSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    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.

    StudioConfigSomeResponse

    Field NameTypeDescription
    valueStudioConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    StudioConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterStudioConfig[…]

    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.

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

    * end: Returns the state of each StudioConfig at end.

    * Each StudioConfig response is fully-specified (all fields set).

    * start: Returns the state of each StudioConfig at start, followed by updates until now.

    * Each StudioConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each StudioConfig at start, followed by updates

    until end.

    * Each StudioConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    StudioConfigStreamResponse

    Field NameTypeDescription
    valueStudioConfig

    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 StudioConfig’s last modification.

    typearista.subscriptions.Operation

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

    StudioRequest

    Field NameTypeDescription
    keyStudioKey

    Key uniquely identifies a Studio 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.

    StudioResponse

    Field NameTypeDescription
    valueStudio

    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

    Studio instance in this response.

    StudioSomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    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.

    StudioSomeResponse

    Field NameTypeDescription
    valueStudio

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    StudioStreamRequest

    Field NameTypeDescription
    partial_eq_filterStudio[…]

    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.

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

    * end: Returns the state of each Studio at end.

    * Each Studio response is fully-specified (all fields set).

    * start: Returns the state of each Studio at start, followed by updates until now.

    * Each Studio response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Studio at start, followed by updates

    until end.

    * Each Studio response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    StudioStreamResponse

    Field NameTypeDescription
    valueStudio

    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 Studio’s last modification.

    typearista.subscriptions.Operation

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

    StudioSummaryRequest

    Field NameTypeDescription
    keyStudioKey

    Key uniquely identifies a StudioSummary 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.

    StudioSummaryResponse

    Field NameTypeDescription
    valueStudioSummary

    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

    StudioSummary instance in this response.

    StudioSummarySomeRequest

    Field NameTypeDescription
    keysStudioKey[…]

    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.

    StudioSummarySomeResponse

    Field NameTypeDescription
    valueStudioSummary

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    StudioSummaryStreamRequest

    Field NameTypeDescription
    partial_eq_filterStudioSummary[…]

    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.

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

    * end: Returns the state of each StudioSummary at end.

    * Each StudioSummary response is fully-specified (all fields set).

    * start: Returns the state of each StudioSummary at start, followed by updates until now.

    * Each StudioSummary response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each StudioSummary at start, followed by updates

    until end.

    * Each StudioSummary response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    StudioSummaryStreamResponse

    Field NameTypeDescription
    valueStudioSummary

    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 StudioSummary’s last modification.

    typearista.subscriptions.Operation

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

    AssignedTagsConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneAssignedTagsConfigRequestAssignedTagsConfigResponse

    GetSomeAssignedTagsConfigSomeRequestAssignedTagsConfigSomeResponse stream

    GetAllAssignedTagsConfigStreamRequestAssignedTagsConfigStreamResponse stream

    SubscribeAssignedTagsConfigStreamRequestAssignedTagsConfigStreamResponse stream

    GetMetaAssignedTagsConfigStreamRequestMetaResponse

    SubscribeMetaAssignedTagsConfigStreamRequestMetaResponse stream

    SetAssignedTagsConfigSetRequestAssignedTagsConfigSetResponse

    SetSomeAssignedTagsConfigSetSomeRequestAssignedTagsConfigSetSomeResponse stream

    DeleteAssignedTagsConfigDeleteRequestAssignedTagsConfigDeleteResponse

    DeleteSomeAssignedTagsConfigDeleteSomeRequestAssignedTagsConfigDeleteSomeResponse stream

    DeleteAllAssignedTagsConfigDeleteAllRequestAssignedTagsConfigDeleteAllResponse stream

    AssignedTagsService

    Method NameRequest TypeResponse TypeDescription
    GetOneAssignedTagsRequestAssignedTagsResponse

    GetSomeAssignedTagsSomeRequestAssignedTagsSomeResponse stream

    GetAllAssignedTagsStreamRequestAssignedTagsStreamResponse stream

    SubscribeAssignedTagsStreamRequestAssignedTagsStreamResponse stream

    GetMetaAssignedTagsStreamRequestMetaResponse

    SubscribeMetaAssignedTagsStreamRequestMetaResponse stream

    AutofillActionConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneAutofillActionConfigRequestAutofillActionConfigResponse

    GetSomeAutofillActionConfigSomeRequestAutofillActionConfigSomeResponse stream

    GetAllAutofillActionConfigStreamRequestAutofillActionConfigStreamResponse stream

    SubscribeAutofillActionConfigStreamRequestAutofillActionConfigStreamResponse stream

    GetMetaAutofillActionConfigStreamRequestMetaResponse

    SubscribeMetaAutofillActionConfigStreamRequestMetaResponse stream

    SetAutofillActionConfigSetRequestAutofillActionConfigSetResponse

    SetSomeAutofillActionConfigSetSomeRequestAutofillActionConfigSetSomeResponse stream

    DeleteAutofillActionConfigDeleteRequestAutofillActionConfigDeleteResponse

    DeleteSomeAutofillActionConfigDeleteSomeRequestAutofillActionConfigDeleteSomeResponse stream

    DeleteAllAutofillActionConfigDeleteAllRequestAutofillActionConfigDeleteAllResponse stream

    AutofillActionService

    Method NameRequest TypeResponse TypeDescription
    GetOneAutofillActionRequestAutofillActionResponse

    GetSomeAutofillActionSomeRequestAutofillActionSomeResponse stream

    GetAllAutofillActionStreamRequestAutofillActionStreamResponse stream

    SubscribeAutofillActionStreamRequestAutofillActionStreamResponse stream

    GetMetaAutofillActionStreamRequestMetaResponse

    SubscribeMetaAutofillActionStreamRequestMetaResponse stream

    InputsConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneInputsConfigRequestInputsConfigResponse

    GetSomeInputsConfigSomeRequestInputsConfigSomeResponse stream

    GetAllInputsConfigStreamRequestInputsConfigStreamResponse stream

    SubscribeInputsConfigStreamRequestInputsConfigStreamResponse stream

    GetMetaInputsConfigStreamRequestMetaResponse

    SubscribeMetaInputsConfigStreamRequestMetaResponse stream

    SetInputsConfigSetRequestInputsConfigSetResponse

    SetSomeInputsConfigSetSomeRequestInputsConfigSetSomeResponse stream

    DeleteInputsConfigDeleteRequestInputsConfigDeleteResponse

    DeleteSomeInputsConfigDeleteSomeRequestInputsConfigDeleteSomeResponse stream

    DeleteAllInputsConfigDeleteAllRequestInputsConfigDeleteAllResponse stream

    InputsService

    Method NameRequest TypeResponse TypeDescription
    GetOneInputsRequestInputsResponse

    GetSomeInputsSomeRequestInputsSomeResponse stream

    GetAllInputsStreamRequestInputsStreamResponse stream

    SubscribeInputsStreamRequestInputsStreamResponse stream

    GetMetaInputsStreamRequestMetaResponse

    SubscribeMetaInputsStreamRequestMetaResponse stream

    SecretInputService

    Method NameRequest TypeResponse TypeDescription
    GetOneSecretInputRequestSecretInputResponse

    GetSomeSecretInputSomeRequestSecretInputSomeResponse stream

    GetAllSecretInputStreamRequestSecretInputStreamResponse stream

    SubscribeSecretInputStreamRequestSecretInputStreamResponse stream

    GetMetaSecretInputStreamRequestMetaResponse

    SubscribeMetaSecretInputStreamRequestMetaResponse stream

    StudioConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneStudioConfigRequestStudioConfigResponse

    GetSomeStudioConfigSomeRequestStudioConfigSomeResponse stream

    GetAllStudioConfigStreamRequestStudioConfigStreamResponse stream

    SubscribeStudioConfigStreamRequestStudioConfigStreamResponse stream

    GetMetaStudioConfigStreamRequestMetaResponse

    SubscribeMetaStudioConfigStreamRequestMetaResponse stream

    SetStudioConfigSetRequestStudioConfigSetResponse

    SetSomeStudioConfigSetSomeRequestStudioConfigSetSomeResponse stream

    DeleteStudioConfigDeleteRequestStudioConfigDeleteResponse

    DeleteSomeStudioConfigDeleteSomeRequestStudioConfigDeleteSomeResponse stream

    DeleteAllStudioConfigDeleteAllRequestStudioConfigDeleteAllResponse stream

    StudioService

    Method NameRequest TypeResponse TypeDescription
    GetOneStudioRequestStudioResponse

    GetSomeStudioSomeRequestStudioSomeResponse stream

    GetAllStudioStreamRequestStudioStreamResponse stream

    SubscribeStudioStreamRequestStudioStreamResponse stream

    GetMetaStudioStreamRequestMetaResponse

    SubscribeMetaStudioStreamRequestMetaResponse stream

    StudioSummaryService

    Method NameRequest TypeResponse TypeDescription
    GetOneStudioSummaryRequestStudioSummaryResponse

    GetSomeStudioSummarySomeRequestStudioSummarySomeResponse stream

    GetAllStudioSummaryStreamRequestStudioSummaryStreamResponse stream

    SubscribeStudioSummaryStreamRequestStudioSummaryStreamResponse stream

    GetMetaStudioSummaryStreamRequestMetaResponse

    SubscribeMetaStudioSummaryStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/tag.v1/index.html b/models/tag.v1/index.html index e226635f..71a189d1 100644 --- a/models/tag.v1/index.html +++ b/models/tag.v1/index.html @@ -1,7 +1,7 @@ tag.v1 :: Arista Networks FMP APIs -

    tag.v1

    **DEPRECATED: This API is no longer supported.

    Top

    arista/tag.v1/tag.proto

    DeviceTag

    DeviceTag is a label-value pair that may or may not @@ -13,4 +13,4 @@ to a specific interface.

    Field NameTypeDescription
    keyInterfaceTagAssignmentKey

    Key uniquely identifies the interface tag assignment.

    InterfaceTagAssignmentKey

    InterfaceTagAssignmentKey uniquely identifies an interface tag assignment.

    Field NameTypeDescription
    labelgoogle.protobuf.StringValue

    Label is the label of the tag.

    valuegoogle.protobuf.StringValue

    Value is the value of the tag.

    device_idgoogle.protobuf.StringValue

    DeviceId is the ID of the interface’s device.

    interface_idgoogle.protobuf.StringValue

    InterfaceId is the ID of the interface.

    InterfaceTagConfig

    InterfaceTagConfig is a label-value pair that may or may not be assigned to an interface.

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies the interface tag.

    TagKey

    TagKey uniquely identifies a tag for a network element.

    Field NameTypeDescription
    labelgoogle.protobuf.StringValue

    Label is the label of the tag.

    valuegoogle.protobuf.StringValue

    Value is the value of the tag.

    CreatorType

    CreatorType specifies an entity that creates something.

    NameNumberDescription
    CREATOR_TYPE_UNSPECIFIED0

    CREATOR_TYPE_SYSTEM1

    CREATOR_TYPE_SYSTEM is the type for something created by the system.

    CREATOR_TYPE_USER2

    CREATOR_TYPE_USER is the type for something created by a user.

    Top

    arista/tag.v1/services.gen.proto

    DeviceTagAssignmentConfigDeleteAllRequest

    DeviceTagAssignmentConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyDeviceTagAssignmentKey

    This is the key of the DeviceTagAssignmentConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    DeviceTagAssignmentConfigDeleteRequest

    Field NameTypeDescription
    keyDeviceTagAssignmentKey

    Key indicates which DeviceTagAssignmentConfig instance to remove.

    This field must always be set.

    DeviceTagAssignmentConfigDeleteResponse

    Field NameTypeDescription
    keyDeviceTagAssignmentKey

    Key echoes back the key of the deleted DeviceTagAssignmentConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    DeviceTagAssignmentConfigRequest

    Field NameTypeDescription
    keyDeviceTagAssignmentKey

    Key uniquely identifies a DeviceTagAssignmentConfig 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.

    DeviceTagAssignmentConfigResponse

    Field NameTypeDescription
    valueDeviceTagAssignmentConfig

    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

    DeviceTagAssignmentConfig instance in this response.

    DeviceTagAssignmentConfigSetRequest

    Field NameTypeDescription
    valueDeviceTagAssignmentConfig

    DeviceTagAssignmentConfig carries the value to set into the datastore.

    See the documentation on the DeviceTagAssignmentConfig struct for which fields are required.

    DeviceTagAssignmentConfigSetResponse

    Field NameTypeDescription
    valueDeviceTagAssignmentConfig

    Value carries all the values given in the DeviceTagAssignmentConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    DeviceTagAssignmentConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceTagAssignmentConfig[…]

    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.

    DeviceTagAssignmentConfigStreamResponse

    Field NameTypeDescription
    valueDeviceTagAssignmentConfig

    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 DeviceTagAssignmentConfig’s last modification.

    typearista.subscriptions.Operation

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

    DeviceTagConfigDeleteAllRequest

    DeviceTagConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTagKey

    This is the key of the DeviceTagConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    DeviceTagConfigDeleteRequest

    Field NameTypeDescription
    keyTagKey

    Key indicates which DeviceTagConfig instance to remove.

    This field must always be set.

    DeviceTagConfigDeleteResponse

    Field NameTypeDescription
    keyTagKey

    Key echoes back the key of the deleted DeviceTagConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    DeviceTagConfigRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a DeviceTagConfig 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.

    DeviceTagConfigResponse

    Field NameTypeDescription
    valueDeviceTagConfig

    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

    DeviceTagConfig instance in this response.

    DeviceTagConfigSetRequest

    Field NameTypeDescription
    valueDeviceTagConfig

    DeviceTagConfig carries the value to set into the datastore.

    See the documentation on the DeviceTagConfig struct for which fields are required.

    DeviceTagConfigSetResponse

    Field NameTypeDescription
    valueDeviceTagConfig

    Value carries all the values given in the DeviceTagConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    DeviceTagConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceTagConfig[…]

    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.

    DeviceTagConfigStreamResponse

    Field NameTypeDescription
    valueDeviceTagConfig

    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 DeviceTagConfig’s last modification.

    typearista.subscriptions.Operation

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

    DeviceTagRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a DeviceTag 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.

    DeviceTagResponse

    Field NameTypeDescription
    valueDeviceTag

    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

    DeviceTag instance in this response.

    DeviceTagStreamRequest

    Field NameTypeDescription
    partial_eq_filterDeviceTag[…]

    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.

    DeviceTagStreamResponse

    Field NameTypeDescription
    valueDeviceTag

    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 DeviceTag’s last modification.

    typearista.subscriptions.Operation

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

    InterfaceTagAssignmentConfigDeleteAllRequest

    InterfaceTagAssignmentConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyInterfaceTagAssignmentKey

    This is the key of the InterfaceTagAssignmentConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    InterfaceTagAssignmentConfigDeleteRequest

    Field NameTypeDescription
    keyInterfaceTagAssignmentKey

    Key indicates which InterfaceTagAssignmentConfig instance to remove.

    This field must always be set.

    InterfaceTagAssignmentConfigDeleteResponse

    Field NameTypeDescription
    keyInterfaceTagAssignmentKey

    Key echoes back the key of the deleted InterfaceTagAssignmentConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    InterfaceTagAssignmentConfigRequest

    Field NameTypeDescription
    keyInterfaceTagAssignmentKey

    Key uniquely identifies a InterfaceTagAssignmentConfig 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.

    InterfaceTagAssignmentConfigResponse

    Field NameTypeDescription
    valueInterfaceTagAssignmentConfig

    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

    InterfaceTagAssignmentConfig instance in this response.

    InterfaceTagAssignmentConfigSetRequest

    Field NameTypeDescription
    valueInterfaceTagAssignmentConfig

    InterfaceTagAssignmentConfig carries the value to set into the datastore.

    See the documentation on the InterfaceTagAssignmentConfig struct for which fields are required.

    InterfaceTagAssignmentConfigSetResponse

    Field NameTypeDescription
    valueInterfaceTagAssignmentConfig

    Value carries all the values given in the InterfaceTagAssignmentConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    InterfaceTagAssignmentConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterInterfaceTagAssignmentConfig[…]

    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.

    InterfaceTagAssignmentConfigStreamResponse

    Field NameTypeDescription
    valueInterfaceTagAssignmentConfig

    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 InterfaceTagAssignmentConfig’s last modification.

    typearista.subscriptions.Operation

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

    InterfaceTagConfigDeleteAllRequest

    InterfaceTagConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTagKey

    This is the key of the InterfaceTagConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    InterfaceTagConfigDeleteRequest

    Field NameTypeDescription
    keyTagKey

    Key indicates which InterfaceTagConfig instance to remove.

    This field must always be set.

    InterfaceTagConfigDeleteResponse

    Field NameTypeDescription
    keyTagKey

    Key echoes back the key of the deleted InterfaceTagConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    InterfaceTagConfigRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a InterfaceTagConfig 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.

    InterfaceTagConfigResponse

    Field NameTypeDescription
    valueInterfaceTagConfig

    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

    InterfaceTagConfig instance in this response.

    InterfaceTagConfigSetRequest

    Field NameTypeDescription
    valueInterfaceTagConfig

    InterfaceTagConfig carries the value to set into the datastore.

    See the documentation on the InterfaceTagConfig struct for which fields are required.

    InterfaceTagConfigSetResponse

    Field NameTypeDescription
    valueInterfaceTagConfig

    Value carries all the values given in the InterfaceTagConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    InterfaceTagConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterInterfaceTagConfig[…]

    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.

    InterfaceTagConfigStreamResponse

    Field NameTypeDescription
    valueInterfaceTagConfig

    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 InterfaceTagConfig’s last modification.

    typearista.subscriptions.Operation

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

    InterfaceTagRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a InterfaceTag 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.

    InterfaceTagResponse

    Field NameTypeDescription
    valueInterfaceTag

    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

    InterfaceTag instance in this response.

    InterfaceTagStreamRequest

    Field NameTypeDescription
    partial_eq_filterInterfaceTag[…]

    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.

    InterfaceTagStreamResponse

    Field NameTypeDescription
    valueInterfaceTag

    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 InterfaceTag’s last modification.

    typearista.subscriptions.Operation

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

    DeviceTagAssignmentConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceTagAssignmentConfigRequestDeviceTagAssignmentConfigResponse

    GetAllDeviceTagAssignmentConfigStreamRequestDeviceTagAssignmentConfigStreamResponse stream

    SubscribeDeviceTagAssignmentConfigStreamRequestDeviceTagAssignmentConfigStreamResponse stream

    SetDeviceTagAssignmentConfigSetRequestDeviceTagAssignmentConfigSetResponse

    DeleteDeviceTagAssignmentConfigDeleteRequestDeviceTagAssignmentConfigDeleteResponse

    DeleteAllDeviceTagAssignmentConfigDeleteAllRequestDeviceTagAssignmentConfigDeleteAllResponse stream

    DeviceTagConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceTagConfigRequestDeviceTagConfigResponse

    GetAllDeviceTagConfigStreamRequestDeviceTagConfigStreamResponse stream

    SubscribeDeviceTagConfigStreamRequestDeviceTagConfigStreamResponse stream

    SetDeviceTagConfigSetRequestDeviceTagConfigSetResponse

    DeleteDeviceTagConfigDeleteRequestDeviceTagConfigDeleteResponse

    DeleteAllDeviceTagConfigDeleteAllRequestDeviceTagConfigDeleteAllResponse stream

    DeviceTagService

    Method NameRequest TypeResponse TypeDescription
    GetOneDeviceTagRequestDeviceTagResponse

    GetAllDeviceTagStreamRequestDeviceTagStreamResponse stream

    SubscribeDeviceTagStreamRequestDeviceTagStreamResponse stream

    InterfaceTagAssignmentConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneInterfaceTagAssignmentConfigRequestInterfaceTagAssignmentConfigResponse

    GetAllInterfaceTagAssignmentConfigStreamRequestInterfaceTagAssignmentConfigStreamResponse stream

    SubscribeInterfaceTagAssignmentConfigStreamRequestInterfaceTagAssignmentConfigStreamResponse stream

    SetInterfaceTagAssignmentConfigSetRequestInterfaceTagAssignmentConfigSetResponse

    DeleteInterfaceTagAssignmentConfigDeleteRequestInterfaceTagAssignmentConfigDeleteResponse

    DeleteAllInterfaceTagAssignmentConfigDeleteAllRequestInterfaceTagAssignmentConfigDeleteAllResponse stream

    InterfaceTagConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneInterfaceTagConfigRequestInterfaceTagConfigResponse

    GetAllInterfaceTagConfigStreamRequestInterfaceTagConfigStreamResponse stream

    SubscribeInterfaceTagConfigStreamRequestInterfaceTagConfigStreamResponse stream

    SetInterfaceTagConfigSetRequestInterfaceTagConfigSetResponse

    DeleteInterfaceTagConfigDeleteRequestInterfaceTagConfigDeleteResponse

    DeleteAllInterfaceTagConfigDeleteAllRequestInterfaceTagConfigDeleteAllResponse stream

    InterfaceTagService

    Method NameRequest TypeResponse TypeDescription
    GetOneInterfaceTagRequestInterfaceTagResponse

    GetAllInterfaceTagStreamRequestInterfaceTagStreamResponse stream

    SubscribeInterfaceTagStreamRequestInterfaceTagStreamResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/tag.v2/index.html b/models/tag.v2/index.html index f89f4443..bdd8e6f8 100644 --- a/models/tag.v2/index.html +++ b/models/tag.v2/index.html @@ -1,7 +1,7 @@ tag.v2 :: Arista Networks FMP APIs -

    tag.v2

    Top

    arista/tag.v2/tag.proto

    Tag

    Tag holds a merge-preview or the existing merged state (if the @@ -17,4 +17,4 @@ a tag.

    NameNumberDescription
    CREATOR_TYPE_UNSPECIFIED0

    CREATOR_TYPE_UNSPECIFIED is the default value.

    CREATOR_TYPE_SYSTEM1

    CREATOR_TYPE_SYSTEM is used for system tags.

    CREATOR_TYPE_USER2

    CREATOR_TYPE_USER is used for user tags.

    CREATOR_TYPE_EXTERNAL3

    CREATOR_TYPE_EXTERNAL is used for tags created from external sources.

    For E.g., vCenter

    ElementSubType

    ElementSubType enumerates the sub-types of network elements that can be associated with tags.

    NameNumberDescription
    ELEMENT_SUB_TYPE_UNSPECIFIED0

    ELEMENT_SUB_TYPE_UNSPECIFIED is the default value.

    ELEMENT_SUB_TYPE_DEVICE1

    ELEMENT_SUB_TYPE_DEVICE is used for EOS or

    third-party devices discovered via LLDP/SNMP.

    ELEMENT_SUB_TYPE_VDS2

    ELEMENT_SUB_TYPE_VDS is used for VMWare vSphere Distributed Switch (VDS) tags.

    ELEMENT_SUB_TYPE_WORKLOAD_SERVER3

    ELEMENT_SUB_TYPE_WORKLOAD_SERVER is used for workload server

    tags (such as VMWare ESXi host).

    A workload server is a server/data storage device on which

    the hypervisor is installed.

    ELEMENT_SUB_TYPE_VM4

    ELEMENT_SUB_TYPE_VM is used for VM tags.

    A VM is a software computer that, like a physical computer,

    runs an operating system and applications.

    ElementType

    ElementType enumerates the types of network elements that can be associated with tags.

    NameNumberDescription
    ELEMENT_TYPE_UNSPECIFIED0

    ELEMENT_TYPE_UNSPECIFIED is the default value.

    ELEMENT_TYPE_DEVICE1

    ELEMENT_TYPE_DEVICE is used for device tags.

    ELEMENT_TYPE_INTERFACE2

    ELEMENT_TYPE_INTERFACE is used for interface tags.

    Top

    arista/tag.v2/services.gen.proto

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    TagAssignmentConfigDeleteAllRequest

    TagAssignmentConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTagAssignmentKey

    This is the key of the TagAssignmentConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    TagAssignmentConfigDeleteRequest

    Field NameTypeDescription
    keyTagAssignmentKey

    Key indicates which TagAssignmentConfig instance to remove.

    This field must always be set.

    TagAssignmentConfigDeleteResponse

    Field NameTypeDescription
    keyTagAssignmentKey

    Key echoes back the key of the deleted TagAssignmentConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    TagAssignmentConfigDeleteSomeRequest

    Field NameTypeDescription
    keysTagAssignmentKey[…]

    key contains a list of TagAssignmentConfig keys to delete

    TagAssignmentConfigDeleteSomeResponse

    TagAssignmentConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyTagAssignmentKey

    errorstring

    TagAssignmentConfigRequest

    Field NameTypeDescription
    keyTagAssignmentKey

    Key uniquely identifies a TagAssignmentConfig 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.

    TagAssignmentConfigResponse

    Field NameTypeDescription
    valueTagAssignmentConfig

    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

    TagAssignmentConfig instance in this response.

    TagAssignmentConfigSetRequest

    Field NameTypeDescription
    valueTagAssignmentConfig

    TagAssignmentConfig carries the value to set into the datastore.

    See the documentation on the TagAssignmentConfig struct for which fields are required.

    TagAssignmentConfigSetResponse

    Field NameTypeDescription
    valueTagAssignmentConfig

    Value carries all the values given in the TagAssignmentConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    TagAssignmentConfigSetSomeRequest

    Field NameTypeDescription
    valuesTagAssignmentConfig[…]

    value contains a list of TagAssignmentConfig 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.

    TagAssignmentConfigSetSomeResponse

    Field NameTypeDescription
    keyTagAssignmentKey

    errorstring

    TagAssignmentConfigSomeRequest

    Field NameTypeDescription
    keysTagAssignmentKey[…]

    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.

    TagAssignmentConfigSomeResponse

    Field NameTypeDescription
    valueTagAssignmentConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TagAssignmentConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterTagAssignmentConfig[…]

    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.

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

    * end: Returns the state of each TagAssignmentConfig at end.

    * Each TagAssignmentConfig response is fully-specified (all fields set).

    * start: Returns the state of each TagAssignmentConfig at start, followed by updates until now.

    * Each TagAssignmentConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each TagAssignmentConfig at start, followed by updates

    until end.

    * Each TagAssignmentConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TagAssignmentConfigStreamResponse

    Field NameTypeDescription
    valueTagAssignmentConfig

    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 TagAssignmentConfig’s last modification.

    typearista.subscriptions.Operation

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

    TagAssignmentRequest

    Field NameTypeDescription
    keyTagAssignmentKey

    Key uniquely identifies a TagAssignment 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.

    TagAssignmentResponse

    Field NameTypeDescription
    valueTagAssignment

    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

    TagAssignment instance in this response.

    TagAssignmentSomeRequest

    Field NameTypeDescription
    keysTagAssignmentKey[…]

    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.

    TagAssignmentSomeResponse

    Field NameTypeDescription
    valueTagAssignment

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TagAssignmentStreamRequest

    Field NameTypeDescription
    partial_eq_filterTagAssignment[…]

    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.

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

    * end: Returns the state of each TagAssignment at end.

    * Each TagAssignment response is fully-specified (all fields set).

    * start: Returns the state of each TagAssignment at start, followed by updates until now.

    * Each TagAssignment response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each TagAssignment at start, followed by updates

    until end.

    * Each TagAssignment response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TagAssignmentStreamResponse

    Field NameTypeDescription
    valueTagAssignment

    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 TagAssignment’s last modification.

    typearista.subscriptions.Operation

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

    TagConfigDeleteAllRequest

    TagConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyTagKey

    This is the key of the TagConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    TagConfigDeleteRequest

    Field NameTypeDescription
    keyTagKey

    Key indicates which TagConfig instance to remove.

    This field must always be set.

    TagConfigDeleteResponse

    Field NameTypeDescription
    keyTagKey

    Key echoes back the key of the deleted TagConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    TagConfigDeleteSomeRequest

    Field NameTypeDescription
    keysTagKey[…]

    key contains a list of TagConfig keys to delete

    TagConfigDeleteSomeResponse

    TagConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyTagKey

    errorstring

    TagConfigRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a TagConfig 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.

    TagConfigResponse

    Field NameTypeDescription
    valueTagConfig

    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

    TagConfig instance in this response.

    TagConfigSetRequest

    Field NameTypeDescription
    valueTagConfig

    TagConfig carries the value to set into the datastore.

    See the documentation on the TagConfig struct for which fields are required.

    TagConfigSetResponse

    Field NameTypeDescription
    valueTagConfig

    Value carries all the values given in the TagConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    TagConfigSetSomeRequest

    Field NameTypeDescription
    valuesTagConfig[…]

    value contains a list of TagConfig 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.

    TagConfigSetSomeResponse

    Field NameTypeDescription
    keyTagKey

    errorstring

    TagConfigSomeRequest

    Field NameTypeDescription
    keysTagKey[…]

    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.

    TagConfigSomeResponse

    Field NameTypeDescription
    valueTagConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TagConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterTagConfig[…]

    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.

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

    * end: Returns the state of each TagConfig at end.

    * Each TagConfig response is fully-specified (all fields set).

    * start: Returns the state of each TagConfig at start, followed by updates until now.

    * Each TagConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each TagConfig at start, followed by updates

    until end.

    * Each TagConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TagConfigStreamResponse

    Field NameTypeDescription
    valueTagConfig

    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 TagConfig’s last modification.

    typearista.subscriptions.Operation

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

    TagRequest

    Field NameTypeDescription
    keyTagKey

    Key uniquely identifies a Tag 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.

    TagResponse

    Field NameTypeDescription
    valueTag

    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

    Tag instance in this response.

    TagSomeRequest

    Field NameTypeDescription
    keysTagKey[…]

    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.

    TagSomeResponse

    Field NameTypeDescription
    valueTag

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    TagStreamRequest

    Field NameTypeDescription
    partial_eq_filterTag[…]

    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.

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

    * end: Returns the state of each Tag at end.

    * Each Tag response is fully-specified (all fields set).

    * start: Returns the state of each Tag at start, followed by updates until now.

    * Each Tag response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Tag at start, followed by updates

    until end.

    * Each Tag response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    TagStreamResponse

    Field NameTypeDescription
    valueTag

    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 Tag’s last modification.

    typearista.subscriptions.Operation

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

    TagAssignmentConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneTagAssignmentConfigRequestTagAssignmentConfigResponse

    GetSomeTagAssignmentConfigSomeRequestTagAssignmentConfigSomeResponse stream

    GetAllTagAssignmentConfigStreamRequestTagAssignmentConfigStreamResponse stream

    SubscribeTagAssignmentConfigStreamRequestTagAssignmentConfigStreamResponse stream

    GetMetaTagAssignmentConfigStreamRequestMetaResponse

    SubscribeMetaTagAssignmentConfigStreamRequestMetaResponse stream

    SetTagAssignmentConfigSetRequestTagAssignmentConfigSetResponse

    SetSomeTagAssignmentConfigSetSomeRequestTagAssignmentConfigSetSomeResponse stream

    DeleteTagAssignmentConfigDeleteRequestTagAssignmentConfigDeleteResponse

    DeleteSomeTagAssignmentConfigDeleteSomeRequestTagAssignmentConfigDeleteSomeResponse stream

    DeleteAllTagAssignmentConfigDeleteAllRequestTagAssignmentConfigDeleteAllResponse stream

    TagAssignmentService

    Method NameRequest TypeResponse TypeDescription
    GetOneTagAssignmentRequestTagAssignmentResponse

    GetSomeTagAssignmentSomeRequestTagAssignmentSomeResponse stream

    GetAllTagAssignmentStreamRequestTagAssignmentStreamResponse stream

    SubscribeTagAssignmentStreamRequestTagAssignmentStreamResponse stream

    GetMetaTagAssignmentStreamRequestMetaResponse

    SubscribeMetaTagAssignmentStreamRequestMetaResponse stream

    TagConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneTagConfigRequestTagConfigResponse

    GetSomeTagConfigSomeRequestTagConfigSomeResponse stream

    GetAllTagConfigStreamRequestTagConfigStreamResponse stream

    SubscribeTagConfigStreamRequestTagConfigStreamResponse stream

    GetMetaTagConfigStreamRequestMetaResponse

    SubscribeMetaTagConfigStreamRequestMetaResponse stream

    SetTagConfigSetRequestTagConfigSetResponse

    SetSomeTagConfigSetSomeRequestTagConfigSetSomeResponse stream

    DeleteTagConfigDeleteRequestTagConfigDeleteResponse

    DeleteSomeTagConfigDeleteSomeRequestTagConfigDeleteSomeResponse stream

    DeleteAllTagConfigDeleteAllRequestTagConfigDeleteAllResponse stream

    TagService

    Method NameRequest TypeResponse TypeDescription
    GetOneTagRequestTagResponse

    GetSomeTagSomeRequestTagSomeResponse stream

    GetAllTagStreamRequestTagStreamResponse stream

    SubscribeTagStreamRequestTagStreamResponse stream

    GetMetaTagStreamRequestMetaResponse

    SubscribeMetaTagStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/models/workspace.v1/index.html b/models/workspace.v1/index.html index c7ee475f..f74ea712 100644 --- a/models/workspace.v1/index.html +++ b/models/workspace.v1/index.html @@ -1,7 +1,7 @@ workspace.v1 :: Arista Networks FMP APIs -

    workspace.v1

    Top

    arista/workspace.v1/workspace.proto

    AuthzResult

    AuthzResult has the result of the authorization check for workspace changes.

    Field NameTypeDescription
    has_unauthorized_tag_changegoogle.protobuf.BoolValue

    has_unauthorized_tag_change is true when there is a tag assignment that results

    in change in permissions and the subject is not authorized to do it.

    has_unauthorized_device_changegoogle.protobuf.BoolValue

    has_unauthorized_device_change is true when there is atleast 1 device

    for which the subject doesn’t have provision permission.

    errorgoogle.protobuf.StringValue

    error is an error message that is set when either of the above values

    are true.

    BuildStageState

    BuildStageState holds the state per build stage.

    Field NameTypeDescription
    valuesBuildStageState.ValuesEntry[…]

    values is a map from build stage to build state.

    The possible keys to this map are BUILD_STAGE_UNSPECIFIED,

    BUILD_STAGE_INPUT_VALIDATION, BUILD_STAGE_CONFIGLET_BUILD,

    BUILD_STAGE_CONFIG_VALIDATION and BUILD_STAGE_IMAGE_VALIDATION.

    BuildStageState.ValuesEntry

    Field NameTypeDescription
    keystring

    valueBuildState

    ConfigValidationResult

    ConfigValidationResult holds the result of a config validation stage.

    Field NameTypeDescription
    summaryarista.configstatus.v1.ConfigSummary

    summary is a summary of the changes to the previous config.

    errorsarista.configstatus.v1.ConfigErrors

    errors are any errors detected in the generated config.

    warningsarista.configstatus.v1.ConfigErrors

    warnings are any warnings about the generated config.

    config_sourcesarista.configstatus.v1.ConfigSources

    config_sources identify the entities that generated the config.

    ConfigletBuildResult

    ConfigletBuildResult holds the result of a configlet build stage.

    Field NameTypeDescription
    template_errorsTemplateErrors

    template_errors are errors that occured during studio template evaluation.

    generated_configgoogle.protobuf.StringValue

    generated_config is the EOS CLI config that was generated from the stage.

    other_errorgoogle.protobuf.StringValue

    other_error is any other miscellaneous error.

    execution_idgoogle.protobuf.StringValue

    execution_id is the unique ID for the execution of the template. This ID

    can be used to retrieve logs generated by the template.

    input_errorsInputErrors

    input_errors are errors in input fields that are raised by the template.

    ConfigletBuildResults

    ConfigletBuildResults is a collection of ConfigletBuildResult (one per studio).

    Field NameTypeDescription
    valuesConfigletBuildResults.ValuesEntry[…]

    values is a map from studio ID to ConfigletBuildResult.

    ConfigletBuildResults.ValuesEntry

    Field NameTypeDescription
    keystring

    valueConfigletBuildResult

    ImageValidationResult

    ImageValidationResult holds the result of an image validation stage.

    Field NameTypeDescription
    summaryarista.imagestatus.v1.ImageSummary

    summary is a summary of the changes to the previous image.

    errorsarista.imagestatus.v1.ImageErrors

    errors are any errors detected in the generated image.

    warningsarista.imagestatus.v1.ImageWarnings

    warnings are any warnings about the generated image.

    image_input_errorgoogle.protobuf.StringValue

    image_input_error indicates any errors in image inputs.

    InputError

    InputError holds the details for an error on a studio input field or value.

    Field NameTypeDescription
    field_idgoogle.protobuf.StringValue

    field_id is the ID of the input field.

    pathfmp.RepeatedString

    path is the path leading up to the input field.

    membersfmp.RepeatedString

    members are the members of the input field (if it is a group).

    messagegoogle.protobuf.StringValue

    message is the error message.

    InputErrors

    InputErrors is a list of InputError.

    Field NameTypeDescription
    valuesInputError[…]

    values is a list of InputError.

    InputValidationResult

    InputValidationResult holds the result of an input validation build stage.

    Field NameTypeDescription
    input_schema_errorsInputErrors

    input_schema_errors are errors for fields in the input schema.

    input_value_errorsInputErrors

    input_value_errors are errors for values assigned to fields in the input schema.

    other_errorsfmp.RepeatedString

    other_errors are other miscellaneous errors.

    InputValidationResults

    InputValidationResults is a collection of InputValidationResult (one per studio).

    Field NameTypeDescription
    valuesInputValidationResults.ValuesEntry[…]

    values is map from studio ID to InputValidationResult.

    InputValidationResults.ValuesEntry

    Field NameTypeDescription
    keystring

    valueInputValidationResult

    RequestParams

    RequestParams define the parameters for a Request.

    Field NameTypeDescription
    request_idgoogle.protobuf.StringValue

    request_id is the unique ID of the request. This is used to identify

    the Response for the request in Responses.

    Response

    Response is a response to a Request.

    Field NameTypeDescription
    statusResponseStatus

    status is the execution status of the response.

    messagegoogle.protobuf.StringValue

    message is a string that provides more details about the response.

    codeResponseCode

    code is the code of the response.

    Responses

    Responses is a collection of responses for completed requests.

    Field NameTypeDescription
    valuesResponses.ValuesEntry[…]

    values is a map from request ID to Response.

    Responses.ValuesEntry

    Field NameTypeDescription
    keystring

    valueResponse

    TemplateError

    TemplateError holds details for an error that occured while evaluating a studio @@ -12,4 +12,4 @@ validation stage.

    NameNumberDescription
    IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED0

    IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates image validation skip cause is

    unspecified.

    IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE1

    IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped

    because the device is not streaming.

    IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED2

    IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was

    skipped because the device is pre-provisioned.

    IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED3

    IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED indicates that the stage was

    skipped because the device has no image changes in the workspace.

    Request

    Request enumerates the set of asynchronous operations that can be performed on a workspace.

    NameNumberDescription
    REQUEST_UNSPECIFIED0

    REQUEST_UNSPECIFIED describes unspecified request.

    REQUEST_START_BUILD1

    REQUEST_START_BUILD describes a request to start building a workspace. This kicks

    of a multi-stage operation to compile and validate the changes in a workspace (see

    BuildStage for more details).

    REQUEST_CANCEL_BUILD2

    REQUEST_CANCEL_BUILD describes a request to stop building a workspace.

    REQUEST_SUBMIT3

    REQUEST_SUBMIT describes a request to submit a workspace to the mainline. Before

    submission, some checks are made that can cause the request to fail. E.g., if there

    is a modified configuration for a non-streaming device in the workspace, then the

    request will fail. Once submitted, changes are applied and change controls are

    created (if necessary).

    REQUEST_ABANDON4

    REQUEST_ABANDON describes a request to abandon a workspace. This operation does

    not delete the workspace from the system, but closes it to any further updates.

    REQUEST_ROLLBACK5

    REQUEST_ROLLBACK describes a request to rollback a submitted workspace, undoing

    corresponding changes in the mainline.

    REQUEST_SUBMIT_FORCE6

    REQUEST_SUBMIT_FORCE describes a request to submit a workspace without making any

    checks that could normally cause the submission to fail. See REQUEST_SUBMIT for

    more details.

    REQUEST_REBASE7

    REQUEST_REBASE describes a request to rebase a workspace. This operation updates

    workspace state to reflect the latest mainline content, and re-applies workspace

    changes on top of that.

    ResponseCode

    ResponseCode is a code for a Response indicating a particular scenario.

    NameNumberDescription
    RESPONSE_CODE_UNSPECIFIED0

    RESPONSE_CODE_UNSPECIFIED indicates unspecified response code.

    RESPONSE_CODE_INACTIVE_DEVICES_EXIST1

    RESPONSE_CODE_INACTIVE_DEVICES_EXIST indicates that there are devices that have inactive

    streaming status.

    ResponseStatus

    ResponseStatus enumerates the set of execution statuses of a Response.

    NameNumberDescription
    RESPONSE_STATUS_UNSPECIFIED0

    RESPONSE_STATUS_UNSPECIFIED indicates unspecified response status.

    RESPONSE_STATUS_SUCCESS1

    RESPONSE_STATUS_SUCCESS indicates that the original Request was successful

    in its execution.

    RESPONSE_STATUS_FAIL2

    RESPONSE_STATUS_FAIL indicates that the original Request was unsuccessful

    in its execution.

    WorkspaceState

    WorkspaceState enumerates the general states of a workspace. Some of these states are derived as a result of executing a specific request on the workspace (see Request).

    NameNumberDescription
    WORKSPACE_STATE_UNSPECIFIED0

    WORKSPACE_STATE_UNSPECIFIED indicates unspecified workspace state.

    WORKSPACE_STATE_PENDING1

    WORKSPACE_STATE_PENDING indicates that the changes in the workspace are open and

    have not been submitted.

    WORKSPACE_STATE_SUBMITTED2

    WORKSPACE_STATE_SUBMITTED indicates that the changes in the workspace have been

    submitted to the mainline.

    WORKSPACE_STATE_ABANDONED3

    WORKSPACE_STATE_ABANDONED indicates that the workspace has been intentionally

    closed, and may no longer be updated.

    WORKSPACE_STATE_CONFLICTS4

    WORKSPACE_STATE_CONFLICTS indicates that the changes in the workspace are in

    conflict with the current state of the system.

    WORKSPACE_STATE_ROLLED_BACK5

    WORKSPACE_STATE_ROLLED_BACK indicates that the workspace was submitted, but

    has been rolled back (the changes have been undone).

    Top

    arista/workspace.v1/services.gen.proto

    MetaResponse

    Field NameTypeDescription
    timegoogle.protobuf.Timestamp

    Time holds the timestamp of the last item included in the metadata calculation.

    typearista.subscriptions.Operation

    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.

    countgoogle.protobuf.UInt32Value

    Count is the number of items present under the conditions of the request.

    WorkspaceBuildDetailsRequest

    Field NameTypeDescription
    keyWorkspaceBuildDetailsKey

    Key uniquely identifies a WorkspaceBuildDetails 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.

    WorkspaceBuildDetailsResponse

    Field NameTypeDescription
    valueWorkspaceBuildDetails

    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

    WorkspaceBuildDetails instance in this response.

    WorkspaceBuildDetailsSomeRequest

    Field NameTypeDescription
    keysWorkspaceBuildDetailsKey[…]

    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.

    WorkspaceBuildDetailsSomeResponse

    Field NameTypeDescription
    valueWorkspaceBuildDetails

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    WorkspaceBuildDetailsStreamRequest

    Field NameTypeDescription
    partial_eq_filterWorkspaceBuildDetails[…]

    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.

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

    * end: Returns the state of each WorkspaceBuildDetails at end.

    * Each WorkspaceBuildDetails response is fully-specified (all fields set).

    * start: Returns the state of each WorkspaceBuildDetails at start, followed by updates until now.

    * Each WorkspaceBuildDetails response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each WorkspaceBuildDetails at start, followed by updates

    until end.

    * Each WorkspaceBuildDetails response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    WorkspaceBuildDetailsStreamResponse

    Field NameTypeDescription
    valueWorkspaceBuildDetails

    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 WorkspaceBuildDetails’s last modification.

    typearista.subscriptions.Operation

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

    WorkspaceBuildRequest

    Field NameTypeDescription
    keyWorkspaceBuildKey

    Key uniquely identifies a WorkspaceBuild 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.

    WorkspaceBuildResponse

    Field NameTypeDescription
    valueWorkspaceBuild

    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

    WorkspaceBuild instance in this response.

    WorkspaceBuildSomeRequest

    Field NameTypeDescription
    keysWorkspaceBuildKey[…]

    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.

    WorkspaceBuildSomeResponse

    Field NameTypeDescription
    valueWorkspaceBuild

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    WorkspaceBuildStreamRequest

    Field NameTypeDescription
    partial_eq_filterWorkspaceBuild[…]

    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.

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

    * end: Returns the state of each WorkspaceBuild at end.

    * Each WorkspaceBuild response is fully-specified (all fields set).

    * start: Returns the state of each WorkspaceBuild at start, followed by updates until now.

    * Each WorkspaceBuild response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each WorkspaceBuild at start, followed by updates

    until end.

    * Each WorkspaceBuild response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    WorkspaceBuildStreamResponse

    Field NameTypeDescription
    valueWorkspaceBuild

    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 WorkspaceBuild’s last modification.

    typearista.subscriptions.Operation

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

    WorkspaceConfigDeleteAllRequest

    Field NameTypeDescription
    partial_eq_filterWorkspaceConfig[…]

    PartialEqFilter provides a way to server-side filter a DeleteAll.

    This requires all provided fields to be equal to the response.

    A filtered DeleteAll will use GetAll with filter to find things to delete.

    WorkspaceConfigDeleteAllResponse

    Field NameTypeDescription
    typefmp.DeleteError

    This describes the class of delete error.

    A DeleteAllResponse is only sent when there is an error.

    errorgoogle.protobuf.StringValue

    This indicates the error message from the delete failure.

    keyWorkspaceKey

    This is the key of the WorkspaceConfig instance that failed to be deleted.

    timegoogle.protobuf.Timestamp

    Time indicates the (UTC) timestamp when the key was being deleted.

    WorkspaceConfigDeleteRequest

    Field NameTypeDescription
    keyWorkspaceKey

    Key indicates which WorkspaceConfig instance to remove.

    This field must always be set.

    WorkspaceConfigDeleteResponse

    Field NameTypeDescription
    keyWorkspaceKey

    Key echoes back the key of the deleted WorkspaceConfig instance.

    timegoogle.protobuf.Timestamp

    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.

    WorkspaceConfigDeleteSomeRequest

    Field NameTypeDescription
    keysWorkspaceKey[…]

    key contains a list of WorkspaceConfig keys to delete

    WorkspaceConfigDeleteSomeResponse

    WorkspaceConfigDeleteSomeResponse is only sent when there is an error.

    Field NameTypeDescription
    keyWorkspaceKey

    errorstring

    WorkspaceConfigRequest

    Field NameTypeDescription
    keyWorkspaceKey

    Key uniquely identifies a WorkspaceConfig 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.

    WorkspaceConfigResponse

    Field NameTypeDescription
    valueWorkspaceConfig

    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

    WorkspaceConfig instance in this response.

    WorkspaceConfigSetRequest

    Field NameTypeDescription
    valueWorkspaceConfig

    WorkspaceConfig carries the value to set into the datastore.

    See the documentation on the WorkspaceConfig struct for which fields are required.

    WorkspaceConfigSetResponse

    Field NameTypeDescription
    valueWorkspaceConfig

    Value carries all the values given in the WorkspaceConfigSetRequest as well

    as any server-generated values.

    timegoogle.protobuf.Timestamp

    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.

    WorkspaceConfigSetSomeRequest

    Field NameTypeDescription
    valuesWorkspaceConfig[…]

    value contains a list of WorkspaceConfig 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.

    WorkspaceConfigSetSomeResponse

    Field NameTypeDescription
    keyWorkspaceKey

    errorstring

    WorkspaceConfigSomeRequest

    Field NameTypeDescription
    keysWorkspaceKey[…]

    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.

    WorkspaceConfigSomeResponse

    Field NameTypeDescription
    valueWorkspaceConfig

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    WorkspaceConfigStreamRequest

    Field NameTypeDescription
    partial_eq_filterWorkspaceConfig[…]

    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.

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

    * end: Returns the state of each WorkspaceConfig at end.

    * Each WorkspaceConfig response is fully-specified (all fields set).

    * start: Returns the state of each WorkspaceConfig at start, followed by updates until now.

    * Each WorkspaceConfig response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each WorkspaceConfig at start, followed by updates

    until end.

    * Each WorkspaceConfig response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    WorkspaceConfigStreamResponse

    Field NameTypeDescription
    valueWorkspaceConfig

    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 WorkspaceConfig’s last modification.

    typearista.subscriptions.Operation

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

    WorkspaceRequest

    Field NameTypeDescription
    keyWorkspaceKey

    Key uniquely identifies a Workspace 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.

    WorkspaceResponse

    Field NameTypeDescription
    valueWorkspace

    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

    Workspace instance in this response.

    WorkspaceSomeRequest

    Field NameTypeDescription
    keysWorkspaceKey[…]

    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.

    WorkspaceSomeResponse

    Field NameTypeDescription
    valueWorkspace

    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.

    errorgoogle.protobuf.StringValue

    Error is an optional field.

    It should be filled when there is an error in the GetSome process.

    timegoogle.protobuf.Timestamp

    WorkspaceStreamRequest

    Field NameTypeDescription
    partial_eq_filterWorkspace[…]

    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.

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

    * end: Returns the state of each Workspace at end.

    * Each Workspace response is fully-specified (all fields set).

    * start: Returns the state of each Workspace at start, followed by updates until now.

    * Each Workspace response at start is fully-specified, but updates may be partial.

    * start and end: Returns the state of each Workspace at start, followed by updates

    until end.

    * Each Workspace response at start is fully-specified, but updates until end may

    be partial.

    This field is not allowed in the Subscribe RPC.

    WorkspaceStreamResponse

    Field NameTypeDescription
    valueWorkspace

    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 Workspace’s last modification.

    typearista.subscriptions.Operation

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

    WorkspaceBuildDetailsService

    Method NameRequest TypeResponse TypeDescription
    GetOneWorkspaceBuildDetailsRequestWorkspaceBuildDetailsResponse

    GetSomeWorkspaceBuildDetailsSomeRequestWorkspaceBuildDetailsSomeResponse stream

    GetAllWorkspaceBuildDetailsStreamRequestWorkspaceBuildDetailsStreamResponse stream

    SubscribeWorkspaceBuildDetailsStreamRequestWorkspaceBuildDetailsStreamResponse stream

    GetMetaWorkspaceBuildDetailsStreamRequestMetaResponse

    SubscribeMetaWorkspaceBuildDetailsStreamRequestMetaResponse stream

    WorkspaceBuildService

    Method NameRequest TypeResponse TypeDescription
    GetOneWorkspaceBuildRequestWorkspaceBuildResponse

    GetSomeWorkspaceBuildSomeRequestWorkspaceBuildSomeResponse stream

    GetAllWorkspaceBuildStreamRequestWorkspaceBuildStreamResponse stream

    SubscribeWorkspaceBuildStreamRequestWorkspaceBuildStreamResponse stream

    GetMetaWorkspaceBuildStreamRequestMetaResponse

    SubscribeMetaWorkspaceBuildStreamRequestMetaResponse stream

    WorkspaceConfigService

    Method NameRequest TypeResponse TypeDescription
    GetOneWorkspaceConfigRequestWorkspaceConfigResponse

    GetSomeWorkspaceConfigSomeRequestWorkspaceConfigSomeResponse stream

    GetAllWorkspaceConfigStreamRequestWorkspaceConfigStreamResponse stream

    SubscribeWorkspaceConfigStreamRequestWorkspaceConfigStreamResponse stream

    GetMetaWorkspaceConfigStreamRequestMetaResponse

    SubscribeMetaWorkspaceConfigStreamRequestMetaResponse stream

    SetWorkspaceConfigSetRequestWorkspaceConfigSetResponse

    SetSomeWorkspaceConfigSetSomeRequestWorkspaceConfigSetSomeResponse stream

    DeleteWorkspaceConfigDeleteRequestWorkspaceConfigDeleteResponse

    DeleteSomeWorkspaceConfigDeleteSomeRequestWorkspaceConfigDeleteSomeResponse stream

    DeleteAllWorkspaceConfigDeleteAllRequestWorkspaceConfigDeleteAllResponse stream

    WorkspaceService

    Method NameRequest TypeResponse TypeDescription
    GetOneWorkspaceRequestWorkspaceResponse

    GetSomeWorkspaceSomeRequestWorkspaceSomeResponse stream

    GetAllWorkspaceStreamRequestWorkspaceStreamResponse stream

    SubscribeWorkspaceStreamRequestWorkspaceStreamResponse stream

    GetMetaWorkspaceStreamRequestMetaResponse

    SubscribeMetaWorkspaceStreamRequestMetaResponse stream

    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/delete/index.html b/rpcs/delete/index.html index f71639ff..8f5e3408 100644 --- a/rpcs/delete/index.html +++ b/rpcs/delete/index.html @@ -1,7 +1,7 @@ Delete :: Arista Networks FMP APIs -

    Delete

    Delete deletes a resource and returns the time the delete became effective.

    The Key field is required to be fully-specified because Delete needs to identify exactly-one @@ -24,4 +24,4 @@ google.protobuf.Timestamp time = 2; };

    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/errors/index.html b/rpcs/errors/index.html index e5c9a057..a5ca0840 100644 --- a/rpcs/errors/index.html +++ b/rpcs/errors/index.html @@ -1,7 +1,7 @@ Error Handling :: Arista Networks FMP APIs -

    Error Handling

    Errors returned by the API follow the gRPC status code guidelines. This provides many niceties:

    1. Language-native idioms (exceptions, return codes, etc.)
    2. Easily mappable to HTTP error codes (used for HTTP access to RPCs)
    3. Uses metadata rather than a global schema for more detailed errors

    Example: Go

    Unary RPCs

    resp, err := example.GetOne(ExampleConfigRequest{Key: key})
@@ -37,4 +37,4 @@
   print('GetAll failed: {0}: {1}'.format(e.code(), e.details()))
   raise e
    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/filtering/index.html b/rpcs/filtering/index.html index 9e5a2be7..89537bef 100644 --- a/rpcs/filtering/index.html +++ b/rpcs/filtering/index.html @@ -1,7 +1,7 @@ Filtering :: Arista Networks FMP APIs -

    Filtering

    Filtering is provided through a default and an (optional) additional model-specific mechanism. By default, all models support “partial equality filtering”. Models that provide a custom filtering method will document this filter-message in its model documentation.

    Partial-Equality Filters

    Unless intentionally disabled (and sufficiently documented), services provide a default filtering mechanism. The input type is the same as the model you are filtering, and if you wish to filter on a given field you set that field to non-nil.

    Given:

    • response: the model that may or may not be sent to the client
    • filter: a single filter model (request allows giving multiple)

    For every response in the stream, we iterate the filter list. If the filter has a field set to non-null we compare it to the response’s field value. If the values are equal we continue to the next field in the filter. If the field values do not match we “fail” the filter and move on to the next filter in the list.

    If a response fails all filters, it is not sent to the client.

    If a response succeeds any filter, it is sent to the client.

    Service-Specific Filtering

    Models are allowed to also contain an “implementation specific” filter which can be more targeted, featureful, or otherwise helpful.

    This filter type will be defined in the protobuf definition. This type should be well documented in the protobuf as well as generated documentation.

    message CustomFilteredStreamRequest {
@@ -12,4 +12,4 @@
 
   ...
    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/getall/index.html b/rpcs/getall/index.html index 230147f3..a21561aa 100644 --- a/rpcs/getall/index.html +++ b/rpcs/getall/index.html @@ -1,7 +1,7 @@ GetAll :: Arista Networks FMP APIs -

    GetAll

    GetAll fetches (and optionally filters) all resource instances.

    For the filtering options available, see the Filtering section. @@ -33,4 +33,4 @@ google.protobuf.Timestamp end = 2; }

    The fields start and end can be used in the following combinations:

    • end: returns the state of resources at end.
      • responds with only fully-specified models
    • start: returns the state of resources at start and updates until now.
      • returns all fully-specified models as of the start time, and then all subsequent changes/partials/diffs
    • start and end: returns the state of resources at start as well as any changes until end.
      • same semantics as start alone, but only changes up to the end time
    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/getone/index.html b/rpcs/getone/index.html index b8016652..8c165e32 100644 --- a/rpcs/getone/index.html +++ b/rpcs/getone/index.html @@ -1,7 +1,7 @@ GetOne :: Arista Networks FMP APIs -

    GetOne

    GetOne returns a single instance of a resource.

    The Key field is required to be fully-specified because GetOne needs to identify exactly-one @@ -33,4 +33,4 @@ google.protobuf.Timestamp time = 2; };

    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/index.html b/rpcs/index.html index 45263e05..9cc6d7dd 100644 --- a/rpcs/index.html +++ b/rpcs/index.html @@ -1,7 +1,7 @@ Uniform RPCs :: Arista Networks FMP APIs -

    Uniform RPCs

    As stated previously, APIs are accesible over gRPC with a standardized set of RPCs.

    These methods will behave consistently across models.

    Read Methods

    All readable models have the following RPC signatures:

    service ExampleConfigService {
@@ -14,4 +14,4 @@
   rpc Delete (ExampleConfigDeleteRequest) returns (ExampleConfigDeleteResponse);
 }

    The ExampleConfigSetRequest, ExampleConfigSetResponse, ExampleConfigDeleteRequest, and ExampleConfigDeleteResponse are generated wrappers for a given model (ExampleConfig, in this example). By generating these wrappers we provide further consistency in request parameters.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/set/index.html b/rpcs/set/index.html index 4446a78f..63abdbd0 100644 --- a/rpcs/set/index.html +++ b/rpcs/set/index.html @@ -1,7 +1,7 @@ Set :: Arista Networks FMP APIs -

    Set

    Set updates a resource. Updates can be whole or partial (see: nullable fields) using only fields populated in the request.

    The Key field is required to be fully-specified because Set needs to identify exactly-one @@ -192,4 +192,4 @@ } }

    \ No newline at end of file +
    \ No newline at end of file diff --git a/rpcs/subscribe/index.html b/rpcs/subscribe/index.html index cb82e4f6..429471be 100644 --- a/rpcs/subscribe/index.html +++ b/rpcs/subscribe/index.html @@ -1,7 +1,7 @@ Subscribe :: Arista Networks FMP APIs -

    Subscribe

    Subscribe first returns the initial state (fully-specified messages) and then any received updates.

    The first messages received are effectively the result of a GetAll). @@ -10,4 +10,4 @@ arista.subscriptions.Operation enum field on the StreamResponse type for the given resource. This enum can be found here.

    The flow of messages follows these steps:

    1. N messages with arista.subscriptions.Operation::INITIAL
    2. One message with arista.subscriptions.Operation::INITIAL_SYNC_COMPLETE
      • this signifies the transition from initial data to udpates
      • prevents the client from needing to hold the last operation to find transition point
    3. N messages with either:
      • arista.subscriptions.Operation::UPDATED
      • arista.subscriptions.Operation::DELETED
      • these can happen in any order or frequency until the subscription/connection is closed

    RPC Definition

    The protobuf definition of GetAll is defined as such (for ExampleConfig):

    rpc Subscribe (ExampleConfigStreamRequest) returns (stream ExampleConfigStreamResponse);
    \ No newline at end of file +
    \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 0b1556bd..8c019b35 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,7 +1,7 @@ Tags :: Arista Networks FMP APIs -

    taxonomy :: -Tags

      \ No newline at end of file +Tags
      \ No newline at end of file