Junos OS cos IDL - Protocol Documentation

Table of Contents

cosd_service.proto

Top

Public API for the Junos OS Class of Service (CoS) Service

This IDL describes the services, messages, and enumerators available for the cosd API.

AdjustMinRate

Adjust minimum rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value fixed64 optional

Range = 3200 to 6400000000000 bits per second (inclusive)

AdjustPercent

Adjust by percentage

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value int32 optional

Range = 0 to 100 in percentage

BufferSize

Buffer size message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Buffer size operation

value_spec CosSchedulerBufferSizeSpec optional

Value specification

value fixed64 optional

Value

BurstSize

Burst size message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Burst size operation

value fixed64 optional

Burst size value

ClassifierRule

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

forwarding_class_name string optional

loss_priority CosLossPriority optional

code_points int32 repeated

CosAtmService

Class of service (CoS) ATM service message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

CoS ATM service operation

category AtmServiceCategory optional

ATM service category

CosClassifier

Following is the RPC request/response message for classifiers

RPC Methods:

ClassifierAdd, ClassifierDelete, ClassifierChange, ClassifierGet, ClassifierGetNext, ClassifierBulkGet

Request message:

Add, change requests must have classifier name and type along with the rules Delete requests must have classifier name and type Get requests must have classifier name and type GetNext/BulkGet requests optionally have name and type, i.e type, type & name, or none of them.

Response message:

Add, Change, and Delete requests return status and error strings. Get, GetNext, and BulkGet requests return classifier information.

FieldTypeLabelDescription
classifier_name string optional

Classifier Name

classifier_type CosFeatureCodePointType optional

Code point classifier type

sharable CosBoolean optional

Shareable flag

rule ClassifierRule repeated

List of Classifier rules

status CosReturnVal optional

Valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

Valid for Get, GetNext, and BulkGet responses

CosConfigPreference

CoS Config Preference Setting

FieldTypeLabelDescription
priority int32 optional

Used to 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

Shareable flag indicating that this is sharable with other applications.

drop_profile_type CosDropProfileType optional

Drop profile type

level_to_drop_probabilities LevelToDropProbability repeated

Level to drop probability

status CosReturnVal optional

Return status. Valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

List of referenced objects. Valid for Get, GetNext, and BulkGet responses

CosForwardingClass

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

RPC Methods:

ForwardClassGet, ForwardClassGetNext, ForwardClassBulkGet

Request message:

Requests must have forwarding_class_name specified for ForwardClassGet requests. For ForwardClassGetNext and ForwardClassBulkGet requests, forwarding_class_name is optional.

Response message:

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

FieldTypeLabelDescription
forwarding_class_name string optional

Forwarding class name

queue_id int32 optional

Forwarding class queue id

restrict_queue_id int32 optional

Forwarding class restricted queue id

forwarding_class_id int32 optional

Forwarding class id

fabric_priority CosFcFabricPriority optional

Forwarding class fabric priority

policing_priority CosFcPolicingPriority optional

Forwarding class policing priority

spu_priority CosFcSpuPriority optional

Forwarding class spu priority

sharable CosBoolean optional

Sharable flag

status CosReturnVal optional

Valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

List of referenced CoS objects - Valid for Get, GetNext, and BulkGet responses

CosForwardingClassId

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

RPC Methods:

ForwardClassGetByForwardingClassId

Request message:

By default, forwarding_class_id 0 is used if not specified explicitly.

Response message:

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

FieldTypeLabelDescription
forwarding_class_id int32 optional

Forwarding class id

queue_id int32 optional

Forwarding class queue id

forwarding_class_name string optional

Forwarding class name

restrict_queue_id int32 optional

Forwarding class restricted queue id

fabric_priority CosFcFabricPriority optional

Forwarding class fabric priority

policing_priority CosFcPolicingPriority optional

Forwarding class policing priority

spu_priority CosFcSpuPriority optional

Forwarding class spu priority

sharable CosBoolean optional

Sharable flag

status CosReturnVal optional

Valid for GET response

CosForwardingClassQueue

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

RPC Methods:

ForwardClassGetByQueueId

Request message:

By default, queue_id 0 is used if not specified explicitly.

Response message:

Response message will have the queue_id and a list of forwarding classes for the requested queue id

FieldTypeLabelDescription
queue_id int32 optional

Forwarding class queue id

forwarding_class_names string repeated

List of Forwarding class names

sharable CosBoolean optional

sharable flag

status CosReturnVal optional

valid for GET responses

CosForwardingClassRestrictQueue

Following is the RPC request-response message structure for forwarding classes queried by restricted queue id.

RPC Methods:

ForwardClassGetByRestrictQueueId

Request message:

By default, restrict_queue_id 0 is used if not specified explicitly.

Response message:

Response messages contain restricted queue id and a list of forwarding classes for the requested restricted queue id.

FieldTypeLabelDescription
restrict_queue_id int32 optional

forwarding_class_names string repeated

sharable CosBoolean optional

status CosReturnVal optional

CosNodeBindFeatures

FieldTypeLabelDescription
node_type CosNodeType optional

Node type ( IFD , IFL OR IFLSET )

node_name string optional

Node name ( IFD, IFL or IFLSET name )

node_parent_type CosNodeType optional

Parent node ( eg: IFD is parent for IFL )

node_parent_name string optional

Parent node name

features_type CosFeaturesType optional

filter for Get, GetNext, and BulkGet requests & responses

node_features CosNodeFeature repeated

Node features

node_family_features CosNodeFamilyFeature repeated

Family features

status CosReturnVal optional

Return status. Valid for Get, GetNext, and BulkGet responses

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

object_shared CosBoolean optional

Shared object

CosNodeFeature

Class of service node feature

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

CoS node feature operation

direction CosDirection optional

CoS direction

feature_type CosNodeFeatureType optional

CoS feature type

feature_val CosNodeFeatureVal optional

CoS feature value

CosNodeFeatureOption

Class of service node feature options

FieldTypeLabelDescription
classifier_family CosNodeFeatureClassifierFamily optional

Classifier family option

rewrite_family CosNodeFeatureRewriteFamily optional

Rewrite family option

CosNodeFeatureVal

Class of service node feature values

FieldTypeLabelDescription
value fixed64 optional

Integer value of the feature

object_name string optional

Object name

CosObjRefInfo

Optional reference information for GET/GETNEXT/GETBULK operations for a given CoS object.

FieldTypeLabelDescription
referencing_obj_type string optional

String value indicating the referencing object type.

referencing_obj_name string optional

String value indicating the referencing object name

referencing_obj_count int32 optional

Integer value indicating the number of referencing objects

CosPurgeTime

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

RPC Methods:

CosPurgeTimeDelete, CosPurgeTimeChange, CosPurgeTimeGet

Request message:

Change requests must include purge time in seconds. Range: 30-86400 Delete requests resets purge time to default value of 300 seconds. Get requests will return current purge timer value.

Response message:

Change and Delete requests will return status and error string Get requests will return purge time info

FieldTypeLabelDescription
purge_time int32 optional

Purge time. Range 30 to 86400 seconds

status CosReturnVal optional

Return status. Valid for GET responses

CosRate

Class of service (CoS) rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

CoS rate operation

value fixed64 optional

CoS rate value

CosResourceLimit

CoS Resource Limit settings

FieldTypeLabelDescription
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

Maximum unicast feature code sets per interface

max_mcast_fc_sets_per_interface int32 optional

Maximum multicast feature code 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 feature codes in a feature code set

max_queue_to_pause_profiles int32 optional

Maximum queue to pause profiles

max_ingress_shared_buffer int32 optional

Maximum number of ingress shared buffers

max_egress_shared_buffer int32 optional

Maximum number of egress shared buffers

max_global_buffer int32 optional

Maximum global buffer size

max_qcn_queues int32 optional

Maximum qcn queues

max_queues_per_interface int32 optional

Maximum queues per interface

default_fc_size int32 optional

Default forwarding class size

status CosReturnVal optional

Return status. Valid for Get, GetNext, and BulkGet responses.

CosRewrite

Following is the RPC request/response message for rewrites

RPC Methods:

RewriteAdd, RewriteDelete, RewriteChange, RewriteGet, RewriteGetNext, RewriteBulkGet

Request message:

Add and change requests must include the rewrite name and rewrite type along with the rules.

Get and Delete requests must include rewrite name and type.

GetNext/BulkGet requests can optionally include name and type. The inclusion can be name only, type only, name and type, or none.

Response message:

Add, Change, and Delete requests return status and error strings. Get, GetNext, and BulkGet requests return classifier information.

FieldTypeLabelDescription
rewrite_name string optional

Rewrite name

rewrite_type CosFeatureCodePointType optional

Rewrite type

sharable CosBoolean optional

Sharable flag indicates that this is shareable with other applications.

rule RewriteRule repeated

Rewrite rules

status CosReturnVal optional

Return status. This is valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

valid for Get, GetNext, and BulkGet responses

CosRoutingInstanceBindPoint

Following is the RPC request-response message for Routing instances

RPC Methods:

RoutingInstanceBindPointAdd, RoutingInstanceBindPointDelete, RoutingInstanceBindPointChange, RoutingInstanceBindPointGet, RoutingInstanceBindPointGetNext, RoutingInstanceBindPointBulkGet

Request message:

Add, change requests must include 1. Routing instance name 2. Routing instances classifier/rewrite features

Delete requests must include

1. Routing instance name

Get requests must include

1. Routing instance name

GetNext/BulkGet requests can have

1. Routing instance name or NULL

Response message:

Add, Change, and Delete requests return status and error strings. Get, GetNext, and BulkGet requests return feature information.

FieldTypeLabelDescription
routing_instance_name string optional

Routing instance name

classifiers CosRoutingInstanceClassifier repeated

List of Classifiers

rewrites CosRoutingInstanceRewrite repeated

status CosReturnVal optional

Return status. Valid for GET, GETNEXT, and BULKGET responses.

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

Feature object name

object_shared CosBoolean optional

Shared object

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

object_shared CosBoolean optional

Shared object

CosScheduler

RPC message for scheduler

FieldTypeLabelDescription
scheduler_name string optional

Scheduler name

adjust_min_rate AdjustMinRate optional

Adjust minimum rate

adjust_percent AdjustPercent optional

Adjust by percentage

g_rate GuaranteedRate optional

Scheduler guaranteed rate

s_rate SchedulerShapingRate optional

Scheduler shaping rate

e_rate ExcessRate optional

Scheduler excess rate

b_size BufferSize optional

Scheduler buffer size

priority SchedulerPriority optional

Scheduler priority setting

excess_priority SchedulerExcessPriority optional

Scheduler excess priority

drop_profile_mappings DropProfileMap repeated

List of drop profiles

status CosReturnVal optional

Return status. Valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

CosSchedulerMap

RPC message for scheduler maps

FieldTypeLabelDescription
scheduler_map_name string optional

Scheduler map name

fc_to_scheduler_mapping ForwardingClassToScheduler repeated

List of forwarding class to scheduler mappings

status CosReturnVal optional

Return status. Valid for Get, GetNext, and BulkGet responses

ref_objects CosObjRefInfo repeated

Reference objects. Valid for Get, GetNext, and BulkGet responses

CosStatus

Status message for ADD/CHANGE/DELETE requests

FieldTypeLabelDescription
status CosReturnVal optional

Status

error_string string optional

Error string

CosTrafficControlProfile

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 traffic shaping rate

shaping_burst_size BurstSize optional

Traffic shaping burst size

s_rate_priority_high TcpShapingRate optional

TCP traffic shaping rate high priority

shaping_burst_size_priority_high BurstSize optional

TCP traffic shaping burst size high priority

s_rate_priority_low TcpShapingRate optional

TCP traffic shaping burst rate low priority

shaping_burst_size_priority_low BurstSize optional

TCP traffic shaping burst size low priority

s_rate_priority_medium TcpShapingRate optional

TCP traffic shaping rate medium priority

shaping_burst_size_priority_medium BurstSize optional

TCP traffic shaping burst size medium priority

s_rate_excess_priority_high TcpShapingRate optional

TCP traffic shaping excess rate high priority

shaping_burst_size_excess_priority_high BurstSize optional

TCP traffic shaping burst size excess high priority

s_rate_excess_priority_low TcpShapingRate optional

TCP traffic shaping rate excess low priority

shaping_burst_size_excess_priority_low BurstSize optional

TCP traffic shaping burst size excess low priority

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 traffic shaping rate medium-low priority

shaping_burst_size_priority_medium_low BurstSize optional

TCP traffic shaping burst size medium-low priority

s_rate_priority_strict_high TcpShapingRate optional

TCP traffic shaping rate strict-high priority

shaping_burst_size_priority_strict_high BurstSize optional

TCP traffic shaping burst size strict-high priority

s_rate_excess_priority_meidum_high TcpShapingRate optional

TCP traffic shaping rate excess medium-high priority

shaping_burst_size_excess_priority_medium_high BurstSize optional

TCP traffic shaping burst size excess medium-high priority

s_rate_excess_priority_meidum_low TcpShapingRate optional

TCP traffic shaping rate excess medium-low priority

shaping_burst_size_excess_priority_medium_low BurstSize optional

TCP traffic shaping burst size excess medium-low priority

atm_service CosAtmService optional

Class of service ATM service

peak_rate CosRate optional

Class of service peak rate

sustained_rate CosRate optional

Class of service sustained rate

status CosReturnVal optional

Class of service return value /

ref_objects CosObjRefInfo repeated

List of class of service (CoS) reference objects

Valid for Get, GetNext, and BulkGet responses

DelayBufferRate

Delay buffer rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Delay buffer rate operation

value fixed64 optional

Delay buffer rate value

value_spec CosDelayBufferRateSpec optional

Delay buffer rate specification

DropProfileMap

RPC Message for Drop Profile Map

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Message attribute operation

scheduler_loss_priority CosSchedulerLossPriority optional

Scheduler loss priority

scheduler_protocol CosSchedulerProtocol optional

Scheduler 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

Excess rate operation

value fixed64 optional

Value

value_spec CosExcessRateSpec optional

Value specification

FeatureCodePoint

RPC Message for feature code points

FieldTypeLabelDescription
code_point int32 optional

Code point ID

code_point_str string optional

Code point string

ForwardingClassToScheduler

Forwarding class to scheduler message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Forwarding class to scheduler operation

forwarding_class_name string optional

Forwarding class name

scheduler_name string optional

Scheduler name

GuaranteedRate

Message format for setting the guaranteed rate of traffic

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Guaranteed rate operation

value_spec CosSchedulerRateSpec optional

Scheduler rate specification value

value fixed64 optional

Value

value_extend_spec CosSchedulerGuaranteedRateExtendSpec optional

Guaranteed rate extended specification value

LevelToDropProbability

RPC Message for Level to Drop Probability

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

fill_level int32 optional

0 - 100

drop_probability int32 optional

0 - 100

OverheadAccounting

Overhead accounting message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Overhead accounting 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

forwarding_class_name string optional

loss_priority CosLossPriority optional

code_point_options FeatureCodePoint optional

SchedulerDropProfileMap

RPC Message for scheduler drop profile map

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Oeration to be performed

sets DropProfileMap repeated

List of drop profiles

SchedulerExcessPriority

Scheduler excess priority message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Scheduler excess priority operation

value CosSchedulerExcessPriority optional

Scheduler excess priority value

SchedulerPriority

Scheduler priority message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Scheduler priority operation

value CosSchedulerPriority optional

Scheduler priority value

SchedulerShapingRate

Scheduler shaping rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

Operation

value fixed64 optional

64-bit integer value

value_spec CosSchedulerRateSpec optional

Scheduler rate specification value

burst_size fixed64 optional

Range = 1 to 1000000000 bytes (inclusive)

TcpAdjustRate

TCP adjust rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

TCP adjust rate operation

value fixed64 optional

TCP adjust rate value

value_spec CosTcpRateSpec optional

TCP rate specification value. Absolute only rate specification is valid.

TcpGuaranteedRate

TCP guaranteed rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

TCP guaranteed rate operation

value fixed64 optional

Value

value_spec CosTcpRateSpec optional

Value specification

TcpSchedulerMap

TCP scheduler map message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

TCP scheduler map operation

scheduler_map_name string optional

Scheduler map name

TcpShapingRate

TCP shaping rate message structure

FieldTypeLabelDescription
operation CosMessageAttribOperation optional

TCP shaping rate operation

value fixed64 optional

Value

value_spec CosTcpRateSpec optional

Value specification

AtmServiceCategory

ATM service categories

NameNumberDescription
ATM_SERVICE_INVALID 0

Invalid ATM service

CBR 1

Use constant bit rate

NRT_VBR 2

Use non-real-time variable bit rate

RT_VBR 3

Use real-time variable bit rate

CosBoolean

Boolean value enumeration

NameNumberDescription
FALSE 0

False boolean value

TRUE 1

True boolean value

CosDelayBufferRateSpec

Delay Buffer Rate Specifications

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

Delay buffer rate specification in cells per second

DELAY_BUF_RATE_SPEC_PERCENT 3

Delay buffer rate specification by percent

CosDirection

Class of service direction settings

NameNumberDescription
DIRECTION_INVALID 0

Invalid direction

INGRESS 1

Apply CoS on ingress

EGRESS 2

Apply CoS on egress

CosDropProfileType

Drop-Profile Types

NameNumberDescription
DP_TYPE_INVALID 0

Drop-profile Invalid

DP_TYPE_DISCRETE 1

Drop-profile discreet

DP_TYPE_INTERPOLATE 2

Drop-profile interpolated

CosExcessBandwidthShareSpec

Excess Bandwidth Share Specifications

NameNumberDescription
EXCESS_BW_SHARE_SPEC_INVALID 0

Invalid excess bandwidth share

EXCESS_BW_SHARE_SPEC_EQUAL 1

Excess bandwidth share equal

EXCESS_BW_SHARE_SPEC_PROPORTION 2

Excess bandwidth share proportional

CosExcessRateSpec

Excess Rate Specifications

NameNumberDescription
EXCESS_RATE_SPEC_INVALID 0

Invalid excess rate specification

EXCESS_RATE_SPEC_PERCENT 1

Excess rate specification in percent. Range = 1 to 100

EXCESS_RATE_SPEC_PROPORTION 2

Excess rate specification in proportion. Range = 0 to 1000

CosFcFabricPriority

Forwarding class fabric priority

NameNumberDescription
FAB_LOW 0

Forwarding class fabric priority low

FAB_HIGH 1

Forwarding class fabric priority high

CosFcPolicingPriority

Forwarding class policing priority

NameNumberDescription
NORMAL 0

Normal policing priority

PREMIUM 1

Premium policing priority

CosFcSpuPriority

Forwarding class Services Processing Unit (spu) priority

NameNumberDescription
SPU_LOW 0

Low priority

SPU_HIGH 1

High priority

CosFeatureCodePointType

CoS Feature Code Point Classifier and Rewrite Types

NameNumberDescription
FEATURE_CP_TYPE_INVALID 0

Feature code point type invalid

FEATURE_CP_TYPE_DSCP 1

Feautre code point type DSCP

FEATURE_CP_TYPE_DSCP_IPV6 2

Feature code point type DSCP IPv6

FEATURE_CP_TYPE_EXP 3

Feature code point type expedited

FEATURE_CP_TYPE_IEEE8021 4

Feature code point type IEEE 802.1

FEATURE_CP_TYPE_IEEE8021AD 5

Feature code point type IEEE 802.1 AD

FEATURE_CP_TYPE_INET_PRECEDENCE 6

Feature code point type inet precedence

CosFeaturesType

Feature type

NameNumberDescription
FEATURES_MAPPED 0

Mapped features

FEATURES_CONFIGURED 1

Configured features

FEATURES_ALL 2

All features

CosLossPriority

Loss Priority Settings

NameNumberDescription
CLFR_RW_LP_INVALID 0

Invalid.

CLFR_RW_LP_HIGH 1

High Loss Priority

CLFR_RW_LP_MEDIUM_HIGH 2

Medium_High Loss Priority

CLFR_RW_LP_MEDIUM_LOW 3

Medium_Low Loss Priority

CLFR_RW_LP_LOW 4

Low Loss Priority

CosMessageAttribOperation

NameNumberDescription
ATTRIB_NOOP 0

No operation

ATTRIB_ADD 1

Add attributes

ATTRIB_CHANGE 2

Change existing attribute

ATTRIB_DELETE 3

Delete existing attribute

CosNodeFeatureClassifierFamily

Class of service node feature classifier family types

NameNumberDescription
NODE_FEATURE_CLFR_PROTO_INVALID 0

Classifier protocol invalid

NODE_FEATURE_CLFR_DSCP 1

DSCP classifier family

NODE_FEATURE_CLFR_DSCP_MPLS 2

DSCP-MPLS classifier family

NODE_FEATURE_CLFR_DSCP_IPV6 3

DSCP-IPv6 classifier family

NODE_FEATURE_CLFR_DSCP_IPV6_MPLS 4

DSCP-IPv6-MPLS classifier family

NODE_FEATURE_CLFR_EXP 5

Expanded classifier family

NODE_FEATURE_CLFR_INET_PRECEDENCE 6

INET precedence classifier family

NODE_FEATURE_CLFR_IEEE8021P 7

IEEE 802.1P classifier family

NODE_FEATURE_CLFR_IEEE8021P_TAG_MODE_INNER 8

IEEE 802.1P inner tag mode classifier family

NODE_FEATURE_CLFR_IEEE8021P_TAG_MODE_TRANSPARENT 9

IEEE 802.1P transparent tag mode classifier family

NODE_FEATURE_CLFR_IEEE8021AD 10

IEEE 802.1AD classifier family

NODE_FEATURE_CLFR_IEEE8021_AD_TAG_MODE_INNER 11

IEEE 802.1AD inner tag mode classifier family

NODE_FEATURE_CLFR_NO_DEFAULT 12

No default classifier family

CosNodeFeatureFamilyType

Class of service node feature family type

NameNumberDescription
NODE_FEATURE_FAMILY_INVALID 0

Invalid feature family type

NODE_FEATURE_FAMILY_CLFR_RULE 1

Classifier rule feature family

NODE_FEATURE_FAMILY_RW_RULE 2

Rewrite rule feature family

CosNodeFeatureRewriteFamily

Class of service node feature rewrite family types

NameNumberDescription
NODE_FEATURE_RW_PROTO_INVALID 0

Invalid rewrite protocol

NODE_FEATURE_RW_DSCP 1

DSCP rewrite family

NODE_FEATURE_RW_DSCP_MPLS 2

DSCP-MPLS rewrite family

NODE_FEATURE_RW_DSCP_IPV6 3

DSCP-IPv6 rewrite family

NODE_FEATURE_RW_DSCP_IPV6_MPLS 4

DSCP-IPv6-MPLS rewrite family

NODE_FEATURE_RW_EXP 5

Expanded rewrite family

NODE_FEATURE_RW_EXP_MPLS_INET_BOTH 6

Expanded both MPLS and INET rewrite family

NODE_FEATURE_RW_EXP_MPLS_INET_BOTH_NON_VPN 7

Expanded both MPLS and INET (non-VPN) rewrite family

NODE_FEATURE_RW_INET_PRECEDENCE 8

INET precedence rewrite family

NODE_FEATURE_RW_INET_PREC_MPLS 9

INET precedence MPLS rewrite family

NODE_FEATURE_RW_IEEE8021P 10

IEEE 802.1P rewrite family

NODE_FEATURE_RW_IEEE8021_TAG_MODE_OUTER_AND_INNER 11

IEEE 802.1 outer and inner tag mode family

NODE_FEATURE_RW_IEEE8021AD 12

IEEE 802.1AD rewrite family

NODE_FEATURE_RW_IEEE8021AD_TAG_MODE_OUTER_AND_INNER 13

IEEE 802.1AD inner and outer tag mode rewrite family

CosNodeFeatureType

Class of service (CoS) node feature types

NameNumberDescription
NODE_FEATURE_INVALID 0

Invalid node feature Scheduler map feature

NODE_FEATURE_FORWARDING_CLASS 5

Forwarding class feature

Not valid for interface sets. Member link scheduler feature

CosNodeType

Class of service node types

NameNumberDescription
NODE_TYPE_INVALID 0

Invalid node type

NODE_TYPE_INTERFACE 1

Interface node type

NODE_TYPE_LOGICAL_INTERFACE 2

Logical interface node type Interface set node type

CosOverheadAccountingMode

Overhead Accounting Mode Settings

NameNumberDescription
OH_ACCT_MODE_INVALID 0

Invalid overhead accounting mode

OH_ACCT_MODE_FRAME 1

Overhead accounting mode set to frame

OH_ACCT_MODE_CELL 2

Overhead accounting mode set to cell

CosReturnVal

NameNumberDescription
EOK 0

INVALID 1

NULL_MESSAGE 2

EINVALID_MESSAGE 3

EINTERNAL 4

UNSUPPORTED_OP 5

NO_RESOURCE 6

NO_ENTRY 7

NO_MORE_ENTRIES 8

E_IN_USE 9

E_UNSUPP_FEATURE 10

CosRoutingInstanceClassifierCodePointType

Class of service routing instance classifier code point types

NameNumberDescription
RI_CLFR_CP_TYPE_INVALID 0

Invalid routing instance classifier code point type

RI_CLFR_CP_TYPE_DSCP 1

Routing instance classifier code point type DSCP

RI_CLFR_CP_TYPE_DSCP_IPV6 2

Routing instance classifier code point type DSCP-IPv6

RI_CLFR_CP_TYPE_EXP 3

Routing instance classifier code point type Expanded

RI_CLFR_CP_TYPE_IEEE8021 4

Routing instance classifier code point type IEEE 802.1

RI_CLFR_CP_TYPE_NO_DEFAULT 5

Routing instance classifier code point type no default

CosRoutingInstanceClassifierIeee8021TagMode

Class of service routing instance classifier IEEE 802.1 tag modes

NameNumberDescription
RI_CLFR_IEEE8021_TAG_MODE_INVALID 0

Invalid routing instance classifier tag mode

RI_CLFR_IEEE8021_TAG_MODE_ENCAP_VLAN_TAG_INNER 1

Routing instance classifier IEEE 802.1 tag mode encapsulate inner VLAN tag

RI_CLFR_IEEE8021_TAG_MODE_ENCAP_VLAN_TAG_OUTER 2

Routing instance classifier IEEE 802.1 tag mode encapsulate outer VLAN tag

CosRoutingInstanceFeatureType

Class of service routing instance feature types

NameNumberDescription
RI_FEATURE_TYPE_INVALID 0

Invalid routing instance feature type

RI_FEATURE_TYPE_CLFR_RULE 1

Routing instance classifier rule feature type

RI_FEATURE_TYPE_RW_RULE 2

Routing instance rewrite rule feature type

CosRoutingInstanceRewriteCodePointType

Class of service routing instance rewrite code point types

NameNumberDescription
RI_RW_CP_TYPE_INVALID 0

Invalid routing instance rewrite code point type

RI_RW_CP_TYPE_IEEE8021 1

Routing instance rewrite code point type IEEE 802.1

RI_RW_CP_TYPE_IEEE8021AD 2

Routing instance rewrite code point type IEEE 802.1AD

CosRoutingInstanceRewriteIeee8021xTagMode

Class of service routing instance rewrite IEEE 802.1X tag modes

NameNumberDescription
RI_RW_IEEE8021X_TAG_MODE_INVALID 0

Invalid routing instance rewrite IEEE 802.1X tag mode

RI_RW_IEEE8021X_TAG_MODE_ENCAP_VLAN_TAG_OUTER 1

Routing instance rewrite IEEE 802.1X tag mode encapsulate outer VLAN tag

RI_RW_IEEE8021X_TAG_MODE_ENCAP_VLAN_TAG_OUTER_AND_INNER 2

Routing instance rewrite IEEE 802.1X tag mode encapsulate outer and inner VLAN tags

CosSchedulerBufferSizeSpec

Scheduler Buffer Size Specifications

NameNumberDescription
SCHED_BUF_SIZE_SPEC_INVALID 0

Invalid scheduler buffer size

SCHED_BUF_SIZE_SPEC_REMAINDER 1

Remaining scheduler buffer size

SCHED_BUF_SIZE_SPEC_PERCENT 2

Scheduler buffer size in percent. Range = 0 to 100

SCHED_BUF_SIZE_SPEC_TEMPORAL 3

Scheduler buffer size in microseconds

CosSchedulerExcessPriority

Scheduler Excess Priority

NameNumberDescription
SCHED_EXCESS_PRI_INVALID 0

Invalid Priority

SCHED_EXCESS_PRI_HIGH 1

High priority

SCHED_EXCESS_PRI_MEDIUM_HIGH 2

Medium-High priority

SCHED_EXCESS_PRI_MEDIUM_LOW 3

Medium-Low priority

SCHED_EXCESS_PRI_LOW 4

Medium-Low priority

SCHED_EXCESS_PRI_NONE 5

Strict-High priority

CosSchedulerGuaranteedRateExtendSpec

Scheduler Guaranteed Rate Extended Specifications

NameNumberDescription
SCHED_G_RATE_EXTEND_SPEC_INVALID 0

Invalid guaranteed rate extended specification

SCHED_G_RATE_EXTEND_SPEC_EXACT 1

Exact scheduler guaranteed rate extended specification

SCHED_G_RATE_EXTEND_SPEC_RATE_LIMIT 2

Scheduler guaranteed rate extended specification rate limit

CosSchedulerLossPriority

Scheduler Loss Priority Settings

NameNumberDescription
SCHED_DP_LP_INVALID 0

Scheduler Drop-Profile Loss Priority Invalid

SCHED_DP_LP_HIGH 1

Scheduler drop-profile loss priority high

SCHED_DP_LP_MEDIUM_HIGH 2

Scheduler drop-profile loss priority medium-high

SCHED_DP_LP_MEDIUM_LOW 3

Scheduler drop-profile loss priority medium-low

SCHED_DP_LP_LOW 4

Scheduler drop-profile loss priority low

SCHED_DP_LP_ANY 5

Scheduler drop-profile loss priority any

CosSchedulerPriority

Scheduler Priority Settings

NameNumberDescription
SCHED_PRI_INVALID 0

Invalid priority

SCHED_PRI_HIGH 1

High priority

SCHED_PRI_MEDIUM_HIGH 2

Medium-High priority

SCHED_PRI_MEDIUM_LOW 3

Medium-Low priority

SCHED_PRI_LOW 4

Low priority

SCHED_PRI_STRICT_HIGH 5

Strict-High priority

CosSchedulerProtocol

Scheduler Drop-Profile Protocol Options

NameNumberDescription
SCHED_DP_PROTO_INVALID 0

Scheduler drop-profile protocol invalid

SCHED_DP_PROTO_TCP 1

Scheduler drop-profile protocol TCP

SCHED_DP_PROTO_NON_TCP 2

Scheduler drop-profile protocol non-TCP

SCHED_DP_PROTO_ANY 3

Scheduler drop-profile protocol any

CosSchedulerRateSpec

NameNumberDescription
SCHED_RATE_SPEC_INVALID 0

Invalid scheduler rate specification

SCHED_RATE_SPEC_ABSOLUTE 1

Absolute scheduler rate specification. Range = 3200 to 6400000000000 (bps)

SCHED_RATE_SPEC_PERCENT 2

Scheduler rate specification in percent.

Range = 0 to 100 for guaranteed rates Range = 1 to 100 for shaping rates

SCHED_RATE_SPEC_REMAINDER 3

Scheduler rate specification as remainder

Not valid for shaping rate.

CosTcpRateSpec

NameNumberDescription
TCP_RATE_SPEC_INVALID 0

TCP_RATE_SPEC_ABSOLUTE 1

Absolute TCP rate specification. Range = 1000 to 6400000000000 (bps)

TCP_RATE_SPEC_PERCENT 2

TCP rate specification in percent. Range = 0 - 100

Not valid for per priority shaping rates or adjust-minimum

CosService

Forwarding class methods queried by forwarding class name

Method NameRequest TypeResponse TypeDescription
ForwardClassGet CosForwardingClass CosForwardingClass

Get the current forwarding class

ForwardClassGetNext CosForwardingClass CosForwardingClass

Get next forwarding class

ForwardClassBulkGet CosForwardingClass CosForwardingClass

Get multiple forwarding class

ForwardClassGetByForwardingClassId CosForwardingClassId CosForwardingClassId

Forwarding class methods queried by forwarding class id

ForwardClassGetByQueueId CosForwardingClassQueue CosForwardingClassQueue

Forwarding class methods queried by forwarding class queue id

ForwardClassGetByRestrictQueueId CosForwardingClassRestrictQueue CosForwardingClassRestrictQueue

Forwarding class methods queried by forwarding class restricted queue id

ClassifierAdd CosClassifier CosStatus

Classifier methods

ClassifierDelete CosClassifier CosStatus

ClassifierChange CosClassifier CosStatus

ClassifierGet CosClassifier CosClassifier

ClassifierGetNext CosClassifier CosClassifier

ClassifierBulkGet CosClassifier CosClassifier

RewriteAdd CosRewrite CosStatus

Rewrite methods

RewriteDelete CosRewrite CosStatus

RewriteChange CosRewrite CosStatus

RewriteGet CosRewrite CosRewrite

RewriteGetNext CosRewrite CosRewrite

RewriteBulkGet CosRewrite CosRewrite

NodeFeaturesAdd CosNodeBindFeatures CosStatus

Node bind feature methods

NodeFeaturesDelete CosNodeBindFeatures CosStatus

NodeFeaturesChange CosNodeBindFeatures CosStatus

NodeFeaturesGet CosNodeBindFeatures CosNodeBindFeatures

NodeFeaturesGetNext CosNodeBindFeatures CosNodeBindFeatures

NodeFeaturesBulkGet CosNodeBindFeatures CosNodeBindFeatures

RoutingInstanceBindPointAdd CosRoutingInstanceBindPoint CosStatus

Routing instance methods

RoutingInstanceBindPointDelete CosRoutingInstanceBindPoint CosStatus

RoutingInstanceBindPointChange CosRoutingInstanceBindPoint CosStatus

RoutingInstanceBindPointGet CosRoutingInstanceBindPoint CosRoutingInstanceBindPoint

RoutingInstanceBindPointGetNext CosRoutingInstanceBindPoint CosRoutingInstanceBindPoint

RoutingInstanceBindPointBulkGet CosRoutingInstanceBindPoint CosRoutingInstanceBindPoint

CosPurgeTimeDelete CosPurgeTime CosStatus

Purge time methods

CosPurgeTimeChange CosPurgeTime CosStatus

CosPurgeTimeGet CosPurgeTime CosPurgeTime

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