.. _system_radius:

system radius
=============

Configure the Interaction with External RADIUS Servers


radius Specification
--------------------

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

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

	 **Element Name**                      radius

	 **Element URI**                       /axapi/v3/system/radius

	 **Element Attributes**                radius_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`radius schema <system-radius/system-radius.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/system/radius



.. raw:: html

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


radius_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1532_radius_attributes:

radius attributes
-----------------

    **server**

        **Description:** server is a **JSON Block**.  Please see below for :ref:`1532_server` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/radius/server <system_radius_server>`

.. _1532_server:

server
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **accounting-interim-update**

        **Description** 'ignore': Ignore (default); 'append-entry': Append the AVPs to existing entry; 'replace-entry': Replace the AVPs of existing entry; 

        **Type:** string

        **Supported Values:** ignore, append-entry, replace-entry

        **Default:** ignore

    **accounting-on**

        **Description** 'ignore': Ignore (default); 'delete-entries-using-attribute': Delete entries matching attribute in RADIUS Table; 

        **Type:** string

        **Supported Values:** ignore, delete-entries-using-attribute

        **Default:** ignore

    **accounting-start**

        **Description** 'ignore': Ignore; 'append-entry': Append the AVPs to existing entry (default); 'replace-entry': Replace the AVPs of existing entry; 

        **Type:** string

        **Supported Values:** ignore, append-entry, replace-entry

        **Default:** append-entry

    **accounting-stop**

        **Description** 'ignore': Ignore; 'delete-entry': Delete the entry (default); 'delete-entry-and-sessions': Delete the entry and data sessions associated(CGN only); 

        **Type:** string

        **Supported Values:** ignore, delete-entry, delete-entry-and-sessions

        **Default:** delete-entry

    **attribute**

        **Type:** List

    **attribute-name**

        **Description** 'msisdn': Clear using MSISDN; 'imei': Clear using IMEI; 'imsi': Clear using IMSI; 'custom1': Clear using CUSTOM1 attribute configured; 'custom2': Clear using CUSTOM2 attribute configured; 'custom3': Clear using CUSTOM3 attribute configured; 

        **Type:** string

        **Supported Values:** msisdn, imei, imsi, custom1, custom2, custom3

        **Mutual Exclusion:** attribute-name and custom-attribute-name are mutually exclusive

    **disable-reply**

        **Description** Toggle option for RADIUS reply packet(Default: Accounting response will be sent)

        **Type:** boolean

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

        **Default:** 0

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **listen-port**

        **Description** Configure the listen port of RADIUS server (default 1813) (Port number)

        **Type:** number

        **Range:** 1024-65535

        **Default:** 1813

    **remote**

        **Description:** remote is a **JSON Block**.  Please see below for :ref:`1532_server_remote` 

        **Type:** Object

    **secret**

        **Description** Configure shared secret

        **Type:** boolean

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

        **Default:** 0

    **secret-string**

        **Description** The RADIUS secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

        **Description** Join a VRRP-A failover group

        **Type:** number

        **Range:** 1-31

.. _1532_server_remote:

server_remote
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-list**

        **Type:** List

.. _1532_server_remote_ip-list:

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

	 **Block object keys**             

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

    **ip-list-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **ip-list-name**

        **Description** IP-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ip-list-secret**

        **Description** Configure shared secret

        **Type:** boolean

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

        **Default:** 0

    **ip-list-secret-string**

        **Description** The RADIUS secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _1532_server_attribute:

server_attribute
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **attribute-value**

        **Description** 'inside-ipv6-prefix': Framed IPv6 Prefix; 'inside-ip': Inside IP address; 'inside-ipv6': Inside IPv6 address; 'imei': International Mobile Equipment Identity (IMEI); 'imsi': International Mobile Subscriber Identity (IMSI); 'msisdn': Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); 'custom1': Customized attribute 1; 'custom2': Customized attribute 2; 'custom3': Customized attribute 3; 

        **Type:** string

        **Supported Values:** inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3

    **custom-number**

        **Description** RADIUS attribute number

        **Type:** number

        **Range:** 1-255

    **custom-vendor**

        **Description** RADIUS vendor attribute information (RADIUS vendor ID)

        **Type:** number

        **Range:** 1-65535

    **name**

        **Description** Customized attribute name

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **number**

        **Description** RADIUS attribute number

        **Type:** number

        **Range:** 1-255

    **prefix-length**

        **Description** '32': Prefix length 32; '48': Prefix length 48; '64': Prefix length 64; '80': Prefix length 80; '96': Prefix length 96; '112': Prefix length 112; 

        **Type:** string

        **Supported Values:** 32, 48, 64, 80, 96, 112

    **prefix-number**

        **Description** RADIUS attribute number

        **Type:** number

        **Range:** 1-255

    **prefix-vendor**

        **Description** RADIUS vendor attribute information (RADIUS vendor ID)

        **Type:** number

        **Range:** 1-65535

    **value**

        **Description** 'hexadecimal': Type of attribute value is hexadecimal; 

        **Type:** string

        **Supported Values:** hexadecimal

    **vendor**

        **Description** RADIUS vendor attribute information (RADIUS vendor ID)

        **Type:** number

        **Range:** 1-65535