.. _radius_server_host:

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

Specify the RADIUS server's hostname or IP address


host Specification
------------------

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

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

	 **Element Name**                      host

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

	 **Element Attributes**                host_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


host_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1697_host_attributes:

host attributes
---------------

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

.. _1697_ipv4-list:

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:`1697_ipv4-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1697_ipv4-list_secret:

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:`1697_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

.. _1697_ipv4-list_secret_port-cfg:

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

.. _1697_name-list:

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:`1697_name-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1697_name-list_secret:

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:`1697_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

.. _1697_name-list_secret_port-cfg:

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

.. _1697_ipv6-list:

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:`1697_ipv6-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1697_ipv6-list_secret:

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:`1697_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

.. _1697_ipv6-list_secret_port-cfg:

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