syslog.v1
Available Services
arista/syslog.v1/syslog.proto
Export
Export provides the export status for a syslog server.
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | key uniquely identifies a syslog server. |
| stats | ExportStats | stats contains the statistics for all export operations. |
| last_error | ExportError | last_error provides the details of the last export error. |
| last_success | ExportSuccess | last_success provides details of last successful export. |
ExportConfig
ExportConfig is used to configure a syslog server.
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | key uniquely identifies a syslog server. |
ExportError
ExportError provides the details of the most recent export error.
| Field Name | Type | Description |
|---|---|---|
| timestamp | google.protobuf.Timestamp | timestamp provides the timestamp of the export error. |
| error | google.protobuf.StringValue | error indicates the export error. |
| detail | google.protobuf.StringValue | detail indicates the audit log that was not exported. |
| log_timestamp | google.protobuf.Timestamp | log_timestamp provides the timestamp of the last audit log that was not exported due to error. |
ExportFormatConfig
ExportFormatConfig is used to confgure a global format for exporting logs to all the configured syslog servers.
| Field Name | Type | Description |
|---|---|---|
| format | Format | format defines the syslog format to be used for export. |
ExportKey
ExportKey uniquely identifies a syslog server to which to export logs.
| Field Name | Type | Description |
|---|---|---|
| hostname_or_ip | google.protobuf.StringValue | hostname_or_ip is the IP address or hostname of the syslog server. |
| port_num | fmp.Port | port_num is the destination port number of the syslog server. |
| protocol | TransportProtocol | protocol defines the transport protocol for the syslog export. |
ExportStats
ExportStats provide statistics of export operations to a syslog sever.
| Field Name | Type | Description |
|---|---|---|
| num_success | google.protobuf.UInt64Value | num_success indicates the count of successful exports. |
| num_errors | google.protobuf.UInt64Value | num_errors indicates the count of export errors. |
| last_result | ExportResult | last_result provides the status of the last export operation. |
ExportSuccess
ExportSuccess provides the details of the last successful export operation.
| Field Name | Type | Description |
|---|---|---|
| timestamp | google.protobuf.Timestamp | timestamp provides the timestamp of last successful export opeartion. |
| log_timestamp | google.protobuf.Timestamp | log_timestamp provides the timestamp of the last successful audit log. |
ExportResult
ExportResult defines the set of possible results of an export operation.
| Name | Number | Description |
|---|---|---|
| EXPORT_RESULT_UNSPECIFIED | 0 | EXPORT_RESULT_UNSPECIFIED indicates unspecified export operation. |
| EXPORT_RESULT_SUCCESS | 1 | EXPORT_RESULT_SUCCESS indicates a successful export operation. |
| EXPORT_RESULT_FAILURE | 2 | EXPORT_RESULT_FAILURE indicates an unsuccessful export operation. |
Format
Format defines the set of formats to be used for export to syslog servers.
| Name | Number | Description |
|---|---|---|
| FORMAT_UNSPECIFIED | 0 | FORMAT_UNSPECIFIED indicates unspecified format. |
| FORMAT_RFC3164 | 1 | FORMAT_RFC3164 indicates the BSD syslog protocol as defined by RFC 3164. |
| FORMAT_RFC5424 | 2 | FORMAT_RFC5424 indicates the IETF syslog protocol as defined by RFC 5424. |
| FORMAT_CUSTOM | 3 | FORMAT_CUSTOM indicates a native custom format with a UTC timestamp. |
TransportProtocol
TransportProtocol defines the set of transport protocols to be used for export.
| Name | Number | Description |
|---|---|---|
| TRANSPORT_PROTOCOL_UNSPECIFIED | 0 | TRANSPORT_PROTOCOL_UNSPECIFIED indicates unspecified protocol. |
| TRANSPORT_PROTOCOL_UDP | 1 | TRANSPORT_PROTOCOL_UDP indicates the User Datagram Protocol (UDP). |
| TRANSPORT_PROTOCOL_TCP | 2 | TRANSPORT_PROTOCOL_TCP indicates the TCP over TLS protocol. |
arista/syslog.v1/services.gen.proto
ExportConfigDeleteAllRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ExportConfig[...] | 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. |
ExportConfigDeleteAllResponse
| Field Name | Type | Description |
|---|---|---|
| type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
| error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
| key | ExportKey | This is the key of the ExportConfig instance that failed to be deleted. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
ExportConfigDeleteRequest
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | Key indicates which ExportConfig instance to remove. This field must always be set. |
ExportConfigDeleteResponse
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | Key echoes back the key of the deleted ExportConfig instance. |
| 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. |
ExportConfigDeleteSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ExportKey[...] | key contains a list of ExportConfig keys to delete |
ExportConfigDeleteSomeResponse
ExportConfigDeleteSomeResponse is only sent when there is an error.
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | |
| error | string |
ExportConfigRequest
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | Key uniquely identifies a ExportConfig instance to retrieve. This value must be populated. |
| 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. |
ExportConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportConfig | 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 ExportConfig instance in this response. |
ExportConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | ExportConfig | ExportConfig carries the value to set into the datastore. See the documentation on the ExportConfig struct for which fields are required. |
ExportConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportConfig | Value carries all the values given in the ExportConfigSetRequest 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. |
ExportConfigSetSomeRequest
| Field Name | Type | Description |
|---|---|---|
| values | ExportConfig[...] | value contains a list of ExportConfig 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. |
ExportConfigSetSomeResponse
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | |
| error | string |
ExportConfigSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ExportKey[...] | |
| 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. |
ExportConfigSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportConfig | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ExportConfig instance in this response. |
ExportConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ExportConfig[...] | 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 ExportConfig at end. * Each ExportConfig response is fully-specified (all fields set). * start: Returns the state of each ExportConfig at start, followed by updates until now. * Each ExportConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ExportConfig at start, followed by updates until end. * Each ExportConfig response at start is fully-specified, but updates until end may be partial. |
ExportConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportConfig | 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 ExportConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the ExportConfig 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. |
ExportFormatConfigRequest
| 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. |
ExportFormatConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportFormatConfig | 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 ExportFormatConfig instance in this response. |
ExportFormatConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | ExportFormatConfig | ExportFormatConfig carries the value to set into the datastore. See the documentation on the ExportFormatConfig struct for which fields are required. |
ExportFormatConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportFormatConfig | Value carries all the values given in the ExportFormatConfigSetRequest 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. |
ExportFormatConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ExportFormatConfig[...] | 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 ExportFormatConfig at end. * Each ExportFormatConfig response is fully-specified (all fields set). * start: Returns the state of each ExportFormatConfig at start, followed by updates until now. * Each ExportFormatConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ExportFormatConfig at start, followed by updates until end. * Each ExportFormatConfig response at start is fully-specified, but updates until end may be partial. |
ExportFormatConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | ExportFormatConfig | 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 ExportFormatConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the ExportFormatConfig 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. |
ExportRequest
| Field Name | Type | Description |
|---|---|---|
| key | ExportKey | Key uniquely identifies a Export instance to retrieve. This value must be populated. |
| 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. |
ExportResponse
| Field Name | Type | Description |
|---|---|---|
| value | Export | 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 Export instance in this response. |
ExportSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ExportKey[...] | |
| 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. |
ExportSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | Export | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the Export instance in this response. |
ExportStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | Export[...] | 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 Export at end. * Each Export response is fully-specified (all fields set). * start: Returns the state of each Export at start, followed by updates until now. * Each Export response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Export at start, followed by updates until end. * Each Export response at start is fully-specified, but updates until end may be partial. |
ExportStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | Export | 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 Export's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the Export 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. |
ExportConfigService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ExportConfigRequest | ExportConfigResponse | |
| GetSome | ExportConfigSomeRequest | ExportConfigSomeResponse stream | |
| GetAll | ExportConfigStreamRequest | ExportConfigStreamResponse stream | |
| Subscribe | ExportConfigStreamRequest | ExportConfigStreamResponse stream | |
| GetMeta | ExportConfigStreamRequest | MetaResponse | |
| SubscribeMeta | ExportConfigStreamRequest | MetaResponse stream | |
| Set | ExportConfigSetRequest | ExportConfigSetResponse | |
| SetSome | ExportConfigSetSomeRequest | ExportConfigSetSomeResponse stream | |
| Delete | ExportConfigDeleteRequest | ExportConfigDeleteResponse | |
| DeleteSome | ExportConfigDeleteSomeRequest | ExportConfigDeleteSomeResponse stream | |
| DeleteAll | ExportConfigDeleteAllRequest | ExportConfigDeleteAllResponse stream |
ExportFormatConfigService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ExportFormatConfigRequest | ExportFormatConfigResponse | |
| GetAll | ExportFormatConfigStreamRequest | ExportFormatConfigStreamResponse stream | |
| Subscribe | ExportFormatConfigStreamRequest | ExportFormatConfigStreamResponse stream | |
| SubscribeMeta | ExportFormatConfigStreamRequest | MetaResponse stream | |
| Set | ExportFormatConfigSetRequest | ExportFormatConfigSetResponse |
ExportService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ExportRequest | ExportResponse | |
| GetSome | ExportSomeRequest | ExportSomeResponse stream | |
| GetAll | ExportStreamRequest | ExportStreamResponse stream | |
| Subscribe | ExportStreamRequest | ExportStreamResponse stream | |
| GetMeta | ExportStreamRequest | MetaResponse | |
| SubscribeMeta | ExportStreamRequest | MetaResponse stream |