gtm monitor radiusΒΆ

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

NAME
       radius - Configures a Remote Access Dial-in User Service (RADIUS) monitor.

MODULE
       gtm monitor

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

   CREATE/MODIFY
	create radius [name]
	modify radius [name]
	  options:
	    app-service [[string] | none]
	    debug [no | yes]
	    defaults-from [name]
	    description [string]
	    destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
	    ignore-down-response [enabled | disabled]
	    interval [integer]
	    nas-ip-address [ [ip address] | none]
	    password [none | [password] ]
	    probe-timeout [integer]
	    secret [none | [secret] ]
	    timeout [integer]
	    username [ [name] | none]

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

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

   DELETE
	delete radius [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the radius component to configure a custom monitor, or you can use the default RADIUS monitor that
       the Global Traffic Manager provides. This type of monitor verifies the RADIUS service by attempting to
       authenticate the specified user.

EXAMPLES
       create radius my_radius defaults-from radius

       Creates a monitor named my_radius that inherits properties from the default RADIUS monitor.

       list radius

       Displays the properties of all of the RADIUS monitors.

OPTIONS
       app-service
	    Specifies the name of the application service to which this 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 this monitor. Only the application service can modify or delete this monitor.

       debug
	    Specifies whether the monitor sends error messages and additional information to a log file created and
	    labeled specifically for this monitor. You can use the log information to help diagnose and troubleshoot
	    unsuccessful health checks. The default value is no.

	    The options are:

	    no	 Specifies that the system does not redirect error messages and additional information related to
		 this monitor.

	    yes  Specifies that the system redirects error messages and additional information to the
		 /var/log/monitors/--.log file.

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

       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 30 seconds.

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

       nas-ip-address
	    Specifies the network access server IP address that the system uses to identify itself to the RADIUS
	    server. Using this option, multiple BIG-IP(r) systems can appear as a single network access device to the
	    RADIUS server. The default value is none.

       partition
	    Displays the administrative partition within which the component resides.

       password
	    Specifies the password if the monitored target requires authentication. The default value is none.

       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.

       secret
	    Specifies the secret the monitor needs to communicate with the resource. The default value is none.

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

       username
	    Specifies the username, if the monitored target requires authentication. The default value is none.

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, 2013-2014. All rights reserved.

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