.. _system_radius_server:

system radius server
====================

Configure system as a RADIUS server


server Specification
--------------------

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

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

	 **Element Name**                      server

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

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/system/radius/server/stats

	 **Operational Data URI**              /axapi/v3/system/radius/server/oper

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



.. raw:: html

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


:ref:`3364_server_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/system_radius_server_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/system/radius/server



.. raw:: html

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


:ref:`3364_server_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/system_radius_server_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/system/radius/server



.. raw:: html

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


:ref:`3364_server_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/system/radius/server



.. raw:: html

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


:ref:`3364_server_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/system_radius_server_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/system/radius/server



.. raw:: html

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


:ref:`3364_server_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/system_radius_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3364_server_attributes:

server attributes
-----------------

    **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; 'custom4': Clear using CUSTOM4 attribute configured; 'custom5': Clear using CUSTOM5 attribute configured; 'custom6': Clear using CUSTOM6 attribute configured; 

        **Type:** string

        **Supported Values:** msisdn, imei, imsi, custom1, custom2, custom3, custom4, custom5, custom6

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

    **custom-attribute-name**

        **Description** Clear using customized attribute

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** custom-attribute-name and 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:`3364_remote` 

        **Type:** Object

    **sampling-enable**

        **Type:** List

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

.. _3364_remote:

remote
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-list**

        **Type:** List

.. _3364_remote_ip-list:

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

.. _3364_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'msisdn-received': MSISDN Received; 'imei-received': IMEI Received; 'imsi-received': IMSI Received; 'custom-received': Custom attribute Received; 'radius-request-received': RADIUS Request Received; 'radius-request-dropped': RADIUS Request Dropped (Malformed Packet); 'request-bad-secret-dropped': RADIUS Request Bad Secret Dropped; 'request-no-key-vap-dropped': RADIUS Request No Key Attribute Dropped; 'request-malformed-dropped': RADIUS Request Malformed Dropped; 'request-ignored': RADIUS Request Ignored; 'radius-table-full': RADIUS Request Dropped (Table Full); 'secret-not-configured-dropped': RADIUS Secret Not Configured Dropped; 'ha-standby-dropped': HA Standby Dropped; 'ipv6-prefix-length-mismatch': Framed IPV6 Prefix Length Mismatch; 'invalid-key': Radius Request has Invalid Key Field; 'smp-created': RADIUS SMP Created; 'smp-deleted': RADIUS SMP Deleted; 'smp-mem-allocated': RADIUS SMP Memory Allocated; 'smp-mem-alloc-failed': RADIUS SMP Memory Allocation Failed; 'smp-mem-freed': RADIUS SMP Memory Freed; 'smp-in-rml': RADIUS SMP in RML; 'mem-allocated': RADIUS Memory Allocated; 'mem-alloc-failed': RADIUS Memory Allocation Failed; 'mem-freed': RADIUS Memory Freed; 'ha-sync-create-sent': HA Record Sync Create Sent; 'ha-sync-delete-sent': HA Record Sync Delete Sent; 'ha-sync-create-recv': HA Record Sync Create Received; 'ha-sync-delete-recv': HA Record Sync Delete Received; 'acct-on-filters-full': RADIUS Acct On Request Ignored(Filters Full); 'acct-on-dup-request': Duplicate RADIUS Acct On Request; 'ip-mismatch-delete': Radius Entry IP Mismatch Delete; 'ip-add-race-drop': Radius Entry IP Add Race Drop; 'ha-sync-no-key-vap-dropped': HA Record Sync No key dropped; 'inter-card-msg-fail-drop': Inter-Card Message Fail Drop; 'radius-packets-redirected': RADIUS packets redirected (SO); 'radius-packets-redirect-fail-dropped': RADIUS packets dropped due to redirect failure (SO); 'radius-packets-process-local': RADIUS packets processed locally without redirection (SO); 'radius-packets-dropped-not-lo': RADIUS packets dropped dest not loopback (SO); 'radius-inter-card-dup-redir': RADIUS packet dropped as redirected by other blade (SO); 

        **Type:** string

        **Supported Values:** all, msisdn-received, imei-received, imsi-received, custom-received, radius-request-received, radius-request-dropped, request-bad-secret-dropped, request-no-key-vap-dropped, request-malformed-dropped, request-ignored, radius-table-full, secret-not-configured-dropped, ha-standby-dropped, ipv6-prefix-length-mismatch, invalid-key, smp-created, smp-deleted, smp-mem-allocated, smp-mem-alloc-failed, smp-mem-freed, smp-in-rml, mem-allocated, mem-alloc-failed, mem-freed, ha-sync-create-sent, ha-sync-delete-sent, ha-sync-create-recv, ha-sync-delete-recv, acct-on-filters-full, acct-on-dup-request, ip-mismatch-delete, ip-add-race-drop, ha-sync-no-key-vap-dropped, inter-card-msg-fail-drop, radius-packets-redirected, radius-packets-redirect-fail-dropped, radius-packets-process-local, radius-packets-dropped-not-lo, radius-inter-card-dup-redir

.. _3364_attribute:

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; 'custom4': Customized attribute 4; 'custom5': Customized attribute 5; 'custom6': Customized attribute 6; 

        **Type:** string

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

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