apm policy agent logon-page
apm policy agent logon-page(1) BIG-IP TMSH Manual apm policy agent logon-page(1)
NAME
logon-page - Manages a Logon Page agent.
MODULE
apm policy agent
SYNTAX
Configure the logon-page component within the policy agent module using the following syntax.
CREATE/MODIFY
create logon-page [name]
modify logon-page [name]
options:
app-service [[string] | none]
basic-auth-realm [[string] | none]
customization-group [[string] | none]
field-modifiable1 [true | false]
field-modifiable2 [true | false]
field-modifiable3 [true | false]
field-modifiable4 [true | false]
field-modifiable5 [true | false]
field-type1 [checkbox | none | password | text]
field-type2 [checkbox | none | password | text]
field-type3 [checkbox | none | password | text]
field-type4 [checkbox | none | password | text]
field-type5 [checkbox | none | password | text]
http-401-auth-level [basic | basic-negotiate | negotiate | none]
post-var-name1 [[integer] | none]
post-var-name2 [[integer] | none]
post-var-name3 [[integer] | none]
post-var-name4 [[integer] | none]
post-var-name5 [[integer] | none]
session-var-name1 [[integer] | none]
session-var-name2 [[integer] | none]
session-var-name3 [[integer] | none]
session-var-name4 [[integer] | none]
session-var-name5 [[integer] | none]
clean-sess-var1 [true | false]
clean-sess-var2 [true | false]
clean-sess-var3 [true | false]
clean-sess-var4 [true | false]
clean-sess-var5 [true | false]
split-username [true | false]
type [401 | form-based]
edit logon-page [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list logon-page
list logon-page [ [ [name] | [glob] | [regex] ] ... ]
show running-config logon-page
show running-config logon-page [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
partition
show logon-page
show logon-page [name]
DELETE
delete logon-page [name]
DESCRIPTION
You can use the logon-page component to create and manage a Logon Page agent. This agent creates a logon page
that includes the form in which users input the credentials required by an access policy. You can use the
customization-group option to customize the logon page.
EXAMPLES
create logon-page MyLogonPageAgent my { type 401 basic-auth-realm myrealm split-username false
http-401-auth-level none }
Creates a basic authentication Logon Page agent named MyLogonPageAgent that results in a 401 response.
list logon-page
Displays a list of Logon Page agents.
delete logon-page MyLogonPageAgent
Deletes the Logon Page agent named MyLogonPageAgent.
OPTIONS
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.
basic-auth-realm
Specifies the system being accessed for HTTP basic authentication. This value is shown in the 401
response. Use this option only for basic authentication Logon pages.
clean-sess-var1 - clean-sess-var5
Specifies whether session variable under corresponding sess-var-name would be cleaned before logon page
appearance (i.e. agent execution) or not. Works only with form-based authentication.
customization-group
Specifies a predefined configuration that contains several settings that you want the agent to use to
configure a logon page. This setting is required, and the customization group that you assign must be of
the type logon. Use this option only for basic authentication Logon pages.
field-modifiable1 - field-modifiable5
Specifies whether the user can modify the contents of the field on a form-based Logon page. The default
is true. You can use this option to display read-only information. A Logon page contains can have a
maximum of five fields. Use this option only for form-based Logon pages.
field-type1 - field-type5
Specifies the type of fields on a form-based Logon page. The default is text. Use this option only for
form-based Logon pages. The options are:
checkbox
none
password
text
http-401-auth-level
Use this option only for basic authentication Logon pages. The options are:
basic
basic-negotiate
negotiate
none
[name]
Specifies the name of a Logon Page agent. This setting is required.
partition
Displays the partition within which the component resides.
post-var-name1 - post-var-name5
Specifies the name of the variable that is sent with POST request. Use this option only for form-based
Logon pages.
sess-var-name1 - sess-var-name5
Specifies the session variable from which the initial value is taken. Use this option only for form-based
Logon pages.
split-username
Specifies whether the 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.
Use this option only for basic authentication Logon pages.
type Specifies the type of logon page that appears. The options are:
401 Displays a basic HTTP authentication form.
form-based
Displays a logon page.
SEE ALSO
external-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-2013, 2016. All rights reserved.
BIG-IP 2016-10-03 apm policy agent logon-page(1)