.. _cgnv6_lsn_rule_list_domain_list_name: cgnv6 lsn-rule-list domain-list-name ==================================== Configure a Specific Rule-Set (Domain List Name) domain-list-name Specification ------------------------------ ===================================== ======================================================================================================= **Parameter** **Value** ===================================== ======================================================================================================= **Type** *Collection* **Object Key(s)** *name-domain-list* **Collection Name** :ref:`397_domain-list-name_list` **Collection URI** /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name **Element Name** domain-list-name **Element URI** /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} **Element Attributes** domain-list-name_attributes **Partition Visibility** shared **Statistics Data URI** /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list}/stats **Operational Data URI** /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list}/oper **Schema** :download:`domain-list-name schema ` ===================================== ======================================================================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name .. raw:: html :ref:`397_domain-list-name_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name .. raw:: html :ref:`397_domain-list-name_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} .. raw:: html :ref:`397_domain-list-name_attributes` .. raw:: html
.. _397_domain-list-name_list: domain-list-name-list --------------------- domain-list-name-list is **JSON List** of :ref:`397_domain-list-name_attributes` domain-list-name-list : [ { :ref:`397_domain-list-name_attributes` }, { :ref:`397_domain-list-name_attributes` }, ... ] .. _397_domain-list-name_attributes: domain-list-name attributes --------------------------- **name-domain-list** **Description** Configure a Specific Rule-Set (Domain List Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **rule-cfg** **Type:** List **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 .. _397_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'placeholder': some help string; **Type:** string **Supported Values:** all, placeholder .. _397_rule-cfg: rule-cfg ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dscp-cfg** **Description:** dscp-cfg is a **JSON Block**. Please see below for :ref:`397_rule-cfg_dscp-cfg` **Type:** Object **icmp-others-cfg** **Description:** icmp-others-cfg is a **JSON Block**. Please see below for :ref:`397_rule-cfg_icmp-others-cfg` **Type:** Object **proto** **Description** 'tcp': TCP L4 Protocol; 'udp': UDP L4 Protocol; 'icmp': ICMP L4 Protocol; 'others': Other L4 Protocol; 'dscp': Match DSCP Value; 'default': Default Action; **Type:** string **Supported Values:** tcp, udp, icmp, others, dscp, default **tcp-cfg** **Description:** tcp-cfg is a **JSON Block**. Please see below for :ref:`397_rule-cfg_tcp-cfg` **Type:** Object **udp-cfg** **Description:** udp-cfg is a **JSON Block**. Please see below for :ref:`397_rule-cfg_udp-cfg` **Type:** Object .. _397_rule-cfg_dscp-cfg: rule-cfg_dscp-cfg ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; **Type:** string **Supported Values:** action **action-type** **Description** 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-match** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); 'any': Match any dscp value; '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 .. _397_rule-cfg_tcp-cfg: rule-cfg_tcp-cfg ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'template': Template; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **http-alg** **Description** HTTP-ALG Template (Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _397_rule-cfg_udp-cfg: rule-cfg_udp-cfg ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _397_rule-cfg_icmp-others-cfg: rule-cfg_icmp-others-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31