gtm monitor ldap
gtm monitor ldap(1) BIG-IP TMSH Manual gtm monitor ldap(1)
NAME
ldap - Configures a Lightweight Directory Access Protocol (LDAP)
monitor.
MODULE
gtm monitor
SYNTAX
Configure the ldap component within the gtm monitor module using the
syntax in the following sections.
CREATE/MODIFY
create ldap [name]
modify ldap [name]
options:
base [none | [string] ]
chase-referrals [ no | yes ]
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
filter [ [LDAP key] | none]
ignore-down-response [enabled | disabled]
interval [integer]
mandatory-attributes [no | yes]
password [none | [password] ]
probe-timeout [integer]
security [none | ssl | tls]
timeout [integer]
username [ [name] | none]
edit ldap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list ldap
list ldap [ [ [name] | [glob] | [regex] ] ... ]
show running-config ldap
show running-config ldap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete ldap [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the ldap component to configure a custom monitor, or you
can use the default LDAP monitor that the Global Traffic Manager
provides. This type of monitor verifies the LDAP service by attempting
to authenticate the specified user.
EXAMPLES
create ldap my_ldap defaults-from ldap
Creates a monitor named my_ldap that inherits properties from the
default LDAP monitor.
list ldap
Displays the properties of all of the LDAP monitors.
OPTIONS
base Specifies the location in the LDAP tree from which the monitor
starts the health check. A sample value is dc=bigip-test,dc=net.
The default value is none.
chase-referrals
Specifies whether the monitor upon receipt of an LDAP referral
entry chases that referral. The default value is yes.
The options are:
no Specifies that the system will treat a referral entry as a
normal entry and refrain from querying the remote LDAP
server(s) pointed to by the referral entry.
yes Specifies that the system upon receiving any referral entry
from the monitored LDAP server query, the system will then
query the corresponding LDAP server(s) pointed to by the LDAP
query. If the query for the referral is unsuccessful the
system will mark the monitored LDAP server down.
debug
Specifies whether the monitor sends error messages and additional
information to a log file created and labeled specifically for
this monitor. You can use the log information to help diagnose and
troubleshoot unsuccessful health checks.
The default value is no. The options are:
no Specifies that the system does not redirect error messages
and additional information related to this monitor.
yes Specifies that the system redirects error messages and
additional information to the
/var/log/monitors/--.log file.
defaults-from
Specifies the name of the monitor from which you want your custom
monitor to inherit settings. The default value is ldap.
description
User defined description.
destination
Specifies the IP address and service port of the resource that is
the destination of this monitor. The default value is *:*.
Possible values are:
*:* Specifies to perform a health check on the address and port
supplied by a pool member.
*:port
Specifies to perform a health check on the server with the IP
address supplied by the pool member and the port you specify.
IP address:port
Specifies to mark a pool member up or down based on the
response of the server at the IP address and port you
specify.
filter
Specifies an LDAP key for which the monitor searches. A sample
value is objectclass=*. The default value is none.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax
ignore-down-response
Specifies whether the monitor ignores a down response from the
system it is monitoring. The default value is disabled.
interval
Specifies the frequency at which the system issues the monitor
check. The default value is 10 seconds.
mandatory-attributes
Specifies whether the target must include attributes in its
response to be considered up. The default value is no. The options
are:
no Specifies that the system performs only a one-level search
(based on the value of the filter option), and does not
require that the target returns any attributes.
yes Specifies that the system performs a sub-tree search, and if
the target returns no attributes, the target is considered
down.
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.
password
Specifies the password if the monitored target requires
authentication. The default value is none.
probe-timeout
Specifies the number of seconds after which the BIG-IP(r) system
times out the probe request to the BIG-IP system. The default
value is 5 seconds.
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.
security
Specifies the secure communications protocol that the monitor uses
to communicate with the target. The default value is none.
The options are:
none Specifies that the system does not use a security protocol
for communications with the target.
ssl Specifies that the system uses the SSL protocol for
communications with the target.
tls Specifies that the system uses the TLS protocol for
communications with the target.
timeout
Specifies the number of seconds the target has in which to respond
to the monitor request. The default value is 31 seconds.
If the target responds within the set time period, it is
considered up. If the target does not respond within the set time
period, it is considered down. Also, if the target responds with a
RESET packet, the system immediately flags the target as down
without waiting for the timeout interval to expire.
username
Specifies the username, if the monitored target requires
authentication. The default value is none.
SEE ALSO
create, delete, edit, glob, gtm pool, list, modify, regex, 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-2010, 2013-2014, 2016. All
rights reserved.
BIG-IP 2017-08-15 gtm monitor ldap(1)