sys-ut¶

System unit test

sys-ut Specification¶

Parameter Value

Type Configuration Resource

Element Name sys-ut

Element URI /axapi/v3/sys-ut

Element Attributes sys-ut_attributes

Partition Visibility shared

Schema sys-ut schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/sys-ut	sys-ut attributes
POST /axapi/v3/sys-ut Payload: { "sys-ut": { "action": "enable", "run-test": { "mode": "basic" } } }
Get Object	GET	/axapi/v3/sys-ut	sys-ut attributes
GET /axapi/v3/sys-ut Reponse: { "sys-ut": { "action": "enable", "uuid": "40e8e960-511e-11ee-9f88-7dde599be8ea", "common": { "proceed-on-error": 1, "uuid": "40e8f126-511e-11ee-9f88-7dde599be8ea", "a10-url": "/axapi/v3/sys-ut/common" }, "a10-url": "/axapi/v3/sys-ut" } }
Modify Object	POST	/axapi/v3/sys-ut	sys-ut attributes
Replace Object	PUT	/axapi/v3/sys-ut	sys-ut attributes
PUT /axapi/v3/sys-ut Payload: { "sys-ut": { "test-name": "abcd", "common": { "delay": 2 } } }
Delete Object	DELETE	/axapi/v3/sys-ut	sys-ut attributes
DELETE /axapi/v3/sys-ut Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

sys-ut attributes¶

action

Description ‘enable’: Set device to SUT mode; ‘disable’: Set device to normal mode;

Type: string

Supported Values: enable, disable

Default: disable

common

Description: common is a JSON Block. Please see below for common

Type: Object

Reference Object: /axapi/v3/sys-ut/common

event-list

Type: List

Reference Object: /axapi/v3/sys-ut/event/{event-number}

run-test

Description: run-test is a JSON Block. Please see below for run-test

Type: Object

Reference Object: /axapi/v3/sys-ut/run-test

secondary-name

Description Minor test case name. This is autogenerated

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

state-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}

template-list

Type: List

Reference Object: /axapi/v3/sys-ut/template/{name}

test-name

Description Name for this test case

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list¶

Specification Value

Type list

Block object keys

action-list

Type: List

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}

event-number

Description Event number

Type: number

Range: 1-32

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list_action-list¶

Specification Value

Type list

Block object keys

delay

Description Delay in seconds

Type: number

Range: 1-3600

direction

Description ‘send’: Test event; ‘expect’: Expected result; ‘wait’: Introduce a delay;

Type: string

Supported Values: send, expect, wait

drop

Description Packet drop. Only allowed for output spec

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore-validation

Description: ignore-validation is a JSON Block. Please see below for event-list_action-list_ignore-validation

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/ignore-validation

l1

Description: l1 is a JSON Block. Please see below for event-list_action-list_l1

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l1

l2

Description: l2 is a JSON Block. Please see below for event-list_action-list_l2

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l2

l3

Description: l3 is a JSON Block. Please see below for event-list_action-list_l3

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3

tcp

Description: tcp is a JSON Block. Please see below for event-list_action-list_tcp

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp

template

Description Packet template

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/sys-ut/template

udp

Description: udp is a JSON Block. Please see below for event-list_action-list_udp

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/udp

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list_action-list_ignore-validation¶

Specification Value

Type object

all

Description Skip validation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l1

Description Dont validate TX descriptor. This includes Tx port, Len & vlan

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l2

Description Dont validate L2 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l3

Description Dont validate L3 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l4

Description Dont validate L4 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list_action-list_udp¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

length

Description Total packet length starting at UDP header

Type: number

Range: 64-9000

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-port

Description Source port value

Type: number

Range: 1-65535

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list_action-list_tcp¶

Specification Value

Type object

ack-seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

flags

Description: flags is a JSON Block. Please see below for event-list_action-list_tcp_flags

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp/flags

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

options

Description: options is a JSON Block. Please see below for event-list_action-list_tcp_options

Type: Object

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp/options

seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

src-port

Description Source port value

Type: number

Range: 1-65535

urgent

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

window

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

event-list_action-list_tcp_flags¶

Specification Value

Type object

ack

Description Ack

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cwr

Description Cwr

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ece

Description Ece

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fin

Description Fin

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

psh

Description Psh

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rst

Description Rst

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

syn

Description Syn

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

urg

Description Urg

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

event-list_action-list_tcp_options¶

Specification Value

Type object

mss

Description TCP MSS

Type: number

Range: 536-1460

nop

Description No Op

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sack-type

Description ‘permitted’: permitted; ‘block’: block;

Type: string

Supported Values: permitted, block

time-stamp-enable

Description adds Time Stamp to options

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

wscale

Description

Type: number

Range: 1-8

event-list_action-list_l2¶

Specification Value

Type object

ethertype

Description L2 frame type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mac-list

Type: List

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l2/mac/{src-dst}

protocol

Description ‘arp’: arp; ‘ipv4’: ipv4; ‘ipv6’: ipv6;

Type: string

Supported Values: arp, ipv4, ipv6

Default: ipv4

Mutual Exclusion: protocol and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ethertype number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and protocol are mutually exclusive

vlan

Description Vlan ID on the packet. 0 is untagged

Type: number

Range: 0-4095

Default: 0

event-list_action-list_l2_mac-list¶

Specification Value

Type list

Block object keys

address-type

Description ‘broadcast’: broadcast; ‘multicast’: multicast;

Type: string

Supported Values: broadcast, multicast

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Mac Address

Type: string

Format: mac-address

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

event-list_action-list_l3¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

ip-list

Type: List

Reference Object: /axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst}

protocol

Description L4 Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description

Type: number

Range: 1-64

type

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp;

Type: string

Supported Values: tcp, udp, icmp

Mutual Exclusion: type and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description protocol number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and type are mutually exclusive

event-list_action-list_l3_ip-list¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

ipv4-address

Description IP address

Type: string

Format: ipv4-address

ipv6-address

Description Ipv6 address

Type: string

Format: ipv6-address

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

event-list_action-list_l1¶

Specification Value

Type object

auto

Description Auto calculate pkt len

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: auto and value are mutually exclusive

eth-list

Type: List

length

Description packet length

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trunk_list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Total packet length starting at L2 header

Type: number

Range: 64-9000

Mutual Exclusion: value and auto are mutually exclusive

event-list_action-list_l1_eth-list¶

Specification Value

Type list

Block object keys

ethernet-end

Description Ethernet port

Type: number

Format: interface

ethernet-start

Description Ethernet port (Interface number)

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

event-list_action-list_l1_trunk_list¶

Specification Value

Type list

Block object keys

trunk-end

Description Trunk Group

Type: number

trunk-start

Description Trunk groups

Type: number

common¶

Specification Value

Type object

delay

Description wait time in seconds after each run

Type: number

Range: 1-3600

proceed-on-error

Description Run test even in case of event failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template-list¶

Specification Value

Type list

Block object keys

ignore-validation

Description: ignore-validation is a JSON Block. Please see below for template-list_ignore-validation

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/ignore-validation

l1

Description: l1 is a JSON Block. Please see below for template-list_l1

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/l1

l2

Description: l2 is a JSON Block. Please see below for template-list_l2

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/l2

l3

Description: l3 is a JSON Block. Please see below for template-list_l3

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/l3

name

Description template name

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

tcp

Description: tcp is a JSON Block. Please see below for template-list_tcp

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/tcp

udp

Description: udp is a JSON Block. Please see below for template-list_udp

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/udp

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template-list_udp¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

length

Description Total packet length starting at UDP header

Type: number

Range: 64-9000

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-port-range

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template-list_udp_src-port-range¶

Specification Value

Type list

Block object keys

src-port-end

Description Src port end value

Type: number

src-port-start

Description Source port value

Type: number

template-list_l1¶

Specification Value

Type object

auto

Description Auto calculate pkt len

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: auto and value are mutually exclusive

drop

Description Packet drop. Only allowed for output spec

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

eth-list

Type: List

length

Description packet length

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trunk_list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Total packet length starting at L2 header

Type: number

Range: 64-9000

Mutual Exclusion: value and auto are mutually exclusive

template-list_l1_eth-list¶

Specification Value

Type list

Block object keys

ethernet-end

Description Ethernet port

Type: number

Format: interface

ethernet-start

Description Ethernet port (Interface number)

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

template-list_l1_trunk_list¶

Specification Value

Type list

Block object keys

trunk-end

Description Trunk Group

Type: number

trunk-start

Description Trunk groups

Type: number

template-list_l2¶

Specification Value

Type object

ethertype

Description L2 frame type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mac-list

Type: List

Reference Object: /axapi/v3/sys-ut/template/{name}/l2/mac/{src-dst}

protocol

Description ‘arp’: arp; ‘ipv4’: ipv4; ‘ipv6’: ipv6;

Type: string

Supported Values: arp, ipv4, ipv6

Default: ipv4

Mutual Exclusion: protocol and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ethertype number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and protocol are mutually exclusive

vlan

Description Vlan ID on the packet. 0 is untagged

Type: number

Range: 0-4095

Default: 0

template-list_l2_mac-list¶

Specification Value

Type list

Block object keys

address-type

Description ‘broadcast’: broadcast; ‘multicast’: multicast;

Type: string

Supported Values: broadcast, multicast

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Mac Address

Type: string

Format: mac-address

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

template-list_l3¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

ip-list

Type: List

Reference Object: /axapi/v3/sys-ut/template/{name}/l3/ip/{src-dst}

protocol

Description L4 Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description

Type: number

Range: 1-64

type

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp;

Type: string

Supported Values: tcp, udp, icmp

Mutual Exclusion: type and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description protocol number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and type are mutually exclusive

template-list_l3_ip-list¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

ipv4-end-address

Description IP end address

Type: string

Format: ipv4-address

ipv4-start-address

Description IP address

Type: string

Format: ipv4-address

ipv6-end-address

Description Ipv6 end address

Type: string

Format: ipv6-address

ipv6-start-address

Description Ipv6 address

Type: string

Format: ipv6-address

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

template-list_ignore-validation¶

Specification Value

Type object

all

Description Skip validation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l1

Description Dont validate TX descriptor. This includes Tx port, Len & vlan

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l2

Description Dont validate L2 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l3

Description Dont validate L3 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l4

Description Dont validate L4 header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template-list_tcp¶

Specification Value

Type object

ack-seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

flags

Description: flags is a JSON Block. Please see below for template-list_tcp_flags

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/tcp/flags

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

options

Description: options is a JSON Block. Please see below for template-list_tcp_options

Type: Object

Reference Object: /axapi/v3/sys-ut/template/{name}/tcp/options

seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

src-port-range

Type: List

urgent

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

window

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

template-list_tcp_src-port-range¶

Specification Value

Type list

Block object keys

src-port-end

Description Src port end value

Type: number

src-port-start

Description Source port value

Type: number

template-list_tcp_flags¶

Specification Value

Type object

ack

Description Ack

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cwr

Description Cwr

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ece

Description Ece

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fin

Description Fin

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

psh

Description Psh

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rst

Description Rst

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

syn

Description Syn

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

urg

Description Urg

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

template-list_tcp_options¶

Specification Value

Type object

mss

Description TCP MSS

Type: number

Range: 536-1460

nop

Description No Op

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sack-type

Description ‘permitted’: permitted; ‘block’: block;

Type: string

Supported Values: permitted, block

time-stamp-enable

Description adds Time Stamp to options

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

wscale

Description

Type: number

Range: 1-8

state-list¶

Specification Value

Type list

Block object keys

name

Description Node name

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

next-state-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list¶

Specification Value

Type list

Block object keys

case-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}

name

Description Node name

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list_case-list¶

Specification Value

Type list

Block object keys

action-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}

case-number

Description

Type: number

Range: 1-32

repeat

Description number of times case should be repeated before state transition

Type: number

Range: 1-32

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list_case-list_action-list¶

Specification Value

Type list

Block object keys

delay

Description Delay in seconds

Type: number

Range: 1-3600

direction

Description ‘send’: Test event; ‘expect’: Expected result; ‘wait’: Introduce a delay;

Type: string

Supported Values: send, expect, wait

drop

Description Packet drop. Only allowed for output spec

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l1

Description: l1 is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_l1

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/l1

l2

Description: l2 is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_l2

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/l2

l3

Description: l3 is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_l3

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/l3

tcp

Description: tcp is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_tcp

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/tcp

template

Description Packet template

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/sys-ut/template

udp

Description: udp is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_udp

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/udp

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list_case-list_action-list_udp¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

length

Description Total packet length starting at UDP header

Type: number

Range: 64-9000

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-port

Description Source port value

Type: number

Range: 1-65535

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list_case-list_action-list_tcp¶

Specification Value

Type object

ack-seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

dest-port

Description Dest port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dest-port-value

Description Dest port value

Type: number

Range: 1-65535

flags

Description: flags is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_tcp_flags

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/tcp/flags

nat-pool

Description Nat pool port

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

options

Description: options is a JSON Block. Please see below for state-list_next-state-list_case-list_action-list_tcp_options

Type: Object

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/tcp/options

seq-number

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

src-port

Description Source port value

Type: number

Range: 1-65535

urgent

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

window

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

state-list_next-state-list_case-list_action-list_tcp_flags¶

Specification Value

Type object

ack

Description Ack

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cwr

Description Cwr

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ece

Description Ece

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fin

Description Fin

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

psh

Description Psh

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rst

Description Rst

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

syn

Description Syn

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

urg

Description Urg

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

state-list_next-state-list_case-list_action-list_tcp_options¶

Specification Value

Type object

mss

Description TCP MSS

Type: number

Range: 536-1460

nop

Description No Op

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sack-type

Description ‘permitted’: permitted; ‘block’: block;

Type: string

Supported Values: permitted, block

time-stamp-enable

Description adds Time Stamp to options

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

wscale

Description

Type: number

Range: 1-8

state-list_next-state-list_case-list_action-list_l2¶

Specification Value

Type object

ethertype

Description L2 frame type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mac-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/l2/mac/{src-dst}

protocol

Description ‘arp’: arp; ‘ipv4’: ipv4; ‘ipv6’: ipv6;

Type: string

Supported Values: arp, ipv4, ipv6

Default: ipv4

Mutual Exclusion: protocol and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ethertype number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and protocol are mutually exclusive

vlan

Description Vlan ID on the packet. 0 is untagged

Type: number

Range: 0-4095

Default: 0

state-list_next-state-list_case-list_action-list_l2_mac-list¶

Specification Value

Type list

Block object keys

address-type

Description ‘broadcast’: broadcast; ‘multicast’: multicast;

Type: string

Supported Values: broadcast, multicast

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Mac Address

Type: string

Format: mac-address

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

state-list_next-state-list_case-list_action-list_l3¶

Specification Value

Type object

checksum

Description ‘valid’: valid; ‘invalid’: invalid;

Type: string

Supported Values: valid, invalid

Default: valid

ip-list

Type: List

Reference Object: /axapi/v3/sys-ut/state/{name}/next-state/{name}/case/{case-number}/action/{direction}/l3/ip/{src-dst}

protocol

Description L4 Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description

Type: number

Range: 1-64

type

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp;

Type: string

Supported Values: tcp, udp, icmp

Mutual Exclusion: type and value are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description protocol number

Type: number

Range: 0-2147483647

Mutual Exclusion: value and type are mutually exclusive

state-list_next-state-list_case-list_action-list_l3_ip-list¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

ipv4-address

Description IP address

Type: string

Format: ipv4-address

ipv6-address

Description Ipv6 address

Type: string

Format: ipv6-address

nat-pool

Description Nat pool

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

src-dst

Description ‘dest’: dest; ‘src’: src;

Type: string

Supported Values: dest, src

trunk

Description Trunk number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual Ethernet interface

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ve

virtual-server

Description vip

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/virtual-server

state-list_next-state-list_case-list_action-list_l1¶

Specification Value

Type object

auto

Description Auto calculate pkt len

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: auto and value are mutually exclusive

eth-list

Type: List

length

Description packet length

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trunk_list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Total packet length starting at L2 header

Type: number

Range: 64-9000

Mutual Exclusion: value and auto are mutually exclusive

state-list_next-state-list_case-list_action-list_l1_eth-list¶

Specification Value

Type list

Block object keys

ethernet-end

Description Ethernet port

Type: number

Format: interface

ethernet-start

Description Ethernet port (Interface number)

Type: number

Format: interface

Reference Object: /axapi/v3/interface/ethernet

state-list_next-state-list_case-list_action-list_l1_trunk_list¶

Specification Value

Type list

Block object keys

trunk-end

Description Trunk Group

Type: number

trunk-start

Description Trunk groups

Type: number

run-test¶

Specification Value

Type object

mode

Description ‘basic’: Run Basic mode; ‘fault-injection’: Run FI mode. This will also run Basic mode to gather data; ‘cpu-rr’: Run CPU RR mode; ‘frag’: Run IP frag mode;

Type: string

Supported Values: basic, fault-injection, cpu-rr, frag