Junos OS cos IDL - Protocol Documentation

Table of Contents

cos_service.proto

Top

AdjustMinRate

Adjust Minimum Rate Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value fixed64 optional

Range between 3200 and 6400000000000 bits per second

AdjustPercent

Adjust Percent Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value int32 optional

Value in percent: 0 to 100

BufferSize

Buffer Size Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value_spec CosSchedulerBufferSizeSpec optional

Value specification

value fixed64 optional

Value

BurstSize

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value fixed64 optional

Value

ClassifierRule

Classifier rules When operation is delete, the forwarding class and loss-priority are optional or ignored.

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Attribute operation

forwarding_class_name string optional

Forwarding class name. Length: 1 to 64.

loss_priority CosLossPriority optional

Loss priority

code_points int32 repeated

Array of code points. Range varies depending on type of classifier.

CosAtmService

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

category AtmServiceCategory optional

ATM service category

CosClassifierDeleteRequest

Following is the RPC Delete request message for classifiers

RPC Methods:

ClassifierDelete

Request message:

Delete requests must have classifier name and type

Response message:

Delete requests will return CosStatus

FieldTypeLabelDescription
classifier_name string optional

Name of the classifier. Length: 1 to 64. [REQUIRED]

classifier_type CosFeatureCodePointType optional

Classifier type. Part of the key. [REQUIRED]

CosClassifierQueryRequest

Following is the RPC Query request message for classifiers

RPC Methods:

ClassifierGet

ClassifierGetNext

ClassifierBulkGet

Request message:

Get requests must have classifier name and type GetNext and BulkGet requests optionally have name and type, i.e type, type & name, or none of them.

Response message:

Get, GetNext, and BulkGet requests will return CosClassifierQueryResponse info

FieldTypeLabelDescription
classifier_name string optional

Name of the classifier. Length: 1 to 64 characters. [REQUIRED] for Get Request. [OPTIONAL] for GetNext and BulkGet

classifier_type CosFeatureCodePointType optional

[REQUIRED] for Get Request. [OPTIONAL] for GetNext and BulkGet

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET requests to indicate client / interested in referring objects to this classifier [OPTIONAL]

CosClassifierQueryResponse

Following is the RPC query response message for classifiers

RPC Methods:

ClassifierGet

ClassifierGetNext

ClassifierBulkGet

Request message:

Get requests must have classifier name and type GetNext and BulkGet requests optionally have name and type, for example: type, type & name, or none of them.

Response message:

Get, GetNext, and BulkGet requests will return CosClassifierQueryResponse info

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status. Valid for GET, GETNEXT, and BULKGET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations. Valid for GET, GETNEXT, and BULKGET response

message string optional

Error string for descriptive error information. Valid for GET, GETNEXT, and BULKGET response

classifier_name string optional

Name of the classifier. Length: 1 to 64 characters.

classifier_type CosFeatureCodePointType optional

Feature code point classifier type

sharable CosBoolean optional

Sharable flag. Currently ignored.

rule ClassifierRule repeated

List of classifier rules

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

CosClassifierRequest

Following is the RPC Add/Update request message for classifiers

RPC Methods:

ClassifierAdd

ClassifierUpdate

Request message:

Add and Update requests must have classifier name and type along with the rules

Response message:

Add/Update requests will return CosStatus

FieldTypeLabelDescription
classifier_name string optional

Name of the classifier. Length: 1-64. [REQUIRED]

classifier_type CosFeatureCodePointType optional

[REQUIRED]

sharable CosBoolean optional

sharable flag. Currently ignored. [OPTIONAL]

rule ClassifierRule repeated

1 or more rules [REQUIRED].

CosConfigPreference

FieldTypeLabelDescription
priority int32 optional

resolve conflicts in configuration for bind points, etc.

CosDropProfile

RPC message for drop profile

FieldTypeLabelDescription
drop_profile_name string optional

Drop profile name

sharable CosBoolean optional

Sharable flag meaning this is sharable to other apps

drop_profile_type CosDropProfileType optional

Drop profile type

level_to_drop_probabilities LevelToDropProbability repeated

List of level to drop probabilities.

status CosReturnVal optional

Valid for GET, GETNEXT, and BULKGET responses

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

CosForwardingClassIdQueryRequest

Following is the RPC request message for forwarding classes queried by forwarding class id

RPC Methods:

ForwardClassGetByForwardingClassId

Request message:

Request will have forwarding_class_id field specified -- By default forwarding_class_id 0 will be used if not specified explicitly

FieldTypeLabelDescription
forwarding_class_id int32 optional

Forwarding class id. / Platform dependent. Default range: 0 - 15 [REQUIRED]

CosForwardingClassIdQueryResponse

Following is the RPC response message for forwarding classes queried by forwarding class id

RPC Methods:

ForwardClassGetByForwardingClassId

Response message:

All the fields of the message will be populated for requested forwarding class id

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status. / Valid for GET response.

sub_code CosReturnVal optional

Component specific sub-code common for all operations. / Valid for GET response.

message string optional

Error string for descriptive error information. / Valid for GET response.

forwarding_class_id int32 optional

Forwarding class id / Platform dependent. Default range: 0 to 15

queue_id int32 optional

Forwarding class queue id / Platform dependent. Default range: 0 to 7

forwarding_class_name string optional

Forwarding class name. Length: 1 to 64

restrict_queue_id int32 optional

Forwarding class restricted queue id / Platform dependent. Default range: 0 to 3

fabric_priority CosFcFabricPriority optional

Fabric priority

policing_priority CosFcPolicingPriority optional

Policing priority

spu_priority CosFcSpuPriority optional

SPU priority

sharable CosBoolean optional

Sharable flag. Currently ignored.

CosForwardingClassQueryRequest

Following is the RPC get-xxx request message for forwarding classes queried by forwarding class name

RPC Methods:

ForwardClassGet

ForwardClassGetNext

ForwardClassBulkGet

Request message:

Request must have forwarding_class_name specified for Get request For GetNext and BulkGet requests, it is optional

FieldTypeLabelDescription
forwarding_class_name string optional

Forwarding class name. Length: 1-64 bytes. [REQUIRED]

ref_objects CosObjRefInfo repeated

CosForwardingClassQueryResponse

Following is the RPC response message for forwarding classes queried by forwarding class name

RPC Methods:

ForwardClassGet

ForwardClassGetNext

ForwardClassBulkGet

Response message:

All the fields of the message will be populated for requested forwarding class name

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status. / Valid for GET, GETNEXT, and BULKGET responses

sub_code CosReturnVal optional

Component specific sub-code common for all operations. / Valid for GET, GETNEXT, and BULKGET responses.

message string optional

Error string for descriptive error information / Valid for GET, GETNEXT, and BULKGET responses

forwarding_class_name string optional

Forwarding class name. Length: 1 to 64 bytes

queue_id int32 optional

Forwarding class queue id. Platform dependent. Default range: 0 to 7

restrict_queue_id int32 optional

Forwarding class restricted queue id. / Platform dependent. Default range: 0 to 3

forwarding_class_id int32 optional

Forwarding class id. Range: 0 to 15

fabric_priority CosFcFabricPriority optional

Fabric priority

policing_priority CosFcPolicingPriority optional

policing priority

spu_priority CosFcSpuPriority optional

spu priority

sharable CosBoolean optional

sharable flag. Currently ignored.

ref_objects CosObjRefInfo repeated

CosForwardingClassQueueQueryRequest

Following is the RPC request message for forwarding classes queried by queue id

RPC Methods:

ForwardClassGetByQueueId

Request message:

Request will have queue_id field specified -- By default queue_id 0 will be used if not specified explicitly

FieldTypeLabelDescription
queue_id int32 optional

Forwarding class queue id. / Platform dependent. Default range: 0 to 7 [REQUIRED]

CosForwardingClassQueueQueryResponse

Following is the RPC response message for forwarding classes queried by queue id

RPC Methods:

ForwardClassGetByQueueId

Response message:

Response message will have > queue_id

> list of forwarding classes for the requested queue id

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status Valid for GET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations. / Valid for GET response

message string optional

Error string for descriptive error information. / Valid for GET response

queue_id int32 optional

Forwarding class queue id / Platform dependent. Default range: 0 to 7

forwarding_class_names string repeated

List of Forwarding class names. Length: 1 to 64 bytes

sharable CosBoolean optional

Sharable flag. Currently ignored.

CosForwardingClassRestrictQueueQueryRequest

Following is the RPC request message for forwarding classes queried by restricted queue id

RPC Methods:

ForwardClassGetByRestrictQueueId

Request message:

Request will have restricte_queue_id field specified -- By default restrict_queue_id 0 will be used if not specified explicitly

FieldTypeLabelDescription
restrict_queue_id int32 optional

Forwarding class restricted queue id / Platform dependent. Default range: 0 to 3 / [REQUIRED]

CosForwardingClassRestrictQueueQueryResponse

Following is the RPC response message for forwarding classes queried by restricted queue id

RPC Methods:

ForwardClassGetByRestrictQueueId

Response message:

Response message will have > restrict_queue_id > list of forwarding classes for the requested restricted queue id

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status / Valid for GET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations / Valid for GET response

message string optional

Error string for descriptive error information / Valid for GET response

restrict_queue_id int32 optional

Forwarding class restricted queue id / Platform dependent. Default range: 0 to 3

forwarding_class_names string repeated

List of Forwarding class names. Length: 1 to 64

sharable CosBoolean optional

Sharable flag. Currently ignored.

CosNodeBindFeaturesDeleteRequest

Following is the RPC delete request message for interface, logical interface, and interface sets

RPC Methods:

NodeFeaturesDelete

Request message:

Delete requests must have 1. Node name and type

2. Parent node name and type ( optional in case if node is IFL/logical interface, and ignored for IFD )

Response message:

Delete requests will returns CosStatus message.

FieldTypeLabelDescription
node_type CosNodeType optional

Node type ( IFD , IFL OR IFLSET ) [REQUIRED]

node_name string optional

Node name ( IFD, IFL or IFLSET name ). IFD name: Length 1-60, IFL name: Length: 1-72 IFLSET name: Length 1-64 [REQUIRED]

node_parent_type CosNodeType optional

Parent node ( For example: IFD is parent for IFL ) [OPTIONAL]

node_parent_name string optional

Parent node name IFD name: Length 1-60, IFL name: Length: 1-72 IFLSET name: Length 1-64 [OPTIONAL]

CosNodeBindFeaturesQueryRequest

Following is the RPC request message for interface, logical interface, and interface sets

RPC Methods:

NodeFeaturesGet

NodeFeaturesGetNext

NodeFeaturesBulkGet

Request message:

Get requests must have

1. Node name and type

2. Parent node name and type ( ignored )

GetNext and BulkGet requests can have

1. Node type

2. Node type and node name

3. Parent node name and type ( Ignored )

4. Nothing

Response message:

Get, GetNext, BulkGet requests will return CosNodeBindFeaturesQueryResponse

FieldTypeLabelDescription
node_type CosNodeType optional

Node type ( IFD , IFL OR IFLSET ) [REQUIRED] for Get Request. [OPTIONAL] for GetNext and BulkGet

node_name string optional

Node name ( IFD, IFL or IFLSET name ) IFD name: Length 1-60, IFL name: Length: 1-72 IFLSET name: Length 1-64 [REQUIRED] for Get Request. [OPTIONAL] for GetNext and BulkGet

node_parent_type CosNodeType optional

Parent node ( eg: IFD is parent for IFL ) [OPTIONAL]

node_parent_name string optional

Parent node name IFD name: Length 1-60, IFL name: Length: 1-72 IFLSET name: Length 1-64 [OPTIONAL]

features_type CosFeaturesType optional

filter for GET, GETNEXT, and BULKGET requests [OPTIONAL], default: MAPPED

CosNodeBindFeaturesQueryResponse

Following is the RPC query response message for interface, logical interface, and interface sets

RPC Methods:

NodeFeaturesGet NodeFeaturesGetNext NodeFeaturesBulkGet

Response message:

Get, GetNext, BulkGet requests will returns CosNodeBindFeaturesQueryResponse

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status Valid for GET, GETNEXT, and BULKGET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations Valid for GET, GETNEXT, and BULKGET response

message string optional

Error string for descriptive error information Valid for GET, GETNEXT, and BULKGET response

node_type CosNodeType optional

Node type ( IFD , IFL OR IFLSET )

node_name string optional

Node name ( IFD, IFL or IFLSET name ) / IFD name: Length 1-60, IFL name: Length: 1-72 / IFLSET name: Length 1-64

node_parent_type CosNodeType optional

Parent node ( eg: IFD is parent for IFL )

node_parent_name string optional

Parent node name / IFD name: Length 1-60, IFL name: Length: 1-72 / IFLSET name: Length 1-64

features_type CosFeaturesType optional

filter for GET, GETNEXT, and BULKGET requests & responses

node_features CosNodeFeature repeated

List of node features

node_family_features CosNodeFamilyFeature repeated

List of family features

CosNodeBindFeaturesRequest

Following is the RPC Add/Update request message for interface, logical interface, and interface sets

RPC Methods:

NodeFeaturesAdd NodeFeaturesUpdate

Request message:

Add requests must have

1. Node name and type

2. Parent node name and type [OPTIONAL] in case if node is IFL. Ignored for IFD)

3. Node features AND/OR Family features [OPTIONAL] for IFD, [REQUIRED] for IFL.

Update requests must have

1. Node name and type

2. Parent node name and type [OPTIONAL] for IFL and will be validated if specified. Ignored for IFD

3. Node features AND/OR Family features [OPTIONAL] for IFD, [REQUIRED] for IFL

Response message:

Add/Update requests will return CosStatus

FieldTypeLabelDescription
node_type CosNodeType optional

Node type ( IFD , IFL OR IFLSET ) [REQUIRED]

node_name string optional

Node name ( IFD, IFL or IFLSET name ) / IFD name: Length 1-60, IFL name: Length: 1-72 / IFLSET name: Length 1-64 [REQUIRED]

node_parent_type CosNodeType optional

Parent node ( eg: IFD is parent for IFL ) [REQUIRED]

node_parent_name string optional

Parent node name / IFD name: Length 1-60, IFL name: Length: 1-72 / IFLSET name: Length 1-64 [REQUIRED]

node_features CosNodeFeature repeated

Node features [OPTIONAL]

node_family_features CosNodeFamilyFeature repeated

Family features [OPTIONAL]

CosNodeFamilyFeature

Node family features

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Attribute operation

direction CosDirection optional

Direction ( Ingress or egress )

feature_type CosNodeFeatureFamilyType optional

Classifier or rewrite type

feature_option CosNodeFeatureOption optional

Classifier or rewrite family

feature_object_name string optional

Feature name. Length: 1-64

object_shared CosBoolean optional

Currently ignored.

CosNodeFeature

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

direction CosDirection optional

Direction

feature_type CosNodeFeatureType optional

Feature type

feature_val CosNodeFeatureVal optional

Feature value

CosNodeFeatureOption

FieldTypeLabelDescription
classifier_family CosNodeFeatureClassifierFamily optional

Classifier family

rewrite_family CosNodeFeatureRewriteFamily optional

Rewrite family

CosNodeFeatureVal

FieldTypeLabelDescription
value fixed64 optional

Value

object_name string optional

Length 1-64

CosObjRefInfo

[OPTIONAL] for GET, GETNEXT, and GETBULK / to see referencing objects for a given cos object.

FieldTypeLabelDescription
referencing_obj_type string optional

Referencing objecs type

referencing_obj_name string optional

Referencing object name

referencing_obj_count int32 optional

Referencing object count

CosPurgeTimeRequest

Following is the RPC Update request message for tunable purge time to cleanup client state of configuration. Note: RPC - CosPurgeTimeDelete Delete requests resets purge time to default value of 300 secs and will return CosStatus

RPC Methods: ============ CosPurgeTimeUpdate

Request message: =============== Update requests must have purge time in secs from 30-86400

Response message: ================ Update requests will return CosStatus

FieldTypeLabelDescription
purge_time int32 optional

[REQUIRED] for update request. Value is ignored for delete and get requests. range 30-86400

CosPurgeTimeResponse

Following is the RPC response message for tunable purge time to cleanup client state of configuration.

RPC Methods: ============ CosPurgeTimeGet

Response message: ================ Get requests will return CosPurgeTimeResponse

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status Valid for GET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations Valid for GET response

message string optional

Error string for descriptive error information Valid for GET response

purge_time int32 optional

range 30-86400

CosRate

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value fixed64 optional

Value

CosResourceLimit

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status Valid for GET, GETNEXT, and BULKGET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations Valid for GET, GETNEXT, and BULKGET response

message string optional

Error string for descriptive error information Valid for GET, GETNEXT, and BULKGET response

num_of_rate_limit_qs int32 optional

Number of rate limit queues

buf_size_temporal_limit_value int32 optional

Buffer size temporal limit value

max_ucast_fc_sets_per_interface int32 optional

Unicast forwarding class sets per interface

max_mcast_fc_sets_per_interface int32 optional

Maximum multicast forwarding class sets per interface

max_wred_profile_points int32 optional

Maximum weighted random early detection profile points

num_of_fcs_in_fc_set int32 optional

Number of forwarding classes in forwarding class set

max_queue_to_pause_profiles int32 optional

Maximum queue to pause profiles

max_ingress_shared_buffer int32 optional

Maximum ingress shared buffers

max_egress_shared_buffer int32 optional

Maximum egress shared buffers

max_global_buffer int32 optional

Maximum global buffers

max_qcn_queues int32 optional

Maximum quantized congestion notification queues

max_queues_per_interface int32 optional

Maximum queues per interface

default_fc_size int32 optional

Default fc size

CosRewriteDeleteRequest

Following is the RPC delete request message for rewrites

RPC Methods:

RewriteDelete

Request message:

Delete requests must have rewrite name and type

Response message:

Delete requests will return CosStatus

FieldTypeLabelDescription
rewrite_name string optional

Rewrite name. Length: 1 to 64 characters [REQUIRED]

rewrite_type CosFeatureCodePointType optional

Rewrite type [REQUIRED]

CosRewriteQueryRequest

Following is the RPC query request message for rewrites

RPC Methods:

RewriteGet

RewriteGetNext

RewriteBulkGet

Request message:

Get requests must have rewrite name and type GetNext and BulkGet requests optionally have name and type i.e type, type & name, or none of them.

Response message:

Get, GetNext, and BulkGet requests will return CosRewriteQueryResponse info

FieldTypeLabelDescription
rewrite_name string optional

Rewrite name. Length: 1-64 / [REQUIRED] for Get Request. [OPTIONAL] for GetNext and BulkGet

rewrite_type CosFeatureCodePointType optional

Rewrite type [REQUIRED] for Get Request. [OPTIOINAL] for GetNext and BulkGet

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, BULKGET requests / if specified then referring objects this rewrite will be added in the / response. [OPTOINAL]

CosRewriteQueryResponse

Following is the RPC query response message for rewrites

RPC Methods:

RewriteGet

RewriteGetNext

RewriteBulkGet

Response message:

Get, GetNext, and BulkGet responds with CosRewriteQueryResponse info

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status / Valid for GET, GETNEXT, BULKGET response

sub_code CosReturnVal optional

Component specific sub-code common for all operations / Valid for GET, GETNEXT, and BULKGET response

message string optional

Error string for descriptive error information / Valid for GET, GETNEXT, and BULKGET response

rewrite_name string optional

Rewrite name. Length: 1 to 64 characters

rewrite_type CosFeatureCodePointType optional

Rewrite type

sharable CosBoolean optional

Sharable flag. Currently ignored.

rule RewriteRule repeated

Rewrite rules

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

CosRewriteRequest

Following is the RPC Add/update request message for rewrites

RPC Methods:

RewriteAdd RewriteUpdate

Request message:

Add and Update requests must have rewrite name and type along with the rules

Response message:

Add and Update requests will return CosStatus

FieldTypeLabelDescription
rewrite_name string optional

Rewrite name. Length: 1 to 64 characters [REQUIRED]

rewrite_type CosFeatureCodePointType optional

Rewrite type [REQUIRED]

sharable CosBoolean optional

sharable flag. Currently ignored. [OPTIONAL]

rule RewriteRule repeated

Rewrite rules / 1 or more rules [REQUIRED]

CosRoutingInstanceBindPointDeleteRequest

Following is the RPC Delete request message for Routing instances

RPC Methods:

RoutingInstanceBindPointDelete

Request message:

Delete requests must have

1. Routing instance name

Response message:

Delete requests will CosStatus

FieldTypeLabelDescription
routing_instance_name string optional

Routing instance name. Length: 1-127 [REQUIRED]

CosRoutingInstanceBindPointQueryRequest

Following is the RPC query request message for Routing instances

RPC Methods:

RoutingInstanceBindPointGet

RoutingInstanceBindPointGetNext

RoutingInstanceBindPointBulkGet

Request message:

Get requests must have

1. Routing instance name

GetNext and BulkGet requests can have

1. Routing instance name or NULL

Response message:

Get, GetNext, and BulkGet requests will return CosRoutingInstanceBindPointQueryResponse

FieldTypeLabelDescription
routing_instance_name string optional

Routing instance name. Length: 1-127 [REQUIRED]

CosRoutingInstanceBindPointQueryResponse

Following is the RPC Query response message for Routing instances

RPC Methods:

RoutingInstanceBindPointGet

RoutingInstanceBindPointGetNext

RoutingInstanceBindPointBulkGet

Response message:

Get, GetNext, and BulkGet requests will return CosRoutingInstanceBindPointQueryResponse

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status. Valid for GET, GETNEXT, and BULKGET responses.

sub_code CosReturnVal optional

Component specific sub-code common for all operations. Valid for GET, GETNEXT, and BULKGET responses.

message string optional

Error string for descriptive error information. Valid for GET, GETNEXT, and BULKGET responses.

routing_instance_name string optional

Routing instance name. Length: 1-127

classifiers CosRoutingInstanceClassifier repeated

Classifiers

rewrites CosRoutingInstanceRewrite repeated

Rewrites

CosRoutingInstanceBindPointRequest

Following is the RPC Add/Update request message for Routing instances

RPC Methods:

RoutingInstanceBindPointAdd

RoutingInstanceBindPointUpdate

Request message:

Add, Update requests must have 1. Routing instance name

2. Routing instances classifier/rewrite features

Response message:

Add/Update requests will return CosStatus

FieldTypeLabelDescription
routing_instance_name string optional

Routing instance name. Length: 1-127 [REQUIRED]

classifiers CosRoutingInstanceClassifier repeated

Classifiers / At least one of classifiers or rewrites features / needs to be present.

rewrites CosRoutingInstanceRewrite repeated

Rewrites / At least one of classifiers or rewrites features / needs to be present.

CosRoutingInstanceClassifier

Routing instance classifiers

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Attribute operation

type CosRoutingInstanceClassifierCodePointType optional

Code point type

feature_ieee8021_tag_mode CosRoutingInstanceClassifierIeee8021TagMode optional

Tag mode

feature_object_name string optional

Length: 1-64

object_shared CosBoolean optional

Currently ignored.

CosRoutingInstanceRewrite

Routing instance rewrites

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Attribute operation

type CosRoutingInstanceRewriteCodePointType optional

Code point type

feature_ieee8021_tag_mode CosRoutingInstanceRewriteIeee8021xTagMode optional

Tag mode

feature_object_name string optional

Feature object name. Length: 1-64

object_shared CosBoolean optional

Currently ignored.

CosScheduler

RPC Message for CoS Scheduler

FieldTypeLabelDescription
scheduler_name string optional

Scheduler Name

adjust_min_rate AdjustMinRate optional

Adjust minimum rate

adjust_percent AdjustPercent optional

Adjust percent

g_rate GuaranteedRate optional

Guaranteed rate

s_rate SchedulerShapingRate optional

Scheduler shaping rate

e_rate ExcessRate optional

Excess rate

b_size BufferSize optional

Buffer size

priority SchedulerPriority optional

Priority

excess_priority SchedulerExcessPriority optional

Excess priority

drop_profile_mappings DropProfileMap repeated

List of drop profile maps

status CosReturnVal optional

Valid for GET, GETNEXT, and BULKGET responses

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

CosSchedulerMap

RPC message for scheduler maps

FieldTypeLabelDescription
scheduler_map_name string optional

fc_to_scheduler_mapping ForwardingClassToScheduler repeated

status CosReturnVal optional

Valid for GET, GETNEXT, and BULKGET responses

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

CosStatus

Status message for ADD, CHANGE, and DELETE requests

FieldTypeLabelDescription
code StatusCode optional

Top level RPC status

sub_code CosReturnVal optional

Component specific sub-code common for all operations

message string optional

Error string for descriptive error information

CosTrafficControlProfile

RPC message for TCPs

FieldTypeLabelDescription
traffic_control_profile_name string optional

Traffic control profile name

scheduler_map TcpSchedulerMap optional

TCP scheduler map

a_rate TcpAdjustRate optional

TCP adjust rate

delay_buf_rate DelayBufferRate optional

Delay buffer rate

g_rate TcpGuaranteedRate optional

TCP Guaranteed rate

guaranteed_burst_size BurstSize optional

Guaranteed burst size

s_rate TcpShapingRate optional

TCP Shaping rate

shaping_burst_size BurstSize optional

Shaping burst size

s_rate_priority_high TcpShapingRate optional

TCP Shaping rate priority - High

shaping_burst_size_priority_high BurstSize optional

Shaping burst size priority - High

s_rate_priority_low TcpShapingRate optional

TCP Shaping rate priority - Low

shaping_burst_size_priority_low BurstSize optional

Shaping burst size priority - Low

s_rate_priority_medium TcpShapingRate optional

TCP Shaping rate priority - Medium

shaping_burst_size_priority_medium BurstSize optional

Shaping burst size priority - Medium

s_rate_excess_priority_high TcpShapingRate optional

TCP Shaping rate excess priority - High

shaping_burst_size_excess_priority_high BurstSize optional

Shaping burst size excess priority - High

s_rate_excess_priority_low TcpShapingRate optional

TCP Shaping rate excess priority - Low

shaping_burst_size_excess_priority_low BurstSize optional

Shaping burst size excess priority - Low

e_rate ExcessRate optional

Excess rate

e_rate_low ExcessRate optional

Excess rate - Low

e_rate_high ExcessRate optional

Excess rate - High

o_head_accounting OverheadAccounting optional

Overhead accounting

s_rate_priority_medium_low TcpShapingRate optional

TCP Shaping rate priority - Medium-low

shaping_burst_size_priority_medium_low BurstSize optional

Shaping burst size priority - Medium-low

s_rate_priority_strict_high TcpShapingRate optional

TCP Shaping rate priority - Strict high

shaping_burst_size_priority_strict_high BurstSize optional

Shaping burst size priority - Strict high

s_rate_excess_priority_medium_high TcpShapingRate optional

TCP Shaping rate excess priority - Medium-high

shaping_burst_size_excess_priority_medium_high BurstSize optional

Shaping burst size excess priority - Medium-high

s_rate_excess_priority_medium_low TcpShapingRate optional

TCP Shaping rate excess priority - Medium-low

shaping_burst_size_excess_priority_medium_low BurstSize optional

Shaping burst size excess priority - Medium-low

atm_service CosAtmService optional

ATM Service

peak_rate CosRate optional

Peak rate

sustained_rate CosRate optional

Sustained rate

status CosReturnVal optional

Valid for GET, GETNEXT, and BULKGET responses

ref_objects CosObjRefInfo repeated

Valid for GET, GETNEXT, and BULKGET responses

DelayBufferRate

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value fixed64 optional

Value

value_spec CosDelayBufferRateSpec optional

Value specification

DropProfileMap

Drop Profile Map Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message Attribute Operation

scheduler_loss_priority CosSchedulerLossPriority optional

Scheduler loss priority

scheduler_protocol CosSchedulerProtocol optional

Protocol

drop_profile_name string optional

Drop profile name

drop_profile_shared CosBoolean optional

This drop profile is a shared reference.

ExcessRate

Excess Rate Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value fixed64 optional

Value

value_spec CosExcessRateSpec optional

Value specification

FeatureCodePoint

Code points

FieldTypeLabelDescription
code_point int32 optional

depending on code point type, the range varies.

code_point_str string optional

some code points such as 0 need to be specified as binary string.

ForwardingClassToScheduler

Forwarding Class to Scheduler Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

forwarding_class_name string optional

Forwarding class name

scheduler_name string optional

Scheduler name

GuaranteedRate

Guaranteed Rate Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value_spec CosSchedulerRateSpec optional

Value Specification

value fixed64 optional

Value

value_extend_spec CosSchedulerGuaranteedRateExtendSpec optional

Scheduler Guaranteed Rate Extended Specification

LevelToDropProbability

Level to Drop Probabilities

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

fill_level int32 optional

Fill level 0 - 100

drop_probability int32 optional

Drop probability 0 - 100

OverheadAccounting

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value int32 optional

Value

mode CosOverheadAccountingMode optional

Overhead accounting mode

RewriteRule

Rewrite Rules When operation is delete, the code point is optional or ignored.

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Attribute operation

forwarding_class_name string optional

Forwarding class name. Length: 1 to 64

loss_priority CosLossPriority optional

Loss priority

code_point_options FeatureCodePoint optional

Code points

SchedulerDropProfileMap

Scheduler Drop Profile Map

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

sets DropProfileMap repeated

List of drop profile maps

SchedulerExcessPriority

Scheduler Excess Priority Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value CosSchedulerExcessPriority optional

Value

SchedulerPriority

Scheduler Priority Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value CosSchedulerPriority optional

Value

SchedulerShapingRate

Scheduler Shaping Rate Message Structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value fixed64 optional

Value

value_spec CosSchedulerRateSpec optional

Value specification

burst_size fixed64 optional

Burst size from 1 to 1000000000 bytes

TcpAdjustRate

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

value fixed64 optional

value_spec CosTcpRateSpec optional

absolute only rate spec is valid.

TcpGuaranteedRate

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value fixed64 optional

Value

value_spec CosTcpRateSpec optional

Value specification

TcpSchedulerMap

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

scheduler_map_name string optional

String

TcpShapingRate

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

value fixed64 optional

Value

value_spec CosTcpRateSpec optional

Value specification

AtmServiceCategory

NameNumberDescription
ATM_SERVICE_INVALID 0

Invalid ATM Service

CBR 1

Constant bit rate

NRT_VBR 2

Non-realtime variable bit rate

RT_VBR 3

Realtime variable bit rate

CosBoolean

Boolean Values

NameNumberDescription
FALSE 0

False

TRUE 1

True

CosDelayBufferRateSpec

Delay Buffer Rate Specification Values

NameNumberDescription
DELAY_BUF_RATE_SPEC_INVALID 0

Invalid delay buffer rate specification

DELAY_BUF_RATE_SPEC_ABSOLUTE 1

Absolute delay buffer rate specification

DELAY_BUF_RATE_SPEC_CELL_PER_SECOND 2

Cells per second delay buffer rate specification

DELAY_BUF_RATE_SPEC_PERCENT 3

Percentage delay buffer rate specification

CosDirection

NameNumberDescription
DIRECTION_INVALID 0

Invalid direction

INGRESS 1

Ingress

EGRESS 2

Egress

CosDropProfileType

Cos Drop Profile Types

NameNumberDescription
DP_TYPE_INVALID 0

Invalid drop profile type

DP_TYPE_DISCRETE 1

Discrete fill levels

DP_TYPE_INTERPOLATE 2

Interpolate drop profile type

CosExcessBandwidthShareSpec

Cos Excess Bandwidth Share Specifications

NameNumberDescription
EXCESS_BW_SHARE_SPEC_INVALID 0

Invalid

EXCESS_BW_SHARE_SPEC_EQUAL 1

Equal share

EXCESS_BW_SHARE_SPEC_PROPORTION 2

Proportional share

CosExcessRateSpec

Excess Rate Specification Values

NameNumberDescription
EXCESS_RATE_SPEC_INVALID 0

Invalid excess rate spec

EXCESS_RATE_SPEC_PERCENT 1

Value in percent: Range 1 to 100

EXCESS_RATE_SPEC_PROPORTION 2

Proportional value: Range 0 to 1000

CosFcFabricPriority

Forwarding class fabric priority

NameNumberDescription
FAB_LOW 0

Fabric Priority - Low

FAB_HIGH 1

Fabric Priority - High

CosFcPolicingPriority

Forwarding class policing priority

NameNumberDescription
NORMAL 0

Normal policing priority

PREMIUM 1

Premium policing priority

CosFcSpuPriority

Forwarding class spu priority

NameNumberDescription
SPU_LOW 0

SPU Priority - Low

SPU_HIGH 1

SPU Priority - High

CosFeatureCodePointType

classifierType, and rewriteType

NameNumberDescription
FEATURE_CP_TYPE_INVALID 0

Invalid

FEATURE_CP_TYPE_DSCP 1

DSCP type

FEATURE_CP_TYPE_DSCP_IPV6 2

IPv6 type

FEATURE_CP_TYPE_EXP 3

EXP type

FEATURE_CP_TYPE_IEEE8021 4

IEEE 802.1 type

FEATURE_CP_TYPE_IEEE8021AD 5

IEEE 802.1AD type

FEATURE_CP_TYPE_INET_PRECEDENCE 6

Precedence type

CosFeaturesType

NameNumberDescription
FEATURES_MAPPED 0

To retrieve mapped features.

FEATURES_CONFIGURED 1

To retrieve all configured features.

FEATURES_ALL 2

To retrieve all features.

CosLossPriority

Loss Priority Values

NameNumberDescription
CLFR_RW_LP_INVALID 0

Invalid loss priority

CLFR_RW_LP_HIGH 1

Loss priority HIGH

CLFR_RW_LP_MEDIUM_HIGH 2

Loss priority MEDIUM-HIGH

CLFR_RW_LP_MEDIUM_LOW 3

Loss priority MEDIUM-LOW

CLFR_RW_LP_LOW 4

Loss priority LOW

CosMessageAttribOperation

Message attribute operations

NameNumberDescription
ATTRIB_NOOP 0

No Operation

ATTRIB_ADD 1

Add Attribute

ATTRIB_CHANGE 2

Change Attribute

ATTRIB_DELETE 3

Delete Attribute

CosNodeFeatureClassifierFamily

Classifier family

NameNumberDescription
NODE_FEATURE_CLFR_PROTO_INVALID 0

Invalid node feature classifier protocol

NODE_FEATURE_CLFR_DSCP 1

DSCP classifier

NODE_FEATURE_CLFR_DSCP_MPLS 2

MPLS classifier

NODE_FEATURE_CLFR_DSCP_IPV6 3

DSCP IPv6 classifier

NODE_FEATURE_CLFR_DSCP_IPV6_MPLS 4

IPv6 MPLS classifier

NODE_FEATURE_CLFR_EXP 5

EXP classifier

NODE_FEATURE_CLFR_INET_PRECEDENCE 6

INET Precedence classifier

NODE_FEATURE_CLFR_IEEE8021P 7

IEEE 802.1P classifier

NODE_FEATURE_CLFR_IEEE8021P_TAG_MODE_INNER 8

IEEE 802.1P Inner Tag Mode classifier

NODE_FEATURE_CLFR_IEEE8021P_TAG_MODE_TRANSPARENT 9

IEEE 802.1P Transparent Tag Mode classifier

NODE_FEATURE_CLFR_IEEE8021AD 10

IEEE 802.1AD classifier

NODE_FEATURE_CLFR_IEEE8021_AD_TAG_MODE_INNER 11

IEEE 802.1AD Inner Tag Mode classifier

NODE_FEATURE_CLFR_NO_DEFAULT 12

No Default classifier

CosNodeFeatureFamilyType

NameNumberDescription
NODE_FEATURE_FAMILY_INVALID 0

Invalid node feature family

NODE_FEATURE_FAMILY_CLFR_RULE 1

Classifier Rule node feature family

NODE_FEATURE_FAMILY_RW_RULE 2

Rewrite Rule node feature family

CosNodeFeatureRewriteFamily

Rewrite family

NameNumberDescription
NODE_FEATURE_RW_PROTO_INVALID 0

Invalid rewrite protocol

NODE_FEATURE_RW_DSCP 1

DSCP rewrite protocol

NODE_FEATURE_RW_DSCP_MPLS 2

DSCP MPLS rewrite protocol

NODE_FEATURE_RW_DSCP_IPV6 3

DSCP IPv6 rewrite protocol

NODE_FEATURE_RW_DSCP_IPV6_MPLS 4

DSCP IPv6 MPLS rewrite protocol

NODE_FEATURE_RW_EXP 5

EXP rewrite protocol

NODE_FEATURE_RW_EXP_MPLS_INET_BOTH 6

EXP MPLS INET Both rewrite protocol

NODE_FEATURE_RW_EXP_MPLS_INET_BOTH_NON_VPN 7

EXP MPLS INET Both (Non-VPN) rewrite protocol

NODE_FEATURE_RW_INET_PRECEDENCE 8

INET Precedence rewrite protocol

NODE_FEATURE_RW_INET_PREC_MPLS 9

INET Precedence MPLS rewrite protocol

NODE_FEATURE_RW_IEEE8021P 10

IEEE 802.1P rewrite protocol

NODE_FEATURE_RW_IEEE8021_TAG_MODE_OUTER_AND_INNER 11

IEEE 802.1 Inner and Outer Tag Mode rewrite protocol

NODE_FEATURE_RW_IEEE8021AD 12

IEEE 802.1AD rewrite protocol

NODE_FEATURE_RW_IEEE8021AD_TAG_MODE_OUTER_AND_INNER 13

IEEE 802.1 Inner and Outer Tag Mode rewrite protocol

CosNodeFeatureType

NameNumberDescription
NODE_FEATURE_INVALID 0

Invalid node feature

NODE_FEATURE_SMAP 1

SMAP node feature

NODE_FEATURE_SRATE 2

not valid for interface sets

NODE_FEATURE_TCP 3

TCP node feature

NODE_FEATURE_TCP_REMAINING 4

TCP Remaining node feature

NODE_FEATURE_FORWARDING_CLASS 5

Forwarding Class node feature - Not valid for interface sets

NODE_FEATURE_MEMBER_LINK_SCHED 6

Member Link Scheduler node feature

NODE_FEATURE_EXCESS_BW_SHARE 7

Excess Bandwidth Share node feature

CosNodeType

NameNumberDescription
NODE_TYPE_INVALID 0

Invalid node type

NODE_TYPE_INTERFACE 1

Interface node type

NODE_TYPE_LOGICAL_INTERFACE 2

Logical Interface node type

NODE_TYPE_INTERFACE_SET 3

Interface Set node type

CosOverheadAccountingMode

Overhead Accounting Mode Values

NameNumberDescription
OH_ACCT_MODE_INVALID 0

Invalid overhead accounting mode value

OH_ACCT_MODE_FRAME 1

Frame mode overhead accounting

OH_ACCT_MODE_CELL 2

Cell mode overhead accounting

CosReturnVal

Return values for the RPCs. used for message for GET/GETBULK requests

NameNumberDescription
EOK 0

Success

INVALID 1

Invalid status

NULL_MESSAGE 2

The RPC was a NULL buffer

EINVALID_MESSAGE 3

Wrong input

EINTERNAL 4

Server Internal error

UNSUPPORTED_OP 5

Operation not supported

NO_RESOURCE 6

Resource not available at server

NO_ENTRY 7

No entry available at server

NO_MORE_ENTRIES 8

No more entries available at server

E_IN_USE 9

Object is in use by other dependants

E_UNSUPP_FEATURE 10

unsupported feature

CosRoutingInstanceClassifierCodePointType

classifierType

NameNumberDescription
RI_CLFR_CP_TYPE_INVALID 0

Invalid classifierType

RI_CLFR_CP_TYPE_DSCP 1

DSCP type codepoint classifer

RI_CLFR_CP_TYPE_DSCP_IPV6 2

DSCP_IPv6 type codepoint classifier

RI_CLFR_CP_TYPE_EXP 3

EXP type codepoint classifier

RI_CLFR_CP_TYPE_IEEE8021 4

802.1 type codepoint classifier

RI_CLFR_CP_TYPE_NO_DEFAULT 5

No_default type codepoint classifier

CosRoutingInstanceClassifierIeee8021TagMode

Classifier tag modes

NameNumberDescription
RI_CLFR_IEEE8021_TAG_MODE_INVALID 0

Invalid 802.1 classifier tag mode

RI_CLFR_IEEE8021_TAG_MODE_ENCAP_VLAN_TAG_INNER 1

802.1 classifier tag mode = Encap VLAN tag inner

RI_CLFR_IEEE8021_TAG_MODE_ENCAP_VLAN_TAG_OUTER 2

802.1 classifier tag mode = Encap VLAN tag outer

CosRoutingInstanceFeatureType

Routing Instance Feature Types

NameNumberDescription
RI_FEATURE_TYPE_INVALID 0

Invalid feature type

RI_FEATURE_TYPE_CLFR_RULE 1

CLFR-Rule feature type

RI_FEATURE_TYPE_RW_RULE 2

RW-Rule feature type

CosRoutingInstanceRewriteCodePointType

rewriteType

NameNumberDescription
RI_RW_CP_TYPE_INVALID 0

Invalid rewriteType

RI_RW_CP_TYPE_IEEE8021 1

IEEE 802.1 rewriteType

RI_RW_CP_TYPE_IEEE8021AD 2

IEEE 802.1AD rewriteType

CosRoutingInstanceRewriteIeee8021xTagMode

Rewrite tag modes

NameNumberDescription
RI_RW_IEEE8021X_TAG_MODE_INVALID 0

Invalid 802.1X rewrite tag mode

RI_RW_IEEE8021X_TAG_MODE_ENCAP_VLAN_TAG_OUTER 1

802.1X rewrite tag mode = Encap VLAN tag outer

RI_RW_IEEE8021X_TAG_MODE_ENCAP_VLAN_TAG_OUTER_AND_INNER 2

802.1X rewrite tag mode = Encap VLAN tag outer and inner

CosSchedulerBufferSizeSpec

Scheduler Buffer Size Specification

NameNumberDescription
SCHED_BUF_SIZE_SPEC_INVALID 0

Invalid scheduler buffer size

SCHED_BUF_SIZE_SPEC_REMAINDER 1

Scheduler buffer size remainder

SCHED_BUF_SIZE_SPEC_PERCENT 2

Value in percent: 0 - 100

SCHED_BUF_SIZE_SPEC_TEMPORAL 3

Value in Microseconds

CosSchedulerExcessPriority

Scheduler Excess Priority Values

NameNumberDescription
SCHED_EXCESS_PRI_INVALID 0

Invalid scheduler excess priority value

SCHED_EXCESS_PRI_HIGH 1

Scheduler excess priority value HIGH

SCHED_EXCESS_PRI_MEDIUM_HIGH 2

Scheduler excess priority value MEDIUM-HIGH

SCHED_EXCESS_PRI_MEDIUM_LOW 3

Scheduler excess priority value MEDIUM-LOW

SCHED_EXCESS_PRI_LOW 4

Scheduler excess priority value LOW

SCHED_EXCESS_PRI_NONE 5

Scheduler excess priority value NONE

CosSchedulerGuaranteedRateExtendSpec

Scheduler Guaranteed Rate Extend Specificaton Values

NameNumberDescription
SCHED_G_RATE_EXTEND_SPEC_INVALID 0

Invalid scheduler guaranteed rate extend specification

SCHED_G_RATE_EXTEND_SPEC_EXACT 1

Exact scheduler guaranteed rate extend specification

SCHED_G_RATE_EXTEND_SPEC_RATE_LIMIT 2

Limit scheduler guaranteed rate extend specification

CosSchedulerLossPriority

Scheduler Loss Priority Values

NameNumberDescription
SCHED_DP_LP_INVALID 0

Invalid scheduler loss priority value

SCHED_DP_LP_HIGH 1

High loss priority

SCHED_DP_LP_MEDIUM_HIGH 2

Medium-high loss priority

SCHED_DP_LP_MEDIUM_LOW 3

Medium-low loss priority

SCHED_DP_LP_LOW 4

Low loss priority

SCHED_DP_LP_ANY 5

Any loss priority

CosSchedulerPriority

Scheduler Priority Values

NameNumberDescription
SCHED_PRI_INVALID 0

Involid Scheduler Priority

SCHED_PRI_HIGH 1

Schedluer Priority HIGH

SCHED_PRI_MEDIUM_HIGH 2

Schedluer Priority MEDIUM-HIGH

SCHED_PRI_MEDIUM_LOW 3

Schedluer Priority MEDIUM-LOW

SCHED_PRI_LOW 4

Schedluer Priority LOW

SCHED_PRI_STRICT_HIGH 5

Schedluer Priority STRICT-HIGH

CosSchedulerProtocol

Cos Scheduler Protocol Values

NameNumberDescription
SCHED_DP_PROTO_INVALID 0

Invalid Cos scheduler protocol

SCHED_DP_PROTO_TCP 1

TCP scheduler protocol

SCHED_DP_PROTO_NON_TCP 2

Non-TCP scheduler protocol

SCHED_DP_PROTO_ANY 3

Any scheduler protocol

CosSchedulerRateSpec

Scheduler Rate Specification Values

NameNumberDescription
SCHED_RATE_SPEC_INVALID 0

Invalid scheduler rate specification

SCHED_RATE_SPEC_ABSOLUTE 1

Absolute scheduler rate value in bits per second. Range: 3200 to 6400000000000

SCHED_RATE_SPEC_PERCENT 2

Percent range 0-100 for guaranteed rates / Percent range 1-100 for shaping rates

SCHED_RATE_SPEC_REMAINDER 3

Not valid for shaping rate.

CosTcpRateSpec

TCP Rate Specification Values

NameNumberDescription
TCP_RATE_SPEC_INVALID 0

Invalid TCP Rate

TCP_RATE_SPEC_ABSOLUTE 1

Absolute value: Range from 1000 to 6400000000000 in bits per second

TCP_RATE_SPEC_PERCENT 2

Value in percent: Range 0 to 100 / Not valid for per priority shaping rates / Not valid for adjust-minimum

StatusCode

TBD. The following enum needs to be removed when jnx_base_types.proto provides this / definition.

NameNumberDescription
SUCCESS 0

Success

FAILURE 1

Failuer

Cos

The Class of Service (CoS) service definition

Method NameRequest TypeResponse TypeDescription
CosForwardingClassGet CosForwardingClassQueryRequest CosForwardingClassQueryResponse

Forwarding class methods queried by forwarding class name

Needs key attribute forwarding class name in the request message. Optionally, the presence of single ref_objects in request allows the server to send all objects referring to this object.

CosForwardingClassGetNext CosForwardingClassQueryRequest CosForwardingClassQueryResponse

Key attribute forwarding class name is optional in the request message. If key is present then Getnext RPC returns next available forwarding class object. Otherwise, it returns the first object.

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosForwardingClassBulkGet CosForwardingClassQueryRequest CosForwardingClassQueryResponse

Key attribute forwarding class name is optional in the request message. If the key is present, then Getbulk RPC returns forwarding class matching to key and then all available forwarding class objects.

Optionally, the presence of single ref_objects in request allows the server to send all objects referring to this object.

CosForwardingClassGetByForwardingClassId CosForwardingClassIdQueryRequest CosForwardingClassIdQueryResponse

Forwarding class methods queried by forwarding class id Needs key attribute forwarding class id in the request message.

Optionally, the presence of single ref_objects in request allows the server to send all objects referring to this object.

CosForwardingClassGetByQueueId CosForwardingClassQueueQueryRequest CosForwardingClassQueueQueryResponse

Forwarding class methods queried by forwarding class queue id Needs key attribute forwarding class queue id in the request message.

Optionally, the presence of single ref_objects in request allows the server to send all objects referring to this object.

CosForwardingClassGetByRestrictQueueId CosForwardingClassRestrictQueueQueryRequest CosForwardingClassRestrictQueueQueryResponse

Forwarding class methods queried by forwarding class restricted queue id

Needs key attribute forwarding class restrict queue id in the request message. Optionally, the presence of single ref_objects in request allows the server to send all objects referring to this object.

CosClassifierAdd CosClassifierRequest CosStatus

Add : Adds a classifier object

The classifier add request includes:

1. classifier type and name.

2. one or more classifier rules.

CosClassifierDelete CosClassifierDeleteRequest CosStatus

Delete : Deletes a classifier object

The classifier delete request includes:

1. classifier type and name.

CosClassifierUpdate CosClassifierRequest CosStatus

Update : Updates classifier rules

The classifier update requests includes:

1. classifier type and name

2. one or more classifier rules to be updated

CosClassifierGet CosClassifierQueryRequest CosClassifierQueryResponse

Get: Needs key attributes classifier type and name in the request message.

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosClassifierGetNext CosClassifierQueryRequest CosClassifierQueryResponse

GetNext: Key attributes classifier type and/or name are optional in the request message.

Request will contain one of:

- 1. classifier name and type or

- 2. classifier type or

- 3. NULL

Response will be classifier object for the corresponding request which can be one of:

- Next classifier entry or

- Next classifier entry for given type or

- First classifier entry respectively

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosClassifierBulkGet CosClassifierQueryRequest CosClassifierQueryResponse

BulkGet: Key attributes classifier type and/or name are optional in the request message.

Request will contain one of:

- 1. classifier name and type or

- 2. classifier type or

- 3. NULL

Response will be classifier info for the corresponding request which can be one of:

- Requested and next set of classifier objects or

- Next set of classifier entries for the requested type or

- All classifier objects respectively

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosRewriteAdd CosRewriteRequest CosStatus

Add : Adds a rewrite object

The rewrite add request includes:

1. rewrite type and name.

2. one or more rewrite rules.

CosRewriteDelete CosRewriteDeleteRequest CosStatus

Delete : Deletes a rewrite object

The rewrite delete request includes:

1. rewrite type and name.

CosRewriteUpdate CosRewriteRequest CosStatus

Update : Updates rewrite rules

The rewrite update requests includes:

1. rewrite type and name.

2. one or more rewrite rules to be updated.

CosRewriteGet CosRewriteQueryRequest CosRewriteQueryResponse

Get: Needs key attributes rewrite type and name in the request message.

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosRewriteGetNext CosRewriteQueryRequest CosRewriteQueryResponse

GetNext: Key attributes rewrite type and/or name are optional in the request message. Request will contain one of

- 1. rewrite name and type or

- 2. rewrite type or

- 3. NULL Response will be rewrite object for the corresponding request which can be one of:

- Next rewrite entry or

- Next rewrite entry for given type or

- First rewrite entry respectively

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosRewriteBulkGet CosRewriteQueryRequest CosRewriteQueryResponse

BulkGet: Key attributes rewrite type and/or name are optional in the request message. Request contains one of:

- 1. rewrite name and type or

- 2. rewrite type or

- 3. NULL Response will be rewrite info for the corresponding request which can be one of:

- Requested and next set of rewrite objects or

- Next set of rewrite entries for the requested type or

- All rewrite objects respectively

Optionally, the presence of single ref_objects in the request allows the server to send all objects referring to this object.

CosNodeBindFeaturesAdd CosNodeBindFeaturesRequest CosStatus

Node bind feature RPC methods Add : Adds a node object's features The node add request includes:

1. node type and name.

2. parent node type and name if node type is not COS_BP_TYPE_IFD

3. features to be binded.

CosNodeBindFeaturesDelete CosNodeBindFeaturesDeleteRequest CosStatus

Delete : Deletes a node or node object's features. If the node is present in the data plane then the node's customized features will be deleted and applicable features will be updated with defaults. Otherwise, the node will be deleted. The node delete request includes:

1. node type and name.

CosNodeBindFeaturesUpdate CosNodeBindFeaturesRequest CosStatus

Update : Updates a node object's features If the node is present in the data plane then the node's features will be updated. Deleted features will be updated with their defaults. The node update request includes:

1. node type and name

2. optional parent node type and name if node type is not COS_BP_TYPE_IFD

3. features to be updated

CosNodeBindFeaturesGet CosNodeBindFeaturesQueryRequest CosNodeBindFeaturesQueryResponse

Get: To obtain specific node corresponding to key attributes. The get request should include key attributes node type and name.

1. node type and name

2. optional parent node type and name if node type is not COS_BP_TYPE_IFD

CosNodeBindFeaturesGetNext CosNodeBindFeaturesQueryRequest CosNodeBindFeaturesQueryResponse

GetNext: To obtain next available node object for given key attribute(s). Key attributes, node type and name are optional in the request message. Request contains one of: (parent node type and name are optional).

- 1. node name and type or

- 2. node type or

- 3. NULL

Response will be node object for the corresponding request which is one of:

- Next node entry or

- Next node entry for given node type or

- First IFD node entry respectively

CosNodeBindFeaturesBulkGet CosNodeBindFeaturesQueryRequest CosNodeBindFeaturesQueryResponse

BulkGet: To obtain requested and next available node objects for given key attribute(s). Key attributes node type and name are optional in the request message.

Request contains one of: (parent node type and name are optional).

- 1. node name and type or

- 2. node type or

- 3. NULL

Response will be node object and next bunch of node objects for the corresponding request which is one of:

- Requested node entry and bunch of next available node objects.

- A bunch of node objects for given node type or

- All node objects respectively

CosRoutingInstanceBindPointAdd CosRoutingInstanceBindPointRequest CosStatus

Routing Instance methods

Add : Adds a routing instance object's features The routing instance add request includes:

1. routing instance name

2. features to be binded

CosRoutingInstanceBindPointDelete CosRoutingInstanceBindPointDeleteRequest CosStatus

Delete : Deletes a routing instance or routing instance object's features. If routing instance present in the data plane then routing instance's customized features are deleted and applicable features will be updated with defaults. Otherwise, the routing instance object is deleted. The routing instance delete request includes:

1. routing instance name

CosRoutingInstanceBindPointUpdate CosRoutingInstanceBindPointRequest CosStatus

Update : Updates a routing instance object's features If routing instance present in the data plane then routing instance's features will be updated. Deleted features will be updated with their defaults. The routing instance update request includes:

1. routing instance name

2. features to be updated

CosRoutingInstanceBindPointGet CosRoutingInstanceBindPointQueryRequest CosRoutingInstanceBindPointQueryResponse

Get: To obtain specific routing instance corresponding to key attributes. The get request should include key attributes routing instance name 1. routing instance name.

CosRoutingInstanceBindPointGetNext CosRoutingInstanceBindPointQueryRequest CosRoutingInstanceBindPointQueryResponse

GetNext: To obtain next available routing instance object for given key attribute. Key attribute is routing instance name is optional in the request message. Request contains one of:

- 1. routing instance name or

- 2. NULL

Response will be routing instance object for the corresponding request which is one of:

- Next routing instance entry or

- First routing instance entry respectively

CosRoutingInstanceBindPointBulkGet CosRoutingInstanceBindPointQueryRequest CosRoutingInstanceBindPointQueryResponse

BulkGet: To obtain requested and next available routing instance objects for given key attribute. Key attribute routing instance name is optional in the request message. Request contains one of:

- 1. routing instance name or

- 3. NULL

Response will be routing instance object and next bunch of routing instance objects for the corresponding request which is one of:

- Requested routing instance entry and bunch of next available routing instance objects.

- All routing instance objects respectively

CosPurgeTimeDelete CosPurgeTimeRequest CosStatus

Delete : Resets purge time to its default value. The purge time delete request includes:

1. purge time (value is optional and ignored).

CosPurgeTimeUpdate CosPurgeTimeRequest CosStatus

Update : Set purge time to custom value in secs. The purge time update request includes:

1. purge time in secs.

CosPurgeTimeGet CosPurgeTimeRequest CosPurgeTimeResponse

Get : Get current purge time. The purge time response includes:

1. purge time in secs.

Scalar Value Types

.proto TypeNotesC++ TypeJava TypePython Type
double double double float
float float float float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str