.. _logging_host:

logging host
============

Set remote syslog host DNS name or ip address


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

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

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

	 **Element Name**                      host

	 **Element URI**                       /axapi/v3/logging/host

	 **Element Attributes**                host_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


host_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2240_host_attributes:

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

    **ipv4addr-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/logging/host/ipv4addr/{host-ipv4} <logging_host_ipv4addr>`

    **ipv6addr-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/logging/host/ipv6addr/{host-ipv6} <logging_host_ipv6addr>`

    **partition**

        **Description:** partition is a **JSON Block**.  Please see below for :ref:`2240_partition` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/host/partition <logging_host_partition>`

.. _2240_ipv6addr-list:

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

	 **Block object keys**             

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

    **host-ipv6**

        **Description** Set syslog host ipv6 address

        **Type:** string

        **Format:** ipv6-address

    **over-tls**

        **Description** Enable remote logging over TLS session

        **Type:** boolean

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

        **Default:** 0

    **port**

        **Description** Set remote syslog port number

        **Type:** number

        **Range:** 1-32767

        **Default:** 514

    **tcp**

        **Description** Use TCP as transport protocol

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port for connections

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

.. _2240_partition:

partition
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **partition-name**

        **Description** Select partition name for logging

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** partition-name and shared are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **shared**

        **Description** Select shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared and partition-name are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2240_ipv4addr-list:

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

	 **Block object keys**             

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

    **host-ipv4**

        **Description** Set syslog host ip address

        **Type:** string

        **Format:** host

    **over-tls**

        **Description** Enable remote logging over TLS session

        **Type:** boolean

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

        **Default:** 0

    **port**

        **Description** Set remote syslog port number

        **Type:** number

        **Range:** 1-32767

        **Default:** 514

    **tcp**

        **Description** Use TCP as transport protocol

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port for connections

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