gtm monitor snmp

gtm monitor snmp(1)				  BIG-IP TMSH Manual				  gtm monitor snmp(1)

NAME
       snmp - Configures a Simple Network Management Protocol (SNMP) monitor.

MODULE
       gtm monitor

SYNTAX
       Configure the snmp component within the gtm monitor module using the syntax in the following sections.

   CREATE/MODIFY
	create snmp [name]
	modify snmp [name]
	  options:
	    app-service [[string] | none]
	    community [ [name] | none]
	    defaults-from [name]
	    description [string]
	    destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
	    ignore-down-response [enabled | disabled]
	    interval [integer]
	    port [integer]
	    probe attempts [integer]
	    probe-interval [integer]
	    probe-timeout [integer]
	    timeout [integer]
	    version [ [integer] | none]

	edit snmp [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list snmp
	list snmp [ [ [name] | [glob] | [regex] ] ... ]
	show running-config snmp
	show running-config snmp [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete snmp [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the snmp component to configure a custom monitor, or you can use the default SNMP monitor that the
       Global Traffic Manager provides. The SNMP monitor is both a health and performance monitor. This type of
       monitor checks the performance of a server running an SNMP agent such as UC Davis, for the purpose of load
       balancing traffic to that server.

EXAMPLES
       create snmp my_snmp defaults-from snmp_gtm

       Creates a monitor named my_snmp that inherits properties from the default SNMP monitor.

       list snmp

       Displays the properties of all of the SNMP monitors.

OPTIONS
       app-service
	    Specifies the name of the application service to which the monitor belongs. The default value is none.
	    Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
	    modify or delete the monitor. Only the application service can modify or delete the monitor.

       community
	    Specifies the community name that the BIG-IP(r) system must use to authenticate with the host server
	    through SNMP. The default value is public.

       defaults-from
	    Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
	    default value is snmp_gtm.

       description
	    User defined description.

       destination
	    Specifies the IP address and service port of the resource that is the destination of this monitor. The
	    default value is *:*.

	    Possible values are:

	    *:*  Specifies to perform a health check on the IP address and port supplied by a pool member.

	    *:port
		 Specifies to perform a health check on the server with the IP address supplied by the pool member
		 and the port you specify.

	    IP address:port
		 Specifies to mark a pool member up or down based on the response of the server at the IP address and
		 port you specify.

       glob Displays the items that match the glob expression. See help glob for a description of glob expression
	    syntax.

       ignore-down-response
	    Specifies whether the monitor ignores a down response from the system it is monitoring. The default value
	    is disabled.

       interval
	    Specifies the frequency at which the system issues the monitor check. The default value is 90 seconds.

       name Specifies a unique name for the component. This option is required for the commands create, delete, and
	    modify.

       partition
	    Displays the administrative partition within which the component resides.

       port Specifies the port number to which this monitor sends SNMP traps. The default value is 161.

       probe-attempts
	    Specifies the number of times the BIG-IP system attempts to probe the host server, after which the BIG-IP
	    system considers the host server down or unavailable. The default value is 1.

       probe-interval
	    Specifies the frequency at which the BIG-IP system probes the host server. The default value is 1.

       probe-timeout
	    Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP
	    system. The default value is 5 seconds.

       regex
	    Displays the items that match the regular expression. The regular expression must be preceded by an at
	    sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
	    a description of regular expression syntax.

       timeout
	    Specifies the number of seconds the target has in which to respond to the monitor request. The default
	    value is 180 seconds.

	    If the target responds within the set time period, it is considered up. If the target does not respond
	    within the set time period, it is considered down. Also, if the target responds with a RESET packet, the
	    system immediately flags the target as down without waiting for the timeout interval to expire.

       version
	    Specifies the SNMP version the monitor uses. The default value is v1.

SEE ALSO
       create, delete, edit, glob, gtm pool, list, modify, regex, show, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or
       mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
       other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012. All rights reserved.

BIG-IP						      2017-08-15				  gtm monitor snmp(1)