sys-ut state next-state¶

Next State machine node

next-state Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name next-state-list

Collection URI /axapi/v3/sys-ut/state/{name}/next-state

Element Name next-state

Element URI /axapi/v3/sys-ut/state/{name}/next-state/{name}

Element Attributes next-state_attributes

Partition Visibility shared

Schema next-state schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/sys-ut/state/{name}/next-state	next-state attributes
Create List	POST	/axapi/v3/sys-ut/state/{name}/next-state	next-state attributes
Get Object	GET	/axapi/v3/sys-ut/state/{name}/next-state/{name}	next-state attributes
Get List	GET	/axapi/v3/sys-ut/state/{name}/next-state	next-state-list
Modify Object	POST	/axapi/v3/sys-ut/state/{name}/next-state/{name}	next-state attributes
Replace Object	PUT	/axapi/v3/sys-ut/state/{name}/next-state/{name}	next-state attributes
Replace List	PUT	/axapi/v3/sys-ut/state/{name}/next-state	next-state-list
Delete Object	DELETE	/axapi/v3/sys-ut/state/{name}/next-state/{name}	next-state attributes

next-state-list¶

next-state-list is JSON List of next-state attributes

next-state-list : [

{ next-state attributes },

{ next-state attributes },

…

]

next-state attributes¶

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

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

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

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

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

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

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

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

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

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

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

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

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

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