.. _ip_app_protocol_port:

ip app-protocol-port
====================

Application protocol port filtering


app-protocol-port Specification
-------------------------------

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

	===================================== =============================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      app-protocol-port

	 **Element URI**                       /axapi/v3/ip/app-protocol-port

	 **Element Attributes**                app-protocol-port_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`app-protocol-port schema <ip-app-protocol-port/ip-app-protocol-port.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ip/app-protocol-port



.. raw:: html

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


app-protocol-port_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2071_app-protocol-port_attributes:

app-protocol-port attributes
----------------------------

    **monitor**

        **Description:** monitor is a **JSON Block**.  Please see below for :ref:`2071_monitor` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/monitor <ip_app_protocol_port_monitor>`

    **tcp**

        **Description:** tcp is a **JSON Block**.  Please see below for :ref:`2071_tcp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp <ip_app_protocol_port_tcp>`

    **udp**

        **Description:** udp is a **JSON Block**.  Please see below for :ref:`2071_udp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp <ip_app_protocol_port_udp>`

.. _2071_udp:

udp
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **passthrough**

        **Description:** passthrough is a **JSON Block**.  Please see below for :ref:`2071_udp_passthrough` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/passthrough <ip_app_protocol_port_udp_passthrough>`

    **port**

        **Description:** port is a **JSON Block**.  Please see below for :ref:`2071_udp_port` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port <ip_app_protocol_port_udp_port>`

.. _2071_udp_passthrough:

udp_passthrough
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **disable**

        **Description** Disable global port processing

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **enable**

        **Description** Enables global port processing

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

.. _2071_udp_port:

udp_port
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **add-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port} <ip_app_protocol_port_udp_port_add>`

    **disable-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/disable/{port} <ip_app_protocol_port_udp_port_disable>`

.. _2071_udp_port_add-list:

udp_port_add-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **app-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name} <ip_app_protocol_port_udp_port_add>`

    **port**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

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

.. _2071_udp_port_add-list_app-name-list:

udp_port_add-list_app-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2071_udp_port_add-list_app-name-list_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name}/interface <ip_app_protocol_port_udp_port_add>`

    **name**

        **Description** Application Protocol Port Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 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

.. _2071_udp_port_add-list_app-name-list_interface:

udp_port_add-list_app-name-list_interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **management**

        **Description** Management Interface

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

    **ve-cfg**

        **Type:** List

.. _2071_udp_port_add-list_app-name-list_interface_ve-cfg:

udp_port_add-list_app-name-list_interface_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve-end**

        **Description** VE port

        **Type:** number

    **ve-start**

        **Description** VE port (VE Interface number)

        **Type:** number

.. _2071_udp_port_add-list_app-name-list_interface_eth-cfg:

udp_port_add-list_app-name-list_interface_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **ethernet-start**

        **Description** Ethernet port (Ethernet Interface number)

        **Type:** number

        **Format:** interface

.. _2071_udp_port_disable-list:

udp_port_disable-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2071_udp_port_disable-list_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/disable/{port}/interface <ip_app_protocol_port_udp_port_disable>`

    **port**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

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

.. _2071_udp_port_disable-list_interface:

udp_port_disable-list_interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **management**

        **Description** Management Interface

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

    **ve-cfg**

        **Type:** List

.. _2071_udp_port_disable-list_interface_ve-cfg:

udp_port_disable-list_interface_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve-end**

        **Description** VE port

        **Type:** number

    **ve-start**

        **Description** VE port (VE Interface number)

        **Type:** number

.. _2071_udp_port_disable-list_interface_eth-cfg:

udp_port_disable-list_interface_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **ethernet-start**

        **Description** Ethernet port (Ethernet Interface number)

        **Type:** number

        **Format:** interface

.. _2071_monitor:

monitor
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **disable**

        **Description** Enables global port processing

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **enable**

        **Description** Enables global port processing

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

.. _2071_tcp:

tcp
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **passthrough**

        **Description:** passthrough is a **JSON Block**.  Please see below for :ref:`2071_tcp_passthrough` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/passthrough <ip_app_protocol_port_tcp_passthrough>`

    **port**

        **Description:** port is a **JSON Block**.  Please see below for :ref:`2071_tcp_port` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port <ip_app_protocol_port_tcp_port>`

.. _2071_tcp_passthrough:

tcp_passthrough
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **disable**

        **Description** Disable passthrough mode

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **enable**

        **Description** Enables passthrough mode

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

.. _2071_tcp_port:

tcp_port
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **add-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port} <ip_app_protocol_port_tcp_port_add>`

    **disable-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port} <ip_app_protocol_port_tcp_port_disable>`

.. _2071_tcp_port_add-list:

tcp_port_add-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **app-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name} <ip_app_protocol_port_tcp_port_add>`

    **port**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

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

.. _2071_tcp_port_add-list_app-name-list:

tcp_port_add-list_app-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2071_tcp_port_add-list_app-name-list_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name}/interface <ip_app_protocol_port_tcp_port_add>`

    **name**

        **Description** Application Protocol Port Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 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

.. _2071_tcp_port_add-list_app-name-list_interface:

tcp_port_add-list_app-name-list_interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **management**

        **Description** Management Interface

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

    **ve-cfg**

        **Type:** List

.. _2071_tcp_port_add-list_app-name-list_interface_ve-cfg:

tcp_port_add-list_app-name-list_interface_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve-end**

        **Description** VE port

        **Type:** number

    **ve-start**

        **Description** VE port (VE Interface number)

        **Type:** number

.. _2071_tcp_port_add-list_app-name-list_interface_eth-cfg:

tcp_port_add-list_app-name-list_interface_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **ethernet-start**

        **Description** Ethernet port (Ethernet Interface number)

        **Type:** number

        **Format:** interface

.. _2071_tcp_port_disable-list:

tcp_port_disable-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2071_tcp_port_disable-list_interface` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port}/interface <ip_app_protocol_port_tcp_port_disable>`

    **port**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

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

.. _2071_tcp_port_disable-list_interface:

tcp_port_disable-list_interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-cfg**

        **Type:** List

    **management**

        **Description** Management Interface

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

    **ve-cfg**

        **Type:** List

.. _2071_tcp_port_disable-list_interface_ve-cfg:

tcp_port_disable-list_interface_ve-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ve-end**

        **Description** VE port

        **Type:** number

    **ve-start**

        **Description** VE port (VE Interface number)

        **Type:** number

.. _2071_tcp_port_disable-list_interface_eth-cfg:

tcp_port_disable-list_interface_eth-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **ethernet-start**

        **Description** Ethernet port (Ethernet Interface number)

        **Type:** number

        **Format:** interface