arista_portal.v1

Version: 1.1.0

Available Services

    APIProxyConfigService

    APIProxyService

    APITokenConfigService

    APITokenService

• arista/arista_portal.v1/arista_portal.proto
  • APIProxy
  • APIProxyConfig
  • APIToken
  • APITokenConfig
• arista/arista_portal.v1/services.gen.proto

  • APIProxyConfigDeleteRequest

  • APIProxyConfigDeleteResponse

  • APIProxyConfigRequest

  • APIProxyConfigResponse

  • APIProxyConfigSetRequest

  • APIProxyConfigSetResponse

  • APIProxyConfigStreamRequest

  • APIProxyConfigStreamResponse

  • APIProxyRequest

  • APIProxyResponse

  • APIProxyStreamRequest

  • APIProxyStreamResponse

  • APITokenConfigDeleteRequest

  • APITokenConfigDeleteResponse

  • APITokenConfigRequest

  • APITokenConfigResponse

  • APITokenConfigSetRequest

  • APITokenConfigSetResponse

  • APITokenConfigStreamRequest

  • APITokenConfigStreamResponse

  • APITokenRequest

  • APITokenResponse

  • APITokenStreamRequest

  • APITokenStreamResponse

  • MetaResponse

  • APIProxyConfigService

  • APIProxyService

  • APITokenConfigService

  • APITokenService

Top

arista/arista_portal.v1/arista_portal.proto

APIProxy

APIProxy is the state model that displays the proxy url string value set and found on the CloudVision instance.

APIProxy Methods:

The GetOne method is used to return a proxy with username and password obscured that has been set within CloudVision.

Retrieving a proxy:

The proxy can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a proxy being retrieved

GetOne(APIProxy{
})

NOTE: Proxy configuration is not applicable to CloudVision-as-a-Service.

• If a proxy contains a username and/or password, it will be returned with the credentials censored.

Field Name	Type	Description
url	google.protobuf.StringValue	url is the proxy URL string

APIProxyConfig

APIProxyConfig is the config model allowing users to set and delete the proxy value which is used in retrieving resources from arista.com.

APIProxyConfig Methods:

The Set method is used to add and/or modify a proxy stored in CloudVision. The Delete method is used to remove said proxy. The GetOne method is used to return a proxy with username and password obscured that has been set within CloudVision.

Adding a proxy to CloudVision:

When a Set is called, the rAPI will first ensure this proxy is valid after which it will stored within CloudVision.

Here is an example of a proxy value being set

Set(APIProxyConfig{
   Url: “http://10.0.0.0:0”
})

Deleting a proxy:

The proxy configuration can be removed from CloudVision by calling Delete.

Here is an example of a proxy being deleted

Delete(APIProxyConfig{
})

Retrieving a proxy:

The proxy can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a proxy being retrieved

GetOne(APIProxyConfig{
})

NOTE: Proxy configuration is not applicable to CloudVision-as-a-Service.

• If a proxy contains a username and/or password, it will be returned with the credentials censored.

Field Name	Type	Description
url	google.protobuf.StringValue	url is the proxy URL string

APIToken

APIToken is the state model that indicates whether a token is set or not.

APIToken Methods:

The GetOne method is used to determine whether a token is set or not within CloudVision.

Retrieving a token:

The token can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a token being retrieved

GetOne(APIToken{
})

NOTE: GetOne functionality for APIToken will only display whether a token is currently present or not. No secret values will be returned. The two valid responses are;

• "Token is set"
• "Token not set"

Field Name	Type	Description
token	google.protobuf.StringValue	token is the token string

APITokenConfig

APITokenConfig is the config model allowing users to modify the token value which is used for a multitude of functionalities, mainly in retrieving resources from arista.com e.g. the AlertBase.json or software images. Without a token set, a user can not retrieve any resources from arista.com NOTE: A user configured token is not required on CloudVision-as-a-Service for AlertBase updates.

APITokenConfig Methods:

The Set method is used to add and/or modify a token stored in CloudVision. The Delete method is used to remove the token. The GetOne method is used to determine whether a token is set or not on CloudVision.

Adding a token to CloudVision:

When a Set is called, the rAPI will first ensure the token is valid and in the correct format after which it will stored within CloudVision.

Here is an example of a token value being set

Set(APITokenConfig{
   Token: "f7f898e3860f618301c01f2de1ao1482"
})

Deleting a token:

The token can be removed from CloudVision by calling Delete.

Here is an example of a token being deleted

Delete(APITokenConfig{
})

Retrieving a token:

The token can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a token being retrieved

GetOne(APITokenConfig{
})

NOTE: GetOne functionality for APITokenConfig will only display whether a token is currently present or not. No secret values will be returned. The two valid responses are;

• "Token is set"
• "Token not set"

Field Name	Type	Description
token	google.protobuf.StringValue	token is the token string

Top

arista/arista_portal.v1/services.gen.proto

APIProxyConfigDeleteRequest

APIProxyConfigDeleteResponse

Field Name	Type	Description
time	google.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.

APIProxyConfigRequest

Field Name	Type	Description
time	google.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.

APIProxyConfigResponse

Field Name	Type	Description
value	APIProxyConfig	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.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the APIProxyConfig instance in this response.

APIProxyConfigSetRequest

Field Name	Type	Description
value	APIProxyConfig	APIProxyConfig carries the value to set into the datastore. See the documentation on the APIProxyConfig struct for which fields are required.

APIProxyConfigSetResponse

Field Name	Type	Description
value	APIProxyConfig	Value carries all the values given in the APIProxyConfigSetRequest as well as any server-generated values.
time	google.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.

APIProxyConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	APIProxyConfig[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.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 APIProxyConfig at end. * Each APIProxyConfig response is fully-specified (all fields set). * start: Returns the state of each APIProxyConfig at start, followed by updates until now. * Each APIProxyConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each APIProxyConfig at start, followed by updates until end. * Each APIProxyConfig response at start is fully-specified, but updates until end may be partial.

APIProxyConfigStreamResponse

Field Name	Type	Description
value	APIProxyConfig	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.
time	google.protobuf.Timestamp	Time holds the timestamp of this APIProxyConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the APIProxyConfig 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.

APIProxyRequest

Field Name	Type	Description
time	google.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.

APIProxyResponse

Field Name	Type	Description
value	APIProxy	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.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the APIProxy instance in this response.

APIProxyStreamRequest

Field Name	Type	Description
partial_eq_filter	APIProxy[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.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 APIProxy at end. * Each APIProxy response is fully-specified (all fields set). * start: Returns the state of each APIProxy at start, followed by updates until now. * Each APIProxy response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each APIProxy at start, followed by updates until end. * Each APIProxy response at start is fully-specified, but updates until end may be partial.

APIProxyStreamResponse

Field Name	Type	Description
value	APIProxy	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.
time	google.protobuf.Timestamp	Time holds the timestamp of this APIProxy's last modification.
type	arista.subscriptions.Operation	Operation indicates how the APIProxy 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.

APITokenConfigDeleteRequest

APITokenConfigDeleteResponse

Field Name	Type	Description
time	google.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.

APITokenConfigRequest

Field Name	Type	Description
time	google.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.

APITokenConfigResponse

Field Name	Type	Description
value	APITokenConfig	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.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the APITokenConfig instance in this response.

APITokenConfigSetRequest

Field Name	Type	Description
value	APITokenConfig	APITokenConfig carries the value to set into the datastore. See the documentation on the APITokenConfig struct for which fields are required.

APITokenConfigSetResponse

Field Name	Type	Description
value	APITokenConfig	Value carries all the values given in the APITokenConfigSetRequest as well as any server-generated values.
time	google.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.

APITokenConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	APITokenConfig[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.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 APITokenConfig at end. * Each APITokenConfig response is fully-specified (all fields set). * start: Returns the state of each APITokenConfig at start, followed by updates until now. * Each APITokenConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each APITokenConfig at start, followed by updates until end. * Each APITokenConfig response at start is fully-specified, but updates until end may be partial.

APITokenConfigStreamResponse

Field Name	Type	Description
value	APITokenConfig	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.
time	google.protobuf.Timestamp	Time holds the timestamp of this APITokenConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the APITokenConfig 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.

APITokenRequest

Field Name	Type	Description
time	google.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.

APITokenResponse

Field Name	Type	Description
value	APIToken	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.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the APIToken instance in this response.

APITokenStreamRequest

Field Name	Type	Description
partial_eq_filter	APIToken[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.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 APIToken at end. * Each APIToken response is fully-specified (all fields set). * start: Returns the state of each APIToken at start, followed by updates until now. * Each APIToken response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each APIToken at start, followed by updates until end. * Each APIToken response at start is fully-specified, but updates until end may be partial.

APITokenStreamResponse

Field Name	Type	Description
value	APIToken	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.
time	google.protobuf.Timestamp	Time holds the timestamp of this APIToken's last modification.
type	arista.subscriptions.Operation	Operation indicates how the APIToken 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 Name	Type	Description
time	google.protobuf.Timestamp	Time holds the timestamp of the last item included in the metadata calculation.
type	arista.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.
count	google.protobuf.UInt32Value	Count is the number of items present under the conditions of the request.

APIProxyConfigService

Method Name	Request Type	Response Type	Description
GetOne	APIProxyConfigRequest	APIProxyConfigResponse
GetAll	APIProxyConfigStreamRequest	APIProxyConfigStreamResponse stream
Subscribe	APIProxyConfigStreamRequest	APIProxyConfigStreamResponse stream
SubscribeMeta	APIProxyConfigStreamRequest	MetaResponse stream
Set	APIProxyConfigSetRequest	APIProxyConfigSetResponse
Delete	APIProxyConfigDeleteRequest	APIProxyConfigDeleteResponse

APIProxyService

Method Name	Request Type	Response Type	Description
GetOne	APIProxyRequest	APIProxyResponse
GetAll	APIProxyStreamRequest	APIProxyStreamResponse stream
Subscribe	APIProxyStreamRequest	APIProxyStreamResponse stream
SubscribeMeta	APIProxyStreamRequest	MetaResponse stream

APITokenConfigService

Method Name	Request Type	Response Type	Description
GetOne	APITokenConfigRequest	APITokenConfigResponse
GetAll	APITokenConfigStreamRequest	APITokenConfigStreamResponse stream
Subscribe	APITokenConfigStreamRequest	APITokenConfigStreamResponse stream
SubscribeMeta	APITokenConfigStreamRequest	MetaResponse stream
Set	APITokenConfigSetRequest	APITokenConfigSetResponse
Delete	APITokenConfigDeleteRequest	APITokenConfigDeleteResponse

APITokenService

Method Name	Request Type	Response Type	Description
GetOne	APITokenRequest	APITokenResponse
GetAll	APITokenStreamRequest	APITokenStreamResponse stream
Subscribe	APITokenStreamRequest	APITokenStreamResponse stream
SubscribeMeta	APITokenStreamRequest	MetaResponse stream