jnx_ecmptracer_service.proto

Service

EcmptracerFlow

EcmpTracer Flow Management

Method Name Request Type Response Type Description
EcmptracerFlowAdd EcmptracerFlowAddRequest EcmptracerFlowMonitorResponse Add new flow
EcmptracerFlowDelete EcmptracerFlowInfoRequest EcmptracerFlowMonitorResponse Delete flow and corresponding filters
EcmptracerFlowGet EcmptracerFlowInfoRequest EcmptracerFlowInfoResponse Get counter stats for a flow

RPC(s)

The following APIs are provided by this service:

EcmptracerFlowAdd

This rpc call returns a success or a failure reason depending upon the status of the flow added

Input: EcmptracerFlowAddRequest

Output: EcmptracerFlowMonitorResponse

EcmptracerFlowDelete

This rpc call returns a success or a failure depending upon the status of the flows deleted

Input: EcmptracerFlowInfoRequest

Output: EcmptracerFlowMonitorResponse

EcmptracerFlowGet

This rpc call returns the counter names, pkts and bytes count for the flow

Input: EcmptracerFlowInfoRequest

Output: EcmptracerFlowInfoResponse

Message(s)

This IDL defines the following message type(s)

EcmptracerFlowAddRequest

Flow add Request with input parameters

Field Type Description
flow_name string flow name for add
family string addr family for flow
src_ip string source Ip for flow
src_prefix_len uint32 source prefix len for flow
dest_ip string Dest ip for flow
dest_prefix_len uint32 Dest pref len for flow
min_src_port uint32 Min src port for flow
max_src_port uint32 Max src port for flow
min_dest_port uint32 Min dest port for flow
max_dest_port uint32 Max dest port for flow
proto uint32 Protocol for flow

EcmptracerFlowMonitorResponse

Reply carrying a success or failure status

Field Type Description
flow_name string Flow name in the Response
status EcmptracerFlowMonitorStatus Status in the Response

EcmptracerFlowInfoRequest

Input to be passed to the GET rpc call

Field Type Description
flow_name string flow name in the Request
family string address family in the Request

EcmptracerFlowInfoResponse

Field Type Description
status EcmptracerFlowInfoResponseStatus status for the get rpc call
flow_name string flow name
ingress_ctrs IntfCounter ingress counter repeated field
egress_ctrs IntfCounter egress counter repeated field

IntfCounter

Counter information along with interface name, pkts and bytes count

Field Type Description
intf_name string Interface name
bytes uint64 Num of bytes
pkts uint64 Num of packets

Enum(s)

EcmptracerFlowMonitorStatus

Enum carrying success or failure reasons returned from a GET rpc call

Value Description
SUCCESS Request successfully completed
FAILURE Request failed
SERVER_NOT_RUNNING Server not running
EINVALID_INPUT Invalid input entered
EMISSING_MANDATORY_INPUT Missing mandatory input
EINVALID_FAMILY Wrong family entered
EINVALID_SIP Invalid sip
EINVALID_DIP Invalid dip
EINVALID_SRC_PLEN Invalid src prefix len
EINVALID_DEST_PLEN Invalid dest pref len
EINVALID_SPORT Invalid src port
EINVALID_DPORT Invalid dest port
EINVALID_PORT_RANGE Invalid Port range
EPROTO_NOT_SPECIFIED proto not provided
EINVALID_PROTO Invalid proto entered
EFLOW_DOES_NOT_EXIST Flow does not exist
EFLOW_EXISTS When there is an attempt to add flow with same name as an existing flow

EcmptracerFlowInfoResponseStatus

Enum carrying success or failure reasons returned from a GET rpc call

Value Description
STATUS_SUCCESS Success
STATUS_EINVALID_MESSAGE Invalid message
STATUS_FAIL Server Internal error
STATUS_EUNSUPPORTED_OP Operation not supported
STATUS_EFLOW_DOES_NOT_EXIST Flow doees not exist
STATUS_EINVALID_INPUT Invalid input entered
STATUS_EMISSING_MANDATORY_INPUT Missing mandatory input
STATUS_EINVALID_FAMILY Invalid address family entered