.. _slb_template_policy_forward_policy_source:

slb template policy forward-policy source
=========================================

proxy source list


source Specification
--------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`2208_source_list`

	 **Collection URI**                    /axapi/v3/slb/template/policy/{name}/forward-policy/source

	                                       

	 **Element Name**                      source

	 **Element URI**                       /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}

	 **Element Attributes**                source_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`source schema <slb-template-policy-forward-policy-source/slb-template-policy-forward-policy-source.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/slb/template/policy/{name}/forward-policy/source



.. raw:: html

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


:ref:`2208_source_attributes`



.. raw:: html

   </td><td></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/slb/template/policy/{name}/forward-policy/source



.. raw:: html

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


:ref:`2208_source_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/slb/template/policy/{name}/forward-policy/source/{name}



.. raw:: html

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


:ref:`2208_source_attributes`



.. raw:: html

   </td><td></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/slb/template/policy/{name}/forward-policy/source



.. raw:: html

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


:ref:`2208_source_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/slb/template/policy/{name}/forward-policy/source/{name}



.. raw:: html

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


:ref:`2208_source_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/slb/template/policy/{name}/forward-policy/source/{name}



.. raw:: html

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


:ref:`2208_source_attributes`



.. raw:: html

   </td><td></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/slb/template/policy/{name}/forward-policy/source



.. raw:: html

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


:ref:`2208_source_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/slb/template/policy/{name}/forward-policy/source/{name}



.. raw:: html

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


:ref:`2208_source_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2208_source_list:

source-list
-----------


    source-list is **JSON List** of :ref:`2208_source_attributes` 

        source-list : [

             { :ref:`2208_source_attributes` },

             { :ref:`2208_source_attributes` },

             ...

         ]

.. _2208_source_attributes:

source attributes
-----------------

    **destination**

        **Description:** destination is a **JSON Block**.  Please see below for :ref:`2208_destination` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination <slb_template_policy>`

    **match-any**

        **Description** Match any source

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** match-any and match-class-list are mutually exclusive

    **match-authorize-policy**

        **Description** Authorize-policy for user and group based policy

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/aam/authorization/policy <aam_authorization_policy>`

    **match-class-list**

        **Description** Class List Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** match-class-list and match-any are mutually exclusive

    **name**

        **Description** source destination match rule name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **priority**

        **Description** Priority of the source(higher the number higher the priority, default 0)

        **Type:** number

        **Range:** 1-2000

    **sampling-enable**

        **Type:** List

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

.. _2208_destination:

destination
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **any**

        **Description:** any is a **JSON Block**.  Please see below for :ref:`2208_destination_any` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/any <slb_template_policy>`

    **class-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/class-list/{dest-class-list} <slb_template_policy>`

    **web-category-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-category-list/{web-category-list} <slb_template_policy>`

    **web-reputation-scope-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-reputation-scope/{web-reputation-scope} <slb_template_policy>`

.. _2208_destination_class-list-list:

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

	 **Block object keys**             

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

    **action**

        **Description** Action to be performed

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dest-class-list**

        **Description** Destination Class List Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **priority**

        **Description** Priority value of the action(higher the number higher the priority)

        **Type:** number

        **Range:** 1-1024

    **sampling-enable**

        **Type:** List

    **type**

        **Description** 'host': Match hostname; 'url': Match URL; 'ip': Match destination IP address; 

        **Type:** string

        **Supported Values:** host, url, ip

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2208_destination_class-list-list_sampling-enable:

destination_class-list-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this destination rule; 

        **Type:** string

        **Supported Values:** all, hits

.. _2208_destination_web-category-list-list:

destination_web-category-list-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** Action to be performed

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **priority**

        **Description** Priority value of the action(higher the number higher the priority)

        **Type:** number

        **Range:** 1-1024

    **sampling-enable**

        **Type:** List

    **type**

        **Description** 'host': Match hostname; 'url': match URL; 

        **Type:** string

        **Supported Values:** host, url

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **web-category-list**

        **Description** Destination Web Category List Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/web-category/category-list <web_category_category_list>`

.. _2208_destination_web-category-list-list_sampling-enable:

destination_web-category-list-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this destination rule; 

        **Type:** string

        **Supported Values:** all, hits

.. _2208_destination_any:

destination_any
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** Action to be performed

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2208_destination_any_sampling-enable:

destination_any_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this destination rule; 

        **Type:** string

        **Supported Values:** all, hits

.. _2208_destination_web-reputation-scope-list:

destination_web-reputation-scope-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** Action to be performed

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **priority**

        **Description** Priority value of the action(higher the number higher the priority)

        **Type:** number

        **Range:** 1-1024

    **sampling-enable**

        **Type:** List

    **type**

        **Description** 'host': Match hostname; 'url': match URL; 

        **Type:** string

        **Supported Values:** host, url

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **web-reputation-scope**

        **Description** Destination Web Reputation Scope Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/web-category/reputation-scope <web_category_reputation_scope>`

.. _2208_destination_web-reputation-scope-list_sampling-enable:

destination_web-reputation-scope-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this destination rule; 

        **Type:** string

        **Supported Values:** all, hits

.. _2208_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of requests matching this source rule; 'destination-match-not-found': Number of requests without matching destination rule; 'no-host-info': Failed to parse ip or host information from request; 

        **Type:** string

        **Supported Values:** all, hits, destination-match-not-found, no-host-info