sys-ut template¶

Packet config template

template Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name template-list

Collection URI /axapi/v3/sys-ut/template

Element Name template

Element URI /axapi/v3/sys-ut/template/{name}

Element Attributes template_attributes

Partition Visibility shared

Schema template schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/sys-ut/template	template attributes
POST /axapi/v3/sys-ut/template/ Payload: { "template": { "name": "a" } }
Create List	POST	/axapi/v3/sys-ut/template	template attributes
Get Object	GET	/axapi/v3/sys-ut/template/{name}	template attributes
GET /axapi/v3/sys-ut/template/a Reponse: { "template": { "name": "a", "uuid": "2d2801f4-5123-11ee-9f88-7dde599be8ea", "a10-url": "/axapi/v3/sys-ut/template/a" } }
Get List	GET	/axapi/v3/sys-ut/template	template-list
Modify Object	POST	/axapi/v3/sys-ut/template/{name}	template attributes
Replace Object	PUT	/axapi/v3/sys-ut/template/{name}	template attributes
PUT /axapi/v3/sys-ut/template/a Payload: { "template": { "name": "a" } }
Replace List	PUT	/axapi/v3/sys-ut/template	template-list
Delete Object	DELETE	/axapi/v3/sys-ut/template/{name}	template attributes
DELETE /axapi/v3/sys-ut/template/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

template-list¶

template-list is JSON List of template attributes

template-list : [

{ template attributes },

{ template attributes },

…

]

template attributes¶

ignore-validation

Description: ignore-validation is a JSON Block. Please see below for 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 l1

Type: Object

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

l2

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

Type: Object

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

l3

Description: l3 is a JSON Block. Please see below for 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 tcp

Type: Object

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

udp

Description: udp is a JSON Block. Please see below for 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

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

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

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

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

l1_trunk_list¶

Specification Value

Type list

Block object keys

trunk-end

Description Trunk Group

Type: number

trunk-start

Description Trunk groups

Type: number

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

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

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

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

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

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

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

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

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