.. _tacacs_server:

tacacs-server
=============

Configure TACACS+ servers


tacacs-server Specification
---------------------------

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

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

	 **Element Name**                      tacacs-server

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

	 **Element Attributes**                tacacs-server_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3461_tacacs-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/tacacs_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/tacacs-server



.. raw:: html

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


:ref:`3461_tacacs-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/tacacs_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/tacacs-server



.. raw:: html

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


:ref:`3461_tacacs-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/tacacs-server



.. raw:: html

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


:ref:`3461_tacacs-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/tacacs_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/tacacs-server



.. raw:: html

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


:ref:`3461_tacacs-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/tacacs_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3461_tacacs-server_attributes:

tacacs-server attributes
------------------------

    **host**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/tacacs-server/host <tacacs_server_host>`

    **interval**

        **Description** The moniter interval in seconds (default 60)

        **Type:** number

        **Range:** 1-120

        **Default:** 60

    **monitor**

        **Description** Configure TACACS+ servers

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3461_host:

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

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

    **ipv4-list**

        **Type:** List

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

    **ipv6-list**

        **Type:** List

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

    **tacacs-hostname-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/tacacs-server/host/tacacs-hostname/{hostname} <tacacs_server_host_tacacs_hostname>`

.. _3461_host_tacacs-hostname-list:

host_tacacs-hostname-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hostname**

        **Description** Hostname of TACACS+ 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:`3461_host_tacacs-hostname-list_secret` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3461_host_tacacs-hostname-list_secret:

host_tacacs-hostname-list_secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **port-cfg**

        **Description:** port-cfg is a **JSON Block**.  Please see below for :ref:`3461_host_tacacs-hostname-list_secret_port-cfg` 

        **Type:** Object

    **secret-value**

        **Description** The TACACS+ server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **source-eth**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **source-ip**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **source-ipv6**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

    **source-lif**

        **Description** Logical interface (Lif interface number)

        **Type:** number

        **Range:** 1-128

    **source-loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **source-trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **source-ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3461_host_tacacs-hostname-list_secret_port-cfg:

host_tacacs-hostname-list_secret_port-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **monitor**

        **Description** Specify monitor TACACS+ server

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** Specify the user password

        **Type:** boolean

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

        **Default:** 0

    **password-value**

        **Description** The user password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Specify the port number used by TACACS+ server.( default port is 49) (Port number (default 49))

        **Type:** number

        **Range:** 1-65535

        **Default:** 49

    **timeout**

        **Description** Specify the maximum time allowed for setting up a connection with the TACACS+ server. (default timeout is 12 seconds) (Maximum time allowed for setting up a connection with the TACACS+ server, in seconds (default 12))

        **Type:** number

        **Range:** 1-12

        **Default:** 12

    **username**

        **Description** Specify the username

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _3461_host_ipv4-list:

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

	 **Block object keys**             

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

    **ipv4-addr**

        **Description** IPV4 address of TACACS+ server

        **Type:** string

        **Format:** ipv4-address

    **secret**

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

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3461_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.) help-val The ENCRYPTED secret string

    **port-cfg**

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

        **Type:** Object

    **secret-value**

        **Description** The TACACS+ server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **source-eth**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **source-ip**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **source-lif**

        **Description** Logical interface (Lif interface number)

        **Type:** number

        **Range:** 1-128

    **source-loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **source-trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **source-ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3461_host_ipv4-list_secret_port-cfg:

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

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

    **encrypted**

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

    **monitor**

        **Description** Specify monitor TACACS+ server

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** Specify the user password

        **Type:** boolean

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

        **Default:** 0

    **password-value**

        **Description** The user password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Specify the port number used by TACACS+ server.( default port is 49) (Port number (default 49))

        **Type:** number

        **Range:** 1-65535

        **Default:** 49

    **timeout**

        **Description** Specify the maximum time allowed for setting up a connection with the TACACS+ server. (default timeout is 12 seconds) (Maximum time allowed for setting up a connection with the TACACS+ server, in seconds (default 12))

        **Type:** number

        **Range:** 1-12

        **Default:** 12

    **username**

        **Description** Specify the username

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _3461_host_ipv6-list:

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

	 **Block object keys**             

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

    **ipv6-addr**

        **Description** IPV6 address of TACACS+ server

        **Type:** string

        **Format:** ipv6-address

    **secret**

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

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3461_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.) help-val The ENCRYPTED secret string

    **port-cfg**

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

        **Type:** Object

    **secret-value**

        **Description** The TACACS+ server's secret

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **source-eth**

        **Description** Ethernet interface (Port number)

        **Type:** number

        **Format:** interface

    **source-ipv6**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

    **source-lif**

        **Description** Logical interface (Lif interface number)

        **Type:** number

        **Range:** 1-128

    **source-loopback**

        **Description** Loopback interface (Port number)

        **Type:** number

        **Format:** interface

    **source-trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **source-ve**

        **Description** Virtual ethernet interface (Virtual ethernet interface number)

        **Type:** number

        **Format:** interface

.. _3461_host_ipv6-list_secret_port-cfg:

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

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

    **encrypted**

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

    **monitor**

        **Description** Specify monitor TACACS+ server

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** Specify the user password

        **Type:** boolean

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

        **Default:** 0

    **password-value**

        **Description** The user password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Specify the port number used by TACACS+ server.( default port is 49) (Port number (default 49))

        **Type:** number

        **Range:** 1-65535

        **Default:** 49

    **timeout**

        **Description** Specify the maximum time allowed for setting up a connection with the TACACS+ server. (default timeout is 12 seconds) (Maximum time allowed for setting up a connection with the TACACS+ server, in seconds (default 12))

        **Type:** number

        **Range:** 1-12

        **Default:** 12

    **username**

        **Description** Specify the username

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters