ltm auth profile

ltm auth profile(1)	      BIG-IP TMSH Manual	   ltm auth profile(1)



NAME
       profile - Configures an authentication profile.

MODULE
       ltm auth

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

   CREATE/MODIFY
	create profile [name]
	modify profile [name]
	  options:
	    app-service [[string] | none]
	    configuration [ [name] | none]
	    cookie-key [string]
	    cookie-name [string]
	    credential-source [http-basic-auth]
	    defaults-from [name]
	    description [string]
	    enabled [yes | no]
	    idle-timeout [integer]
	    rule [iRule name]

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

	reset-stats profile
	reset-stats profile [ [ [name] | [glob] | [regex] ] ... ]

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

	show profile
	show profile [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	   (default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
	   field-fmt
	   global

   DELETE
	delete profile [name]

       Note: You cannot delete default profiles.

DESCRIPTION
       You can use the profile component to configure a custom authentication
       profile, or you can use the default profile that the BIG-IP(r) Local
       Traffic Manager system provides for each type of authentication module.

       An authentication profile requires one of the following configuration
       objects: ltm auth kerberos-delegation, ltm auth ldap, ltm auth radius,
       ltm auth ssl-cc-ldap, ltm auth ssl-crldp, ltm auth ssl-ocsp or ltm auth
       tacacs. The type of profile specified by the defaults-from option must
       match the type of configuration object.

EXAMPLES
       create profile my_authentication_profile { configuration tacacs
       defaults-from tacacs credential-source http-basic-auth enabled yes
       idle-timeout 30 rule _sys_auth_tacacs }

       Creates a profile named my_authentication_profile for TACACS+
       authentication.

       list profile

       Displays the properties of all of the auth profile components.

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

       configuration
	    Specifies the name of an authentication configuration object. This
	    option is required.

       cookie-key
	    Specifies the key that the system uses to encrypt the session
	    cookie assigned to each user using the cookie-name option. The
	    default value is f5auth. This option applies only to KRB Delegate
	    profiles.

       cookie-name
	    Specifies a session cookie that the system assigns to each user.
	    F5 Networks recommends that each virtual server use a different
	    cookie name. The system encrypts the cookie using the value of the
	    cookie-key option. The default value is abc123. This option
	    applies only to KRB Delegate profiles.

       credential-source
	    Specifies the credential source.

       defaults-from
	    Specifies the name of the authentication profile from which you
	    want your custom profile to inherit settings. This option is
	    required.

       description
	    User defined description.

       enabled
	    Specifies whether this authentication profile is enabled. The
	    default value is yes.

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

       idle-timeout
	    Specifies the idle timeout for the authentication profile. The
	    default value is 300 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.

       rule Specifies the name of the rule that corresponds to the
	    authentication method you want to use.

SEE ALSO
       create, delete, edit, glob, ltm auth crldp-server, ltm auth kerberos-
       delegation, ltm auth ldap, ltm auth ocsp-responder, ltm auth radius,
       ltm auth radius-server, ltm auth ssl-cc-ldap, ltm auth ssl-crldp, ltm
       auth ssl-ocsp, ltm auth tacacs, list, ltm virtual, modify, regex,
       reset-stats, 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		   ltm auth profile(1)