auth radius

auth radius(1)		      BIG-IP TMSH Manual		auth radius(1)



NAME
       radius - Configures a RADIUS configuration object for implementing
       remote RADIUS-based authentication of BIG-IP(r) system users.

MODULE
       auth

SYNTAX
       Configure the radius component within the auth module using the syntax
       shown in the following sections.

   CREATE/MODIFY
	create radius [name]
	modify radius [name]
	  options:
	    accounting-bug [disabled | enabled]
	    app-service [[string] | none]
	    client-id [none | [string] ]
	    debug [disabled | enabled]
	    description [string]
	    retries [integer]
	    servers [add | delete | replace-all-with]
	      { [ [hostname] | [ip address] ... ] }
	    servers [default | none]
	    service-type [default | login | framed | callback-login |
			  callback-framed | outbound | administrative |
			  nas-prompt | authenticate-only |
			  callback-nas-promit | call-check |
			  callback-administrative]

	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]

DESCRIPTION
       To authenticate BIG-IP system users when their authentication data is
       stored on a remote RADIUS server, you configure a RADIUS server,
       configure a RADIUS configuration object that references that RADIUS
       server, and then activate RADIUS authentication for the BIG-IP system.
       In this case, client credentials are based on basic HTTP authentication
       (that is, user name and password).

       To configure RADIUS authentication for the BIG-IP system:

       1. Use the radius-server component in the auth module to configure a
       RADIUS server. For more information about creating a RADIUS server, see
       help radius-server.

       2. Use the radius component in the auth module to create a RADIUS
       configuration object that references the RADIUS server you created in
       Step 1.

       3. To activate RADIUS authentication for BIG-IP system users, type the
       following command sequence: modify / auth source type radius

EXAMPLES
       create radius bigip_radius_auth servers add {myradiusserver}

       Creates a RADIUS configuration object named bigip_radius_auth.

       delete radius bigip_radius_auth

       Deletes the RADIUS configuration component named bigip_radius_auth.

OPTIONS
       accounting-bug
	    Enables or disables validation of the accounting response vector.
	    This option is necessary only on older servers. The default value
	    is disabled.

       app-service
	    Specifies the name of the application service to which the RADIUS
	    configuration object 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 RADIUS
	    configuration object. Only the application service can modify or
	    delete the RADIUS configuration object.

       client-id
	    Sends a NAS-Identifier RADIUS attribute with string bar. If you do
	    not specify a value for this option, the system uses the pluggable
	    authentication module (PAM) service type. You can disable this
	    feature by specifying a blank client ID.

       debug
	    Enables or disables syslog-ng debugging information at the LOG
	    DEBUG level. F5 Networks does not recommend this option for normal
	    use. The default value is disabled.

       description
	    User defined description.

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

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

       partition
	    Displays the 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.

       retries
	    Specifies the number of authentication retries that the BIG-IP
	    local traffic management system allows before authentication
	    fails. The default value is 3.

       service-type
	    Specifies the type of service used for the RADIUS server. The
	    default is default, which behaves as authenticate-only.

       servers
	    Specifies the host names or IP addresses of existing RADIUS
	    servers that the BIG-IP system uses to obtain authentication data.

SEE ALSO
       auth radius-server, auth user, create, delete, glob, list, modify,
       regex, run, 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-2013, 2016. All rights
       reserved.



BIG-IP				  2016-03-14			auth radius(1)