auth apm-auth

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

NAME
       apm-auth - Configures an APM-based authentication object for implementing access policy execution-based authentication of
       BIG-IP(r) system users.

MODULE
       auth

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

   CREATE/MODIFY
	create apm-auth [name]
	modify apm-auth [name]
	  options:
	    profile-access [string]

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

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

   DELETE
	delete apm-auth [name]

DESCRIPTION
       You can configure APM-based authentication to execute an access policy for BIG-IP system users to authenticate and
       authorize them.

       APM authentication methods like HTTP, AD/LDAP, TACACS+ authentication can be used in box authentication To authenticate
       BIG-IP system users.To do this, create an access profile, create APM configuration object with the above access profile,
       and then activate the object.

       The following steps describe how to configure APM-based authentication for BIG-IP system users:

       1. Use the profile-access component in the apm module to create a access profile.

       2. Use the apm-auth component in the auth module to map an access profile to an APM-based authentication object.

       3. To activate APM-based authentication for BIG-IP system users, run the command sequence modify / auth source type apm-
       auth

EXAMPLES
       create apm-auth system-auth {profile-access apm-profile}

       Creates an APM-based authentication object named system-auth

       delete apm-auth system-auth

       Deletes the APM-based authentication object named system-auth.

OPTIONS
       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 administrative partition within which the component resides.

       profile-access
	    Specifies the access profile that the system must use for APM-based authentication. You must specify an access profile
	    when you create an APM-based configuration object.

       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.

SEE ALSO
       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. All rights reserved.

BIG-IP							    2013-06-17						  auth apm-auth(1)