apm policy agent external-logon-page

apm policy agent external-logon-page(1) 	  BIG-IP TMSH Manual	      apm policy agent external-logon-page(1)

NAME
       external-logon-page - Manages an External Logon Page agent.

MODULE
       apm policy agent

SYNTAX
       Configure the external-logon-page component within the policy agent module using the following syntax.

   CREATE/MODIFY
	create external-logon-page [name]
	modify external-logon-page [name]
	  options:
	    app-service [[string] | none]
	    split-username [true | false]
	    uri [[string]> | none]

	edit external-logon-page [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list external-logon-page
	list external-logon-page [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    partition

   DELETE
	delete external-logon-page [name]

DESCRIPTION
       The External Logon Page agent creates an external Logon page that redirects the client browser.

EXAMPLES
       create external-logon-page MyExternalLogonPageAgent { uri "MyExternalLogonPageServerURI" }
	    Creates the External Logon Page agent named MyExternalLogonPageAgent that is associated with the URI
	    MyExternalLogonPageServerURI.

       create external-logon-page MyExternalLogonPageAgent { uri "%{session.my_server_uri}" }
	    Creates the External Logon Page agent named MyExternalLogonPageAgent with a URI of session.my_server_uri.

       list external-logon-page
	    Displays a list of External Logon Page agents.

       delete external-logon-page MyExternalLogonPageAgent
	    Deletes the External Logon Page agent named MyExternalLogonPageAgent.

OPTIONS
       [name]
	    Specifies the name of an External Logon Page agent. This option is required.

       partition
	    Displays the partition within which the component resides.

       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.

       split-username
	    Specifies whether user's input is split into username and domain. This option supports UPN style logon ID
	    (userid@domainid) and Windows Domain User account ID (domainid\userid). The default is false. Set this to
	    true when you want to store the username and domain separately.

       uri  Specifies a predefined configuration that contains several settings that you want the agent to use to
	    configure an External Logon page. This option is required.

SEE ALSO
       logon-page

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

BIG-IP						      2012-10-19	      apm policy agent external-logon-page(1)