.. _snmp_server_host:

snmp-server host
================

Specify hosts to receive SNMP traps


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

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

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

	 **Element Name**                      host

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

	 **Element Attributes**                host_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


host_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3112_host_attributes:

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

    **host-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/snmp-server/host/host-name/{hostname}+{version} <snmp_server_host_host_name>`

    **ipv4-host-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/snmp-server/host/ipv4-host/{ipv4-addr}+{version} <snmp_server_host_ipv4_host>`

    **ipv6-host-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/snmp-server/host/ipv6-host/{ipv6-addr}+{version} <snmp_server_host_ipv6_host>`

.. _3112_ipv6-host-list:

ipv6-host-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-addr**

        **Description** IPV6 address of SNMP trap host

        **Type:** string

        **Format:** ipv6-address

    **udp-port**

        **Description** The trap host's UDP port number(default: 162)

        **Type:** number

        **Range:** 1-65535

        **Default:** 162

    **user**

        **Description** SNMPv3 user to send traps (User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v1-v2c-comm**

        **Description** SNMPv1/v2c community string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v1': Use SNMPv1; 'v2c': Use SNMPv2c; 'v3': User SNMPv3; 

        **Type:** string

        **Supported Values:** v1, v2c, v3

        **Default:** v2c

.. _3112_host-name-list:

host-name-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hostname**

        **Description** Hostname of SNMP trap host

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **udp-port**

        **Description** The trap host's UDP port number(default: 162)

        **Type:** number

        **Range:** 1-65535

        **Default:** 162

    **user**

        **Description** SNMPv3 user to send traps (User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v1-v2c-comm**

        **Description** SNMPv1/v2c community string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v1': Use SNMPv1; 'v2c': Use SNMPv2c; 'v3': User SNMPv3; 

        **Type:** string

        **Supported Values:** v1, v2c, v3

        **Default:** v2c

.. _3112_ipv4-host-list:

ipv4-host-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-addr**

        **Description** IPV4 address of SNMP trap host

        **Type:** string

        **Format:** ipv4-address

    **udp-port**

        **Description** The trap host's UDP port number(default: 162)

        **Type:** number

        **Range:** 1-65535

        **Default:** 162

    **user**

        **Description** SNMPv3 user to send traps (User Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v1-v2c-comm**

        **Description** SNMPv1/v2c community string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v1': Use SNMPv1; 'v2c': Use SNMPv2c; 'v3': User SNMPv3; 

        **Type:** string

        **Supported Values:** v1, v2c, v3

        **Default:** v2c