.. _rule_set_rule_action_group:

rule-set rule action-group
==========================

Configure action-group


action-group Specification
--------------------------

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

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

	 **Element Name**                      action-group

	 **Element URI**                       /axapi/v3/rule-set/{name}/rule/{name}/action-group

	 **Element Attributes**                action-group_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`action-group schema <rule-set-rule-action-group/rule-set-rule-action-group.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/rule-set/{name}/rule/{name}/action-group



.. raw:: html

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


:ref:`1784_action-group_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/rule-set/{name}/rule/{name}/action-group



.. raw:: html

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


:ref:`1784_action-group_attributes`



.. 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/rule-set/{name}/rule/{name}/action-group



.. raw:: html

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


:ref:`1784_action-group_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/rule-set/{name}/rule/{name}/action-group



.. raw:: html

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


:ref:`1784_action-group_attributes`



.. 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/rule-set/{name}/rule/{name}/action-group



.. raw:: html

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


:ref:`1784_action-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1784_action-group_attributes:

action-group attributes
-----------------------

    **cgnv6**

        **Description** Apply CGNv6 policy

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** cgnv6,listen-on-port,  forward, and ipsec are mutually exclusive

    **cgnv6-ds-lite**

        **Description** 'lsn-lid': Apply specified CGNv6 LSN LID; 

        **Type:** string

        **Supported Values:** lsn-lid

    **cgnv6-ds-lite-lsn-lid**

        **Description** LSN LID

        **Type:** number

        **Range:** 1-1023

    **cgnv6-lsn-lid**

        **Description** LSN LID

        **Type:** number

        **Range:** 1-1023

    **cgnv6-policy**

        **Description** 'lsn-lid': Apply specified CGNv6 LSN LID; 'fixed-nat': Apply CGNv6 Fixed NAT; 'ds-lite': Apply CGNv6 DS-Lite; 

        **Type:** string

        **Supported Values:** lsn-lid, fixed-nat, ds-lite

    **deny-fw-log**

        **Description** Logging template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/fw/template/logging <fw_template_logging>`

    **deny-log**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

    **deny-log-template-type**

        **Description** 'fw-logging-template': Logging with specified fw template; 

        **Type:** string

        **Supported Values:** fw-logging-template

    **forward**

        **Description** Forward packet

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** forward, ipsec, and cgnv6 are mutually exclusive

    **inspect-payload**

        **Description** Enable DS-Lite tunnel inspection

        **Type:** boolean

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

        **Default:** 0

    **ipsec**

        **Description** Apply IPsec encapsulation

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** ipsec,permit-log, listen-on-port, forward, cgnv6,  permit-limit-policy, and permit-respond-to-user-mac are mutually exclusive

    **listen-on-port**

        **Description** Listen on port

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** listen-on-port, ipsec, and cgnv6 are mutually exclusive

    **logging-template-list**

        **Type:** List

    **permit-limit-policy**

        **Description** Limit policy Template

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** permit-limit-policy and ipsec are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/template/limit-policy <template_limit_policy>`

    **permit-log**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** permit-log and ipsec are mutually exclusive

    **permit-respond-to-user-mac**

        **Description** Use the user's source MAC for the next hop rather than the routing table (default:off)

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** permit-respond-to-user-mac and ipsec are mutually exclusive

    **reset-fw-log**

        **Description** Logging template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/fw/template/logging <fw_template_logging>`

    **reset-log**

        **Description** Enable logging

        **Type:** boolean

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

        **Default:** 0

    **reset-log-template-type**

        **Description** 'fw-logging-template': Logging with specified fw template; 

        **Type:** string

        **Supported Values:** fw-logging-template

    **reset-respond-to-user-mac**

        **Description** Use the user's source MAC for the next hop rather than the routing table (default:off)

        **Type:** boolean

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

        **Default:** 0

    **type**

        **Description** 'permit': permit; 'deny': deny; 'reset': reset; 

        **Type:** string

        **Supported Values:** permit, deny, reset

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vpn-ipsec-name**

        **Description** VPN IPsec name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/vpn/ipsec <vpn_ipsec>`

.. _1784_logging-template-list:

logging-template-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **permit-cgnv6-log**

        **Description** Logging template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/cgnv6/template/logging <cgnv6_template_logging>`

    **permit-fw-log**

        **Description** Logging template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/fw/template/logging <fw_template_logging>`

    **permit-log-template-type**

        **Description** 'fw-logging-template': Logging with specified fw template; 'cgnv6-logging-template': Logging with specified cgnv6 template; 'netflow-monitor': Logging with specified netflow/ipfix monitor; 

        **Type:** string

        **Supported Values:** fw-logging-template, cgnv6-logging-template, netflow-monitor

    **permit-netflow-log**

        **Description** Name of netflow monitor

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/netflow/monitor <netflow_monitor>`