Skip to content

Latest commit

 

History

History
171 lines (134 loc) · 5.55 KB

command reference.md

File metadata and controls

171 lines (134 loc) · 5.55 KB
Raw

This file lists currently implemented commands for nikss-ctl. Some features of these commands might be still unimplemented.

nikss-ctl supports help keyword, which can be used on every object. The same result is when there is no command for object.

nikss-ctl [OPTIONS] OBJECT { COMMAND | help }
nikss-ctl help

OBJECT := { clone-session |
            multicast-group |
            pipeline |
            add-port |
            del-port |
            table |
            action-selector |
            action-profile |
            meter |
            digest |
            counter |
            register |
            value-set |
            validate-os }
OPTIONS := {}

Clone sessions

nikss-ctl clone-session create pipe ID SESSION
nikss-ctl clone-session delete pipe ID SESSION
nikss-ctl clone-session add-member pipe ID SESSION egress-port OUTPUT_PORT instance INSTANCE_ID [cos CLASS_OF_SERVICE] [truncate plen_bytes BYTES]
nikss-ctl clone-session del-member pipe ID SESSION egress-port OUTPUT_PORT instance INSTANCE_ID
nikss-ctl clone-session get pipe ID [SESSION]

SESSION := id SESSION_ID

Multicast groups

nikss-ctl multicast-group create pipe ID MULTICAST_GROUP
nikss-ctl multicast-group delete pipe ID MULTICAST_GROUP
nikss-ctl multicast-group add-member pipe ID MULTICAST_GROUP egress-port OUTPUT_PORT instance INSTANCE_ID
nikss-ctl multicast-group del-member pipe ID MULTICAST_GROUP egress-port OUTPUT_PORT instance INSTANCE_ID
nikss-ctl multicast-group get pipe ID [MULTICAST_GROUP]

MULTICAST_GROUP := id MULTICAST_GROUP_ID

Pipelines and ports management

nikss-ctl pipeline load id ID PATH
nikss-ctl pipeline unload id ID
nikss-ctl pipeline show id ID
nikss-ctl add-port pipe id ID dev DEV
nikss-ctl del-port pipe id ID dev DEV

Tables

nikss-ctl table add pipe ID TABLE_NAME action ACTION key MATCH_KEY [data ACTION_PARAMS] [priority PRIORITY]
nikss-ctl table add pipe ID TABLE_NAME ref key MATCH_KEY data ACTION_REFS [priority PRIORITY]
nikss-ctl table update pipe ID TABLE_NAME action ACTION key MATCH_KEY [data ACTION_PARAMS] [priority PRIORITY]
nikss-ctl table delete pipe ID TABLE_NAME [key MATCH_KEY]
nikss-ctl table get pipe ID TABLE_NAME [ref] [key MATCH_KEY]
nikss-ctl table default set pipe ID TABLE_NAME action ACTION [data ACTION_PARAMS]
nikss-ctl table default get pipe ID TABLE_NAME

ACTION := { id ACTION_ID | name ACTION_NAME }
ACTION_REFS := { MEMBER_REF | group GROUP_REF } 
MATCH_KEY := { EXACT_KEY | LPM_KEY | RANGE_KEY | TERNARY_KEY | none }
EXACT_KEY := { DATA }
LPM_KEY := { DATA/PREFIX_LEN }
RANGE_KEY := { DATA_MIN..DATA_MAX }
TERNARY_KEY := { DATA^MASK }
ACTION_PARAMS := { DATA | counter COUNTER_NAME COUNTER_VALUE | meter METER_NAME METER_VALUE }
COUNTER_VALUE := { BYTES | PACKETS | BYTES:PACKETS }
METER_VALUE := { PIR:PBS CIR:CBS }

ref keyword means that table has an implementation, ActionProfile or ActionSelector, and then behave according to this situation.

Action Selectors

nikss-ctl action-selector add-member pipe ID ACTION_SELECTOR_NAME action ACTION [data ACTION_PARAMS]
nikss-ctl action-selector delete-member pipe ID ACTION_SELECTOR_NAME MEMBER_REF
nikss-ctl action-selector update-member pipe ID ACTION_SELECTOR_NAME MEMBER_REF action ACTION [data ACTION_PARAMS]
nikss-ctl action-selector create-group pipe ID ACTION_SELECTOR_NAME
nikss-ctl action-selector delete-group pipe ID ACTION_SELECTOR_NAME GROUP_REF
nikss-ctl action-selector add-to-group pipe ID ACTION_SELECTOR_NAME MEMBER_REF to GROUP_REF
nikss-ctl action-selector delete-from-group pipe ID ACTION_SELECTOR_NAME MEMBER_REF from GROUP_REF
nikss-ctl action-selector empty-group-action pipe ID ACTION_SELECTOR_NAME action ACTION [data ACTION_PARAMS]
nikss-ctl action-selector get pipe ID ACTION_SELECTOR_NAME [member MEMBER_REF | group GROUP_REF | empty-group-action]

ACTION := { id ACTION_ID | name ACTION_NAME }
ACTION_PARAMS := { DATA }

Action Profile

nikss-ctl action-profile add-member pipe ID ACTION_PROFILE_NAME action ACTION [data ACTION_PARAMS]
nikss-ctl action-profile delete-member pipe ID ACTION_PROFILE_NAME MEMBER_REF
nikss-ctl action-profile update-member pipe ID ACTION_PROFILE_NAME MEMBER_REF action ACTION [data ACTION_PARAMS]
nikss-ctl action-profile get pipe ID ACTION_PROFILE_NAME [member MEMBER_REF]

ACTION := { id ACTION_ID | name ACTION_NAME }
ACTION_PARAMS := { DATA }

Meters

nikss-ctl meter get pipe ID METER_NAME [index INDEX]
nikss-ctl meter update pipe ID METER_NAME index INDEX PIR:PBS CIR:CBS
nikss-ctl meter reset pipe ID METER_NAME [index INDEX]

INDEX := { DATA }
PIR := { DATA }
PBS := { DATA }
CIR := { DATA }
CBS := { DATA }

Digests

nikss-ctl digest get pipe ID DIGEST_NAME
nikss-ctl digest get-all pipe ID DIGEST_NAME

Note: the get-all command is vulnerable to the (D)DoS attack when rate of digests generation is greater or equal to read rate.

Counters

nikss-ctl counter get pipe ID COUNTER_NAME [key DATA]
nikss-ctl counter set pipe ID COUNTER_NAME [key DATA] value COUNTER_VALUE
nikss-ctl counter reset pipe ID COUNTER_NAME [key DATA]

COUNTER_VALUE := { BYTES | PACKETS | BYTES:PACKETS }

Registers

nikss-ctl register get pipe ID REGISTER_NAME [index DATA]
nikss-ctl register set pipe ID REGISTER_NAME index DATA value REGISTER_VALUE

REGISTER_VALUE := { DATA }

Value set

nikss-ctl value-set insert pipe ID VALUE_SET_NAME value DATA
nikss-ctl value-set delete pipe ID VALUE_SET_NAME value DATA
nikss-ctl value-set get pipe ID VALUE_SET_NAME

Validate system configuration

nikss-ctl validate-os