.. _sys_ut_event:

sys-ut event
============

Specify event parameters


event Specification
-------------------

	===================================== ====================================================================
	 **Parameter**                         **Value** 

	===================================== ====================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *event-number*

	 **Collection Name**                   :ref:`3147_event_list`

	 **Collection URI**                    /axapi/v3/sys-ut/event

	                                       

	 **Element Name**                      event

	 **Element URI**                       /axapi/v3/sys-ut/event/{event-number}

	 **Element Attributes**                event_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`event schema <sys-ut-event/sys-ut-event.txt>`
	===================================== ====================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/sys_ut_event_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event/{event-number}



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/sys_ut_event_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event/{event-number}



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event/{event-number}



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/sys_ut_event_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/sys-ut/event/{event-number}



.. raw:: html

   </td><td valign = 'top'>


:ref:`3147_event_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/sys_ut_event_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _3147_event_list:

event-list
----------


    event-list is **JSON List** of :ref:`3147_event_attributes` 

        event-list : [

             { :ref:`3147_event_attributes` },

             { :ref:`3147_event_attributes` },

             ...

         ]

.. _3147_event_attributes:

event attributes
----------------

    **action-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction} <sys_ut_event>`

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

.. _3147_action-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 :ref:`3147_action-list_ignore-validation` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/ignore-validation <sys_ut_event>`

    **l1**

        **Description:** l1 is a **JSON Block**.  Please see below for :ref:`3147_action-list_l1` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/l1 <sys_ut_event>`

    **l2**

        **Description:** l2 is a **JSON Block**.  Please see below for :ref:`3147_action-list_l2` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/l2 <sys_ut_event>`

    **l3**

        **Description:** l3 is a **JSON Block**.  Please see below for :ref:`3147_action-list_l3` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3 <sys_ut_event>`

    **tcp**

        **Description:** tcp is a **JSON Block**.  Please see below for :ref:`3147_action-list_tcp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp <sys_ut_event>`

    **template**

        **Description** Packet template

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/sys-ut/template <sys_ut_template>`

    **udp**

        **Description:** udp is a **JSON Block**.  Please see below for :ref:`3147_action-list_udp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/udp <sys_ut_event>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3147_action-list_ignore-validation:

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

.. _3147_action-list_udp:

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

.. _3147_action-list_tcp:

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 :ref:`3147_action-list_tcp_flags` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp/flags <sys_ut_event>`

    **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 :ref:`3147_action-list_tcp_options` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/tcp/options <sys_ut_event>`

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

.. _3147_action-list_tcp_flags:

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

.. _3147_action-list_tcp_options:

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

.. _3147_action-list_l2:

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:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/l2/mac/{src-dst} <sys_ut_event>`

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

.. _3147_action-list_l2_mac-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:** :doc:`/axapi/v3/interface/ethernet <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:** :doc:`/axapi/v3/interface/ve <interface_ve>`

    **virtual-server**

        **Description** vip

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/virtual-server <slb_virtual_server>`

.. _3147_action-list_l3:

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:** :doc:`/axapi/v3/sys-ut/event/{event-number}/action/{direction}/l3/ip/{src-dst} <sys_ut_event>`

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

.. _3147_action-list_l3_ip-list:

action-list_l3_ip-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

        **Reference Object:** :doc:`/axapi/v3/interface/ethernet <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:** :doc:`/axapi/v3/interface/ve <interface_ve>`

    **virtual-server**

        **Description** vip

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/virtual-server <slb_virtual_server>`

.. _3147_action-list_l1:

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

.. _3147_action-list_l1_eth-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:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

.. _3147_action-list_l1_trunk_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