.. _route_map_set:

route-map set
=============

Set values in destination routing protocol


set Specification
-----------------

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

	===================================== ================================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      set

	 **Element URI**                       /axapi/v3/route-map/{tag}+{action}+{sequence}/set

	 **Element Attributes**                set_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`set schema <route-map-set/route-map-set.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/route-map/{tag}+{action}+{sequence}/set



.. raw:: html

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


:ref:`2476_set_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/route_map_set_POST.txt
   :literal:




.. raw:: html

   </div></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/route-map/{tag}+{action}+{sequence}/set



.. raw:: html

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


:ref:`2476_set_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/route_map_set_GET.txt
   :literal:




.. raw:: html

   </div></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/route-map/{tag}+{action}+{sequence}/set



.. raw:: html

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


:ref:`2476_set_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/route-map/{tag}+{action}+{sequence}/set



.. raw:: html

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


:ref:`2476_set_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/route_map_set_PUT.txt
   :literal:




.. raw:: html

   </div></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/route-map/{tag}+{action}+{sequence}/set



.. raw:: html

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


:ref:`2476_set_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/route_map_set_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2476_set_attributes:

set attributes
--------------

    **aggregator**

        **Description:** aggregator is a **JSON Block**.  Please see below for :ref:`2476_aggregator` 

        **Type:** Object

    **as-path**

        **Description:** as-path is a **JSON Block**.  Please see below for :ref:`2476_as-path` 

        **Type:** Object

    **atomic-aggregate**

        **Description** BGP atomic aggregate attribute

        **Type:** boolean

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

        **Default:** 0

    **comm-list**

        **Description:** comm-list is a **JSON Block**.  Please see below for :ref:`2476_comm-list` 

        **Type:** Object

    **community**

        **Description** BGP community attribute

        **Type:** string

        **Format:** string-rlx

    **dampening-cfg**

        **Description:** dampening-cfg is a **JSON Block**.  Please see below for :ref:`2476_dampening-cfg` 

        **Type:** Object

    **ddos**

        **Description:** ddos is a **JSON Block**.  Please see below for :ref:`2476_ddos` 

        **Type:** Object

    **extcommunity**

        **Description:** extcommunity is a **JSON Block**.  Please see below for :ref:`2476_extcommunity` 

        **Type:** Object

    **ip**

        **Description:** ip is a **JSON Block**.  Please see below for :ref:`2476_ip` 

        **Type:** Object

    **ipv6**

        **Description:** ipv6 is a **JSON Block**.  Please see below for :ref:`2476_ipv6` 

        **Type:** Object

    **large-comm-list**

        **Description:** large-comm-list is a **JSON Block**.  Please see below for :ref:`2476_large-comm-list` 

        **Type:** Object

    **large-community**

        **Description** BGP large community attribute

        **Type:** string

        **Format:** string-rlx

    **level**

        **Description:** level is a **JSON Block**.  Please see below for :ref:`2476_level` 

        **Type:** Object

    **local-preference**

        **Description:** local-preference is a **JSON Block**.  Please see below for :ref:`2476_local-preference` 

        **Type:** Object

    **metric**

        **Description:** metric is a **JSON Block**.  Please see below for :ref:`2476_metric` 

        **Type:** Object

    **metric-type**

        **Description:** metric-type is a **JSON Block**.  Please see below for :ref:`2476_metric-type` 

        **Type:** Object

    **origin**

        **Description:** origin is a **JSON Block**.  Please see below for :ref:`2476_origin` 

        **Type:** Object

    **originator-id**

        **Description:** originator-id is a **JSON Block**.  Please see below for :ref:`2476_originator-id` 

        **Type:** Object

    **tag**

        **Description:** tag is a **JSON Block**.  Please see below for :ref:`2476_tag` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **weight**

        **Description:** weight is a **JSON Block**.  Please see below for :ref:`2476_weight` 

        **Type:** Object

.. _2476_extcommunity:

extcommunity
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rt**

        **Description:** rt is a **JSON Block**.  Please see below for :ref:`2476_extcommunity_rt` 

        **Type:** Object

    **soo**

        **Description:** soo is a **JSON Block**.  Please see below for :ref:`2476_extcommunity_soo` 

        **Type:** Object

.. _2476_extcommunity_rt:

extcommunity_rt
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** VPN extended community

        **Type:** string

        **Format:** string-rlx

.. _2476_extcommunity_soo:

extcommunity_soo
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** VPN extended community

        **Type:** string

        **Format:** string-rlx

.. _2476_origin:

origin
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **egp**

        **Description** remote EGP

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** egp, igp, and incomplete are mutually exclusive

    **igp**

        **Description** local IGP

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** igp, egp, and incomplete are mutually exclusive

    **incomplete**

        **Description** unknown heritage

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** incomplete, egp, and igp are mutually exclusive

.. _2476_aggregator:

aggregator
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **aggregator-as**

        **Description:** aggregator-as is a **JSON Block**.  Please see below for :ref:`2476_aggregator_aggregator-as` 

        **Type:** Object

.. _2476_aggregator_aggregator-as:

aggregator_aggregator-as
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **asn**

        **Description** AS number

        **Type:** number

        **Range:** 1-4294967295

    **ip**

        **Description** IP address of aggregator

        **Type:** string

        **Format:** ipv4-address

.. _2476_weight:

weight
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **weight-val**

        **Description** Weight value

        **Type:** number

        **Range:** 0-4294967295

.. _2476_level:

level
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** 'level-1': Export into a level-1 area; 'level-1-2': Export into level-1 and level-2; 'level-2': Export into level-2 sub-domain; 

        **Type:** string

        **Supported Values:** level-1, level-1-2, level-2

.. _2476_ip:

ip
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **next-hop**

        **Description:** next-hop is a **JSON Block**.  Please see below for :ref:`2476_ip_next-hop` 

        **Type:** Object

.. _2476_ip_next-hop:

ip_next-hop
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address**

        **Description** IP address of next hop

        **Type:** string

        **Format:** ipv4-address

.. _2476_metric:

metric
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** Metric Value (from -4294967295 to 4294967295)

        **Type:** string

        **Maximum Length:** 11 characters

        **Maximum Length:** 1 characters

.. _2476_as-path:

as-path
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **num**

        **Description** AS number

        **Type:** string

        **Maximum Length:** 11 characters

        **Maximum Length:** 1 characters

    **num2**

        **Description** AS number

        **Type:** string

        **Maximum Length:** 11 characters

        **Maximum Length:** 1 characters

    **prepend**

        **Description** Prepend to the as-path (AS number)

        **Type:** string

        **Format:** string-rlx

.. _2476_comm-list:

comm-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete matching communities

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Community-list name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** name, v-std, and v-exp are mutually exclusive

    **name-delete**

        **Description** Delete matching communities

        **Type:** boolean

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

        **Default:** 0

    **v-exp**

        **Description** Community-list number (expanded)

        **Type:** number

        **Range:** 100-199

        **Mutual Exclusion:** v-exp,v-std,  name, and l-name are mutually exclusive

    **v-exp-delete**

        **Description** Delete matching communities

        **Type:** boolean

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

        **Default:** 0

    **v-std**

        **Description** Community-list number (standard)

        **Type:** number

        **Range:** 1-99

        **Mutual Exclusion:** v-std,v-exp, name,  l-v-exp, and l-name are mutually exclusive

.. _2476_local-preference:

local-preference
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **val**

        **Description** Preference value

        **Type:** number

        **Range:** 0-4294967295

.. _2476_ddos:

ddos
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **class-list-cid**

        **Description** Class-List Cid

        **Type:** number

        **Range:** 1-32

    **class-list-name**

        **Description** Class-List Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **zone**

        **Description** Zone Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _2476_tag:

tag
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** Tag value

        **Type:** number

        **Range:** 0-4294967295

.. _2476_ipv6:

ipv6
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **next-hop-1**

        **Description:** next-hop-1 is a **JSON Block**.  Please see below for :ref:`2476_ipv6_next-hop-1` 

        **Type:** Object

.. _2476_ipv6_next-hop-1:

ipv6_next-hop-1
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address**

        **Description** global address of next hop

        **Type:** string

        **Format:** ipv6-address

    **local**

        **Description:** local is a **JSON Block**.  Please see below for :ref:`2476_ipv6_next-hop-1_local` 

        **Type:** Object

.. _2476_ipv6_next-hop-1_local:

ipv6_next-hop-1_local
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address**

        **Description** IPv6 address of next hop

        **Type:** string

        **Format:** ipv6-address

.. _2476_large-comm-list:

large-comm-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **l-name**

        **Description** Large Community-list name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** l-name, v-std, and v-exp are mutually exclusive

    **l-v-exp**

        **Description** Large Community-list number (expanded)

        **Type:** number

        **Range:** 100-199

        **Mutual Exclusion:** l-v-exp and v-std are mutually exclusive

    **l-v-exp-delete**

        **Description** Delete matching large communities

        **Type:** boolean

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

        **Default:** 0

    **l-v-std**

        **Description** Large Community-list number (standard)

        **Type:** number

        **Range:** 1-99

    **l-v-std-delete**

        **Description** Delete matching large communities

        **Type:** boolean

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

        **Default:** 0

    **large-name-delete**

        **Description** Delete matching large communities

        **Type:** boolean

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

        **Default:** 0

.. _2476_dampening-cfg:

dampening-cfg
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dampening**

        **Description** Enable route-flap dampening

        **Type:** boolean

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

        **Default:** 0

    **dampening-half-time**

        **Description** Reachability Half-life time for the penalty(minutes)

        **Type:** number

        **Range:** 1-45

    **dampening-max-supress**

        **Description** Maximum duration to suppress a stable route(minutes)

        **Type:** number

        **Range:** 1-255

    **dampening-penalty**

        **Description** Un-reachability Half-life time for the penalty(minutes)

        **Type:** number

        **Range:** 1-45

    **dampening-reuse**

        **Description** Value to start reusing a route

        **Type:** number

        **Range:** 1-20000

    **dampening-supress**

        **Description** Value to start suppressing a route

        **Type:** number

        **Range:** 1-20000

.. _2476_originator-id:

originator-id
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **originator-ip**

        **Description** IP address of originator

        **Type:** string

        **Format:** ipv4-address

.. _2476_metric-type:

metric-type
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **value**

        **Description** 'external': IS-IS external metric type; 'internal': IS-IS internal metric type; 'type-1': OSPF external type 1 metric; 'type-2': OSPF external type 2 metric; 

        **Type:** string

        **Supported Values:** external, internal, type-1, type-2