.. _radius_server:

radius-server
=============

Configure RADIUS server information


radius-server Specification
---------------------------

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

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

	 **Element Name**                      radius-server

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

	 **Element Attributes**                radius-server_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2458_radius-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/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/radius-server



.. raw:: html

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


:ref:`2458_radius-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/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/radius-server



.. raw:: html

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


:ref:`2458_radius-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/radius-server



.. raw:: html

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


:ref:`2458_radius-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/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/radius-server



.. raw:: html

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


:ref:`2458_radius-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/radius_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2458_radius-server_attributes:

radius-server attributes
------------------------

    **default-privilege-read-write**

        **Description** Specify the RADIUS default privilege

        **Type:** boolean

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

        **Default:** 0

    **host**

        **Description:** host is a **JSON Block**.  Please see below for :ref:`2458_host` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/radius-server/host <radius_server_host>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2458_host:

host
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv4-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/radius-server/host/ipv4/{ipv4-addr} <radius_server_host_ipv4>`

    **ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/radius-server/host/ipv6/{ipv6-addr} <radius_server_host_ipv6>`

    **name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/radius-server/host/name/{hostname} <radius_server_host_name>`

.. _2458_host_ipv4-list:

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

	 **Block object keys**             

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

    **ipv4-addr**

        **Description** IPV4 address of RADIUS server

        **Type:** string

        **Format:** ipv4-address

    **secret**

        **Description:** secret is a **JSON Block**.  Please see below for :ref:`2458_host_ipv4-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2458_host_ipv4-list_secret:

host_ipv4-list_secret
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2458_host_ipv4-list_secret_port-cfg` 

        **Type:** Object

    **secret-value**

        **Description** The RADIUS server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _2458_host_ipv4-list_secret_port-cfg:

host_ipv4-list_secret_port-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acct-port**

        **Description** Specify the RADIUS server's accounting port (default 1813)

        **Type:** number

        **Range:** 1-65535

    **auth-port**

        **Description** Specify the RADIUS server's authentication port (default 1812)

        **Type:** number

        **Range:** 1-65535

    **retransmit**

        **Description** Specify the maximum times allowed for resending an request to the radius server (default 3)

        **Type:** number

        **Range:** 0-5

        **Default:** 3

    **timeout**

        **Description** Specify the maximum time allowed for waiting for a response from a radius server (default 3)

        **Type:** number

        **Range:** 1-15

        **Default:** 3

.. _2458_host_name-list:

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

	 **Block object keys**             

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

    **hostname**

        **Description** Hostname of RADIUS server

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **secret**

        **Description:** secret is a **JSON Block**.  Please see below for :ref:`2458_host_name-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2458_host_name-list_secret:

host_name-list_secret
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2458_host_name-list_secret_port-cfg` 

        **Type:** Object

    **secret-value**

        **Description** The RADIUS server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _2458_host_name-list_secret_port-cfg:

host_name-list_secret_port-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acct-port**

        **Description** Specify the RADIUS server's accounting port (default 1813)

        **Type:** number

        **Range:** 1-65535

    **auth-port**

        **Description** Specify the RADIUS server's authentication port (default 1812)

        **Type:** number

        **Range:** 1-65535

    **retransmit**

        **Description** Specify the maximum times allowed for resending an request to the radius server (default 3)

        **Type:** number

        **Range:** 0-5

        **Default:** 3

    **timeout**

        **Description** Specify the maximum time allowed for waiting for a response from a radius server (default 3)

        **Type:** number

        **Range:** 1-15

        **Default:** 3

.. _2458_host_ipv6-list:

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

	 **Block object keys**             

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

    **ipv6-addr**

        **Description** IPV6 address of RADIUS server

        **Type:** string

        **Format:** ipv6-address

    **secret**

        **Description:** secret is a **JSON Block**.  Please see below for :ref:`2458_host_ipv6-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2458_host_ipv6-list_secret:

host_ipv6-list_secret
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`2458_host_ipv6-list_secret_port-cfg` 

        **Type:** Object

    **secret-value**

        **Description** The RADIUS server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _2458_host_ipv6-list_secret_port-cfg:

host_ipv6-list_secret_port-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **acct-port**

        **Description** Specify the RADIUS server's accounting port (default 1813)

        **Type:** number

        **Range:** 1-65535

    **auth-port**

        **Description** Specify the RADIUS server's authentication port (default 1812)

        **Type:** number

        **Range:** 1-65535

    **retransmit**

        **Description** Specify the maximum times allowed for resending an request to the radius server (default 3)

        **Type:** number

        **Range:** 0-5

        **Default:** 3

    **timeout**

        **Description** Specify the maximum time allowed for waiting for a response from a radius server (default 3)

        **Type:** number

        **Range:** 1-15

        **Default:** 3