apm policy agent oam

apm policy agent oam(1)       BIG-IP TMSH Manual       apm policy agent oam(1)



NAME
       oam - Manages an OAM agent.

MODULE
       apm policy agent

SYNTAX
       Warning:This page is obsolete. AAA OAM agent is no longer supported.

       Configure the oam component within the policy agent module using the
       syntax shown in the following sections.

   CREATE/MODIFY
	create oam [name]
	modify oam [name]
	  options:
	    app-service [[string] | none]
	    max-logon-attempt [integer]
	    server [[string] | none]
	    show-extended-error [true | false]
	    url [[string] | none]

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

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

	show oam
	show oam [name]

   DELETE
	delete oam [name]

DESCRIPTION
       You can use the oam component to create and manage an OAM agent.

EXAMPLES
       create oam oam_agent1 { server oam10g max-logon-attempt 3 show-
       extended-error false url "http://www.mydomain.com/protected/" }
	    Creates an OAM agent named oam_agent1 that uses authentication
	    server oam10g and prompts a user for credentials three times
	    before denying access to http://www.mydomain.com/protected/.

       modify oam oam_agent1 max-logon-attempt 4
       list oam all
	    Displays a list of OAM agents.

       delete oam my_oam_agent
	    Deletes the OAM agent named my_tacacsplus_agent.

OPTIONS
       [name]
	    Specifies the name of the component. This option is required.

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

       max-logon-attempt
	    Specifies the maximum number of opportunities that users have to
	    re-enter credentials after their first attempt to log in fails. If
	    you set this value to a number from 2 to 5 inclusive, the system
	    allows users the specified number of opportunities to log in after
	    the first attempt to log in fails. If you set the value to 1, the
	    system does not allow a second log in opportunity after a first
	    log in attempt fails. The default value is 3.

       partition
	    Displays the partition within which the component resides.

       server
	    Specifies the name of the OAM server used for user authentication.
	    This option is required.

       url  Specifies the URL of the resource that is protected by the OAM
	    server. It is used to authenticate the user using the specified
	    user credentials. This option is required, and you must specify an
	    absolute URL. An absolute URL specifies the exact location of a
	    file or directory on the Internet.

       show-extended-error
	    Specifies to display a verbose error message on the retry logon
	    page. The default value is false.

SEE ALSO
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 2011-2013, 2015-2016. All rights
       reserved.



BIG-IP				  2016-03-14	       apm policy agent oam(1)