.. _snmp_server: snmp-server =========== Configure SNMP engine parameters snmp-server Specification ------------------------- ===================================== ==================================================== **Parameter** **Value** ===================================== ==================================================== **Type** *Intermediate Resource* **Element Name** snmp-server **Element URI** /axapi/v3/snmp-server **Element Attributes** snmp-server_attributes **Partition Visibility** shared **Schema** :download:`snmp-server schema ` ===================================== ==================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/snmp-server .. raw:: html snmp-server_attributes .. raw:: html
.. _3124_snmp-server_attributes: snmp-server attributes ---------------------- **SNMPv1-v2c** **Description:** SNMPv1-v2c is a **JSON Block**. Please see below for :ref:`3124_SNMPv1-v2c` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv1-v2c ` **SNMPv3** **Description:** SNMPv3 is a **JSON Block**. Please see below for :ref:`3124_SNMPv3` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv3 ` **community** **Description:** community is a **JSON Block**. Please see below for :ref:`3124_community` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/community ` **contact** **Description:** contact is a **JSON Block**. Please see below for :ref:`3124_contact` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/contact ` **disable** **Description:** disable is a **JSON Block**. Please see below for :ref:`3124_disable` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/disable ` **enable** **Description:** enable is a **JSON Block**. Please see below for :ref:`3124_enable` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable ` **engineID** **Description:** engineID is a **JSON Block**. Please see below for :ref:`3124_engineID` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/engineID ` **group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/group/{groupname} ` **host** **Description:** host is a **JSON Block**. Please see below for :ref:`3124_host` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/host ` **location** **Description:** location is a **JSON Block**. Please see below for :ref:`3124_location` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/location ` **management-index** **Description:** management-index is a **JSON Block**. Please see below for :ref:`3124_management-index` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/management-index ` **slb-data-cache-timeout** **Description:** slb-data-cache-timeout is a **JSON Block**. Please see below for :ref:`3124_slb-data-cache-timeout` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/slb-data-cache-timeout ` **table-timeout-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/table-timeout/{table} ` **user-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/user/{username} ` **view-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/view/{viewname}+{oid} ` .. _3124_table-timeout-list: table-timeout-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **table** **Description** SNMP table name or table oid **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **timeout** **Description** timeout value **Type:** number **Range:** 1-60 **Default:** 60 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_enable: enable ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **service** **Description** Enable SNMP service **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **traps** **Description:** traps is a **JSON Block**. Please see below for :ref:`3124_enable_traps` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_enable_traps: enable_traps ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all SNMP traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gslb** **Description:** gslb is a **JSON Block**. Please see below for :ref:`3124_enable_traps_gslb` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/gslb ` **lldp** **Description** Enable lldp traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lsn** **Description:** lsn is a **JSON Block**. Please see below for :ref:`3124_enable_traps_lsn` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/lsn ` **network** **Description:** network is a **JSON Block**. Please see below for :ref:`3124_enable_traps_network` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/network ` **routing** **Description:** routing is a **JSON Block**. Please see below for :ref:`3124_enable_traps_routing` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/routing ` **scaleout** **Description:** scaleout is a **JSON Block**. Please see below for :ref:`3124_enable_traps_scaleout` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/scaleout ` **slb** **Description:** slb is a **JSON Block**. Please see below for :ref:`3124_enable_traps_slb` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/slb ` **slb-change** **Description:** slb-change is a **JSON Block**. Please see below for :ref:`3124_enable_traps_slb-change` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/slb-change ` **snmp** **Description:** snmp is a **JSON Block**. Please see below for :ref:`3124_enable_traps_snmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/snmp ` **ssl** **Description:** ssl is a **JSON Block**. Please see below for :ref:`3124_enable_traps_ssl` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/ssl ` **system** **Description:** system is a **JSON Block**. Please see below for :ref:`3124_enable_traps_system` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/system ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vcs** **Description:** vcs is a **JSON Block**. Please see below for :ref:`3124_enable_traps_vcs` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/vcs ` **vrrp-a** **Description:** vrrp-a is a **JSON Block**. Please see below for :ref:`3124_enable_traps_vrrp-a` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/vrrp-a ` .. _3124_enable_traps_slb-change: enable_traps_slb-change ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all system group traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connection-resource-event** **Description** Enable system connection resource event trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **resource-usage-warning** **Description** Enable partition resource usage warning trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server** **Description** Enable slb server create/delete trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-port** **Description** Enable slb server port create/delete trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-cert-change** **Description** Enable SSL certificate change trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-cert-expire** **Description** Enable SSL certificate expiring trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **system-threshold** **Description** Enable slb system threshold trap **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 **vip** **Description** Enable slb vip create/delete trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-port** **Description** Enable slb vip-port create/delete trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3124_enable_traps_lsn: enable_traps_lsn ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all LSN group traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fixed-nat-port-mapping-file-change** **Description** Enable LSN trap when fixed nat port mapping file change **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-ipport-threshold** **Description** Maximum threshold **Type:** number **Range:** 10000-64512 **Default:** 64512 **max-port-threshold** **Description** Maximum threshold **Type:** number **Range:** 10000-655355000 **Default:** 655350000 **per-ip-port-usage-threshold** **Description** Enable LSN trap when IP total port usage reaches the threshold (default 64512) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **total-port-usage-threshold** **Description** Enable LSN trap when NAT total port usage reaches the threshold (default 655350000) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **traffic-exceeded** **Description** Enable LSN trap when NAT pool reaches the threshold **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 .. _3124_enable_traps_vrrp-a: enable_traps_vrrp-a ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **active** **Description** Enable VRRP-A active trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **all** **Description** Enable all VRRP-A group traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **standby** **Description** Enable VRRP-A standby trap **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 .. _3124_enable_traps_snmp: enable_traps_snmp ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all SNMP group traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **linkdown** **Description** Enable SNMP link-down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **linkup** **Description** Enable SNMP link-up trap **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 .. _3124_enable_traps_system: enable_traps_system ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all system group traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **apps-global** **Description:** apps-global is a **JSON Block**. Please see below for :ref:`3124_enable_traps_system_apps-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/system/apps-global ` **control-cpu-high** **Description** Enable control CPU usage high trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **data-cpu-high** **Description** Enable data CPU usage high trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fan** **Description** Enable system fan trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **file-sys-read-only** **Description** Enable file system read-only trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **high-disk-use** **Description** Enable system high disk usage trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **high-memory-use** **Description** Enable system high memory usage trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **high-temp** **Description** Enable system high temperature trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **license-management** **Description** Enable system license management traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **low-temp** **Description** Enable system low temperature trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **packet-drop** **Description** Enable system packet dropped trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **power** **Description** Enable system power supply trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pri-disk** **Description** Enable system primary hard disk trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart** **Description** Enable system restart trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sec-disk** **Description** Enable system secondary hard disk trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shutdown** **Description** Enable system shutdown trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp-resource-event** **Description** Enable system smp resource event trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start** **Description** Enable system start trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **syslog-severity-one** **Description** Enable system syslog severity one messages trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tacacs-server-up-down** **Description** Enable system TACACS monitor server up/down trap **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 .. _3124_enable_traps_system_apps-global: enable_traps_system_apps-global ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cps-threshold** **Description** Enable CPS trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sessions-threshold** **Description** Enable sessions threshold trap **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 .. _3124_enable_traps_ssl: enable_traps_ssl ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **server-certificate-error** **Description** Enable SSL server certificate error trap **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 .. _3124_enable_traps_vcs: enable_traps_vcs ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **state-change** **Description** Enable VCS state change trap **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 .. _3124_enable_traps_routing: enable_traps_routing ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgp** **Description:** bgp is a **JSON Block**. Please see below for :ref:`3124_enable_traps_routing_bgp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/routing/bgp ` **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`3124_enable_traps_routing_isis` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/routing/isis ` **ospf** **Description:** ospf is a **JSON Block**. Please see below for :ref:`3124_enable_traps_routing_ospf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/routing/ospf ` .. _3124_enable_traps_routing_bgp: enable_traps_routing_bgp ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ax** **Description:** ax is a **JSON Block**. Please see below for :ref:`3124_enable_traps_routing_bgp_ax` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/routing/bgp/ax ` **bgpBackwardTransNotification** **Description** Enable bgpBackwardTransNotification traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgpEstablishedNotification** **Description** Enable bgpEstablishedNotification traps **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 .. _3124_enable_traps_routing_bgp_ax: enable_traps_routing_bgp_ax ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgpBackwardTransNotification** **Description** Enable bgpBackwardTransNotification traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgpEstablishedNotification** **Description** Enable bgpEstablishedNotification traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgpPrefixThresholdClearNotification** **Description** Enable bgpPrefixThresholdClearNotification traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgpPrefixThresholdExceededNotification** **Description** Enable bgpPrefixThresholdExceededNotification traps **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 .. _3124_enable_traps_routing_ospf: enable_traps_routing_ospf ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ospfIfAuthFailure** **Description** Enable ospfIfAuthFailure traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfIfConfigError** **Description** Enable ospfIfConfigError traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfIfRxBadPacket** **Description** Enable ospfIfRxBadPacket traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfIfStateChange** **Description** Enable ospfIfStateChange traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfLsdbApproachingOverflow** **Description** Enable ospfLsdbApproachingOverflow traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfLsdbOverflow** **Description** Enable ospfLsdbOverflow traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfMaxAgeLsa** **Description** Enable ospfMaxAgeLsa traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfNbrStateChange** **Description** Enable ospfNbrStateChange traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfOriginateLsa** **Description** Enable ospfOriginateLsa traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfTxRetransmit** **Description** Enable ospfTxRetransmit traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtIfAuthFailure** **Description** Enable ospfVirtIfAuthFailure traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtIfConfigError** **Description** Enable ospfVirtIfConfigError traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtIfRxBadPacket** **Description** Enable ospfVirtIfRxBadPacket traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtIfStateChange** **Description** Enable ospfVirtIfStateChange traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtIfTxRetransmit** **Description** Enable ospfVirtIfTxRetransmit traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospfVirtNbrStateChange** **Description** Enable ospfVirtNbrStateChange traps **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 .. _3124_enable_traps_routing_isis: enable_traps_routing_isis ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **isisAdjacencyChange** **Description** Enable isisAdjacencyChange traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisAreaMismatch** **Description** Enable isisAreaMismatch traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisAttemptToExceedMaxSequence** **Description** Enable isisAttemptToExceedMaxSequence traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisAuthenticationFailure** **Description** Enable isisAuthenticationFailure traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisAuthenticationTypeFailure** **Description** Enable isisAuthenticationTypeFailure traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisCorruptedLSPDetected** **Description** Enable isisCorruptedLSPDetected traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisDatabaseOverload** **Description** Enable isisDatabaseOverload traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisIDLenMismatch** **Description** Enable isisIDLenMismatch traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisLSPErrorDetected** **Description** Enable isisLSPErrorDetected traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisLSPTooLargeToPropagate** **Description** Enable isisLSPTooLargeToPropagate traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisManualAddressDrops** **Description** Enable isisManualAddressDrops traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisMaxAreaAddressesMismatch** **Description** Enable isisMaxAreaAddressesMismatch traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisOriginatingLSPBufferSizeMismatch** **Description** Enable isisOriginatingLSPBufferSizeMismatch traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisOwnLSPPurge** **Description** Enable isisOwnLSPPurge traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisProtocolsSupportedMismatch** **Description** Enable isisProtocolsSupportedMismatch traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisRejectedAdjacency** **Description** Enable isisRejectedAdjacency traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisSequenceNumberSkip** **Description** Enable isisSequenceNumberSkip traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **isisVersionSkew** **Description** Enable isisVersionSkew traps **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 .. _3124_enable_traps_scaleout: enable_traps_scaleout ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **infrastructure** **Description:** infrastructure is a **JSON Block**. Please see below for :ref:`3124_enable_traps_scaleout_infrastructure` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/scaleout/infrastructure ` .. _3124_enable_traps_scaleout_infrastructure: enable_traps_scaleout_infrastructure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all infra traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cluster** **Description:** cluster is a **JSON Block**. Please see below for :ref:`3124_enable_traps_scaleout_infrastructure_cluster` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/scaleout/infrastructure/cluster ` **master-node** **Description:** master-node is a **JSON Block**. Please see below for :ref:`3124_enable_traps_scaleout_infrastructure_master-node` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/scaleout/infrastructure/master-node ` **service-node** **Description:** service-node is a **JSON Block**. Please see below for :ref:`3124_enable_traps_scaleout_infrastructure_service-node` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/enable/traps/scaleout/infrastructure/service-node ` **test-send-all-traps** **Description** Send all infra traps **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 .. _3124_enable_traps_scaleout_infrastructure_service-node: enable_traps_scaleout_infrastructure_service-node ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **local-device-disabled** **Description** Enable local device disabled trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-master** **Description** Enable service-master trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **traffic-map-update** **Description** Enable traffic map update trap **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 .. _3124_enable_traps_scaleout_infrastructure_cluster: enable_traps_scaleout_infrastructure_cluster ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **election** **Description** Enable election status trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **master-calling-re-election** **Description** Enable re-election trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **node-status** **Description** Enable active node status trap **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 .. _3124_enable_traps_scaleout_infrastructure_master-node: enable_traps_scaleout_infrastructure_master-node ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **traffic-map-distribution** **Description** Enable Traffic-map distribution trap **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 **vserver-traffic-map-update** **Description** Enable VServer Traffic-map trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3124_enable_traps_gslb: enable_traps_gslb ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all GSLB traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **group** **Description** Enable GSLB group related traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-ip** **Description** Enable GSLB service-ip related traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **site** **Description** Enable GSLB site related traps **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 **zone** **Description** Enable GSLB zone related traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3124_enable_traps_slb: enable_traps_slb ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Enable all SLB traps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **application-buffer-limit** **Description** Enable application buffer reach limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bw-rate-limit-exceed** **Description** Enable SLB server/port bandwidth rate limit exceed trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bw-rate-limit-resume** **Description** Enable SLB server/port bandwidth rate limit resume trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gateway-down** **Description** Enable SLB server gateway down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gateway-up** **Description** Enable SLB server gateway up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-conn-limit** **Description** Enable SLB server connection limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-conn-resume** **Description** Enable SLB server connection resume trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-disabled** **Description** Enable SLB server-disabled trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-down** **Description** Enable SLB server-down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-selection-failure** **Description** Enable SLB server selection failure trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-up** **Description** Enable slb server up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-conn-limit** **Description** Enable SLB service connection limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-conn-resume** **Description** Enable SLB service connection resume trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-down** **Description** Enable SLB service-down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-down** **Description** Enable SLB service-group-down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-member-down** **Description** Enable SLB service-group-member-down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-member-up** **Description** Enable SLB service-group-member-up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-up** **Description** Enable SLB service-group-up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-up** **Description** Enable SLB service-up trap **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 **vip-connlimit** **Description** Enable the virtual server reach conn-limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-connratelimit** **Description** Enable the virtual server reach conn-rate-limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-down** **Description** Enable SLB virtual server down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-port-connlimit** **Description** Enable the virtual port reach conn-limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-port-connratelimit** **Description** Enable the virtual port reach conn-rate-limit trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-port-down** **Description** Enable SLB virtual port down trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-port-up** **Description** Enable SLB virtual port up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vip-up** **Description** Enable SLB virtual server up trap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3124_enable_traps_network: enable_traps_network ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **trunk-port-threshold** **Description** Enable network trunk-port-threshold trap **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 .. _3124_slb-data-cache-timeout: slb-data-cache-timeout ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **slblimit** **Description** Cache time-out in seconds, default as 60 seconds **Type:** number **Range:** 5-120 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_view-list: view-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **mask** **Description** Hex octets, separated by '.', mask of oid **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** mask and type are mutually exclusive **oid** **Description** MIB view family name or oid **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **type** **Description** 'included': MIB family is included in the view; 'excluded': MIB family is excluded from the view; **Type:** string **Supported Values:** included, excluded **Mutual Exclusion:** type and mask are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **viewname** **Description** Name of the view **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters .. _3124_community: community ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **read-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/community/read/{user} ` .. _3124_community_read-list: community_read-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **oid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/community/read/{user}/oid/{oid-val} ` **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`3124_community_read-list_remote` **Type:** Object **user** **Description** SNMPv1/v2c community string **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_community_read-list_oid-list: community_read-list_oid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **oid-val** **Description** specific the oid (The oid value, object-key) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`3124_community_read-list_oid-list_remote` **Type:** Object **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_community_read-list_oid-list_remote: community_read-list_oid-list_remote ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list** **Type:** List **ipv4-list** **Type:** List **ipv6-list** **Type:** List .. _3124_community_read-list_oid-list_remote_host-list: community_read-list_oid-list_remote_host-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-host** **Description** DNS remote host **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_community_read-list_oid-list_remote_ipv4-list: community_read-list_oid-list_remote_ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-host** **Description** IPV4 remote host **Type:** string **Format:** ipv4-address **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_community_read-list_oid-list_remote_ipv6-list: community_read-list_oid-list_remote_ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-host** **Description** IPV6 remote host **Type:** string **Format:** ipv6-address **ipv6-mask** **Description** IPV6 mask **Type:** number **Range:** 1-128 .. _3124_community_read-list_remote: community_read-list_remote ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list** **Type:** List **ipv4-list** **Type:** List **ipv6-list** **Type:** List .. _3124_community_read-list_remote_host-list: community_read-list_remote_host-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-host** **Description** DNS remote host **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_community_read-list_remote_ipv4-list: community_read-list_remote_ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-host** **Description** IPV4 remote host **Type:** string **Format:** ipv4-address **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_community_read-list_remote_ipv6-list: community_read-list_remote_ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-host** **Description** IPV6 remote host **Type:** string **Format:** ipv6-address **ipv6-mask** **Description** IPV6 mask **Type:** number **Range:** 1-128 .. _3124_contact: contact ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **contact-name** **Description** Identification of the contact person for this managed node **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_host: host ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-name-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/host/host-name/{hostname}+{version} ` **ipv4-host-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/host/ipv4-host/{ipv4-addr}+{version} ` **ipv6-host-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/host/ipv6-host/{ipv6-addr}+{version} ` .. _3124_host_ipv6-host-list: host_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 .. _3124_host_host-name-list: host_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 .. _3124_host_ipv4-host-list: host_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 .. _3124_management-index: management-index ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mgmt-index** **Description** index number **Type:** number **Range:** 0-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_disable: disable ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **a10cmsubagent** **Description** Disable a10cmsubagent **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **traps** **Description:** traps is a **JSON Block**. Please see below for :ref:`3124_disable_traps` **Type:** Object **Reference Object:** :doc:`/axapi/v3/snmp-server/disable/traps ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_disable_traps: disable_traps ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** Disable all traps on this partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gslb** **Description** Disable all gslb traps on this partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **slb** **Description** Disable all slb traps on this partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **slb-change** **Description** Disable all slb-change traps on this partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snmp** **Description** Disable all snmp traps on this partition **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 **vrrp-a** **Description** Disable all vrrp-a on this partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3124_location: location ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **loc** **Description** The physical location of this node **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_group-list: group-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **groupname** **Description** Name of the group **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **read** **Description** specify a read view for the group (read view name) **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **v3** **Description** 'auth': group using the authNoPriv Security Level; 'noauth': group using the noAuthNoPriv Security Level; 'priv': group using SNMPv3 authPriv security level; **Type:** string **Supported Values:** auth, noauth, priv .. _3124_SNMPv3: SNMPv3 ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **user-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv3/user/{username} ` .. _3124_SNMPv3_user-list: SNMPv3_user-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-val** **Description** 'md5': Use HMAC MD5 algorithm for authentication; 'sha': Use HMAC SHA algorithm for authentication; 'sha-512': Use HMAC SHA-512 algorithm for authentication; 'sha-384': Use HMAC SHA-384 algorithm for authentication; 'sha-256': Use HMAC SHA-256 algorithm for authentication; 'sha-224': Use HMAC SHA-224 algorithm for authentication; **Type:** string **Supported Values:** md5, sha, sha-512, sha-384, sha-256, sha-224 **encpasswd** **Description** Passphrase for encryption **Type:** string **Format:** password **Maximum Length:** 31 characters **Maximum Length:** 8 characters **group** **Description** Group to which the user belongs **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **passwd** **Description** Password of this user **Type:** string **Format:** password **Maximum Length:** 31 characters **Maximum Length:** 8 characters **priv** **Description** 'des': DES encryption alogrithm; 'aes': AES encryption alogrithm; 'aes-192': AES-192 encryption alogrithm; 'aes-256': AES-256 encryption alogrithm; (Encryption type) **Type:** string **Supported Values:** des, aes, aes-192, aes-256 **priv-pw-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string) **pw-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string) **username** **Description** Name of the user **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 **v3** **Description** 'auth': Using the authNoPriv Security Level; 'noauth': Using the noAuthNoPriv Security Level; **Type:** string **Supported Values:** auth, noauth .. _3124_user-list: user-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-val** **Description** 'md5': Use HMAC MD5 algorithm for authentication; 'sha': Use HMAC SHA algorithm for authentication; **Type:** string **Supported Values:** md5, sha **encpasswd** **Description** Passphrase for encryption **Type:** string **Format:** password **Maximum Length:** 31 characters **Maximum Length:** 8 characters **group** **Description** Group to which the user belongs **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **passwd** **Description** Password of this user **Type:** string **Format:** password **Maximum Length:** 31 characters **Maximum Length:** 8 characters **priv** **Description** 'des': DES encryption alogrithm; 'aes': AES encryption alogrithm; (Encryption type) **Type:** string **Supported Values:** des, aes **priv-pw-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string) **pw-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string) **username** **Description** Name of the user **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 **v3** **Description** 'auth': Using the authNoPriv Security Level; 'noauth': Using the noAuthNoPriv Security Level; **Type:** string **Supported Values:** auth, noauth .. _3124_engineID: engineID ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **engId** **Description** Define local engineID HEX WORD **Type:** string **Maximum Length:** 24 characters **Maximum Length:** 10 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_SNMPv1-v2c: SNMPv1-v2c ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **user-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv1-v2c/user/{user} ` .. _3124_SNMPv1-v2c_user-list: SNMPv1-v2c_user-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED community string) **oid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv1-v2c/user/{user}/oid/{oid-val} ` **passwd** **Description** define value of community string **Type:** string **Format:** password **Maximum Length:** 31 characters **Maximum Length:** 1 characters **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`3124_SNMPv1-v2c_user-list_remote` **Type:** Object **user** **Description** SNMPv1/v2c community configuration key **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_SNMPv1-v2c_user-list_remote: SNMPv1-v2c_user-list_remote ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list** **Type:** List **ipv4-list** **Type:** List **ipv6-list** **Type:** List .. _3124_SNMPv1-v2c_user-list_remote_host-list: SNMPv1-v2c_user-list_remote_host-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-host** **Description** DNS remote host **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_SNMPv1-v2c_user-list_remote_ipv4-list: SNMPv1-v2c_user-list_remote_ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-host** **Description** IPV4 remote host **Type:** string **Format:** ipv4-address **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_SNMPv1-v2c_user-list_remote_ipv6-list: SNMPv1-v2c_user-list_remote_ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-host** **Description** IPV6 remote host **Type:** string **Format:** ipv6-address **ipv6-mask** **Description** IPV6 mask **Type:** number **Range:** 1-128 .. _3124_SNMPv1-v2c_user-list_oid-list: SNMPv1-v2c_user-list_oid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **oid-val** **Description** specific the oid (The oid value, object-key) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`3124_SNMPv1-v2c_user-list_oid-list_remote` **Type:** Object **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3124_SNMPv1-v2c_user-list_oid-list_remote: SNMPv1-v2c_user-list_oid-list_remote ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list** **Type:** List **ipv4-list** **Type:** List **ipv6-list** **Type:** List .. _3124_SNMPv1-v2c_user-list_oid-list_remote_host-list: SNMPv1-v2c_user-list_oid-list_remote_host-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-host** **Description** DNS remote host **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_SNMPv1-v2c_user-list_oid-list_remote_ipv4-list: SNMPv1-v2c_user-list_oid-list_remote_ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-host** **Description** IPV4 remote host **Type:** string **Format:** ipv4-address **ipv4-mask** **Description** IPV4 mask **Type:** string **Format:** ipv4-netmask .. _3124_SNMPv1-v2c_user-list_oid-list_remote_ipv6-list: SNMPv1-v2c_user-list_oid-list_remote_ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-host** **Description** IPV6 remote host **Type:** string **Format:** ipv6-address **ipv6-mask** **Description** IPV6 mask **Type:** number **Range:** 1-128