ltm monitor snmp-dca-base

ltm monitor snmp-dca-base(1)			  BIG-IP TMSH Manual			 ltm monitor snmp-dca-base(1)

NAME
       snmp-dca-base - Configures a base Simple Network Management Protocol (SNMP) Data Center Audit monitor.

MODULE
       ltm monitor

SYNTAX
       Configure the snmp-dca-base component within the ltm monitor module using the syntax in the following
       sections.

   CREATE/MODIFY
	create snmp-dca-base [name]
	modify snmp-dca-base [name]
	  options:
	    app-service [[string] | none]
	    community [ [name] | none]
	    cpu-coefficient [ [integer] | none]
	    defaults-from [name]
	    description [string]
	    interval [integer]
	    time-until-up [integer]
	    timeout [integer]
	    user-defined [ [name] [value] | [name] none ]
	    version [ [integer] | none]

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

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

   DELETE
	delete snmp-dca-base [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the snmp-dca-base component to configure a custom monitor, or you can use the default base SNMP
       DCA monitor that the Local Traffic Manager provides. This type of monitor checks the performance of a server
       running an SNMP agent such as UC Davis. Use this monitor only when you want the load balancing destination to
       be based solely on user data, and not CPU, memory or disk use.

EXAMPLES
       create snmp-dca-base my_snmp-dca-base defaults-from snmp_dca_base

       Creates a monitor named my_snmp-dca-base that inherits properties from the default base SNMP DCA monitor.

       list snmp-dca-base

       Displays the properties of all of the base SNMP DCA 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 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_dca_base.

       description
	    User defined description.

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

       interval
	    Specifies the frequency at which the system issues the monitor check. The default value is 10 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.

       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.

       time-until-up
	    Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
	    A value of 0 (zero) causes a node to be marked up immediately after a valid response is received from the
	    node. The default value is 0 (zero).

       timeout
	    Specifies the number of seconds the target has in which to respond to the monitor request. The default
	    value is 30 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.

       user-defined
	    Specifies any user-defined command-line arguments and variables that the external program requires. Use
	    the following syntax to specify a user defined parameter.

		 modify external my_external user-defined my_param_name my_param_value

	    Use the following syntax to remove a user defined parameter.

		 modify external my_external user-defined my_param_name none

       version
	    Specifies the version of SNMP that the host server uses. The default value is none.

SEE ALSO
       create, delete, edit, glob, 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-04-05			 ltm monitor snmp-dca-base(1)