ltm monitor soap
ltm monitor soap(1) BIG-IP TMSH Manual ltm monitor soap(1)
NAME
soap - Configures a Simple Object Access Protocol (SOAP) monitor.
MODULE
ltm monitor
SYNTAX
Configure the soap component within the ltm monitor module using the syntax in the following sections.
CREATE/MODIFY
create soap [name]
modify soap [name]
options:
app-service [[string] | none]
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
expect-fault [no | yes]
interval [integer]
manual-resume [enabled | disabled]
method [string]
namespace [ [name] | none]
parameter-name [ [name] | none]
parameter-type [bool | int | long | string ]
parameter-value [none | [integer] | [string] ]
password [none | [password] ]
protocol [http | https]
return-type [bool | char | double | int | long | short | string]
return-value [none | [integer] | [string] ]
soap-action [string]
time-until-up [integer]
timeout [integer]
up-interval [integer]
url-path [none | [string] ]
username [[name] | none]
edit soap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list soap
list soap [ [ [name] | [glob] | [regex] ] ... ]
show soap [ [ [name] | [glob] | [regex] ] ... ]
show running-config soap
show running-config soap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
test-result
DELETE
delete soap [name]
Note: You cannot delete default monitors.
RUN
run soap [name] [ destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ] ]
STOP
stop soap [name]
DESCRIPTION
You can use the soap component to configure a custom monitor, or you can use the default SOAP monitor that the
Local Traffic Manager provides. This type of monitor tests a Web service based on SOAP.
You can test a custom monitor configuration against a specified target destination by using the run command,
and view the results of such a test by using the show command with the test-result option.
The following user roles (in addition to the root user) have permissions to run and stop an ltm monitor test:
admin, application-editor, manager, operator, resource-admin
EXAMPLES
create soap my_soap defaults-from soap
Creates a soap monitor that inherits values from the system default SOAP monitor.
list soap
Displays the properties of all of the SOAP monitors.
run soap my_soap destination 10.10.10.10:80
Runs a one-shot test of the custom monitor my_soap against a target node at 10.10.10.10:80.
stop soap my_soap
Cancels a one-shot test of the custom monitor my_soap in progress.
show soap my_soap test-result
Displays the result of the most recent one-shot test of the custom monitor my_soap.
OPTIONS
app-service
Specifies the name of the application service to which the monitor 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 monitor. Only the application service can modify or delete the monitor.
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 type of monitor you want to use to create the new monitor. The default value is soap.
description
User defined description.
destination
Specifies the IP address and service port of the resource that is the destination of this monitor.
Possible values are:
*:* Specifies to perform a health check on the IP 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.
This option is required for the command run, unless an IP address and service port are specified in the
destination option for the specified custom monitor.
expect-fault
Specifies whether the value of the method option causes the monitor to expect a SOAP fault message. The
default value is no.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
interval
Specifies, in seconds, the frequency at which the system issues the monitor check when either the
resource is down or the status of the resource is unknown. The default value is 5 seconds.
Important: F5 Networks recommends that when you configure this option and the up-interval option,
whichever value is greater be a multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors.
manual-resume
Specifies whether the system automatically changes the status of a resource to up at the next successful
monitor check. The default value of the manual-resume option is disabled.
Note that if you set the manual-resume option to enabled, you must manually mark the resource as up
before the system can use it for load balancing connections.
method
Specifies the method by which the monitor contacts the resource.
name Specifies a unique name for the component. This option is required for the commands create, delete,
modify, run and stop.
namespace
Specifies the name space for the Web service you are monitoring, for example, http://example.com/. The
default value is none.
parameter-name
If the method has a parameter, specifies the name of that parameter. The default value is none.
parameter-type
Specifies the parameter type. The default value is bool.
parameter-value
Specifies the value for the parameter. The default value is none.
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.
protocol
Specifies the protocol that the monitor uses to communicate with the target, http or https. The default
value is http.
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.
return-type
Specifies the type for the returned parameter. The default value is bool.
return-value
Specifies the value for the returned parameter. The default value is none.
soap-action
Specifies the value for the SOAPAction header. The default value is the empty string.
test-result
Displays the result of the most recent one-shot test of the specified monitor(s), if any such test has
been performed since BIG-IP was started.
time-until-up
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
A value of 0 (zero) causes a node to be marked up immediately after a valid response is received from the
node. The default value is 0 (zero).
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 16 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.
url-path
Specifies the URL for the Web service that you are monitoring, for example, /services/myservice.aspx. The
default value is none.
up-interval
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is
up. The default value is 0 (zero), which specifies that the system uses the value of the interval option
whether the resource is up or down.
Important: F5 Networks recommends that when you configure this option and the interval option, whichever
value is greater be a multiple of the lesser value to allow for an even distribution of monitor checks
among all monitors.
username
Specifies the user name if the monitored target requires authentication. The default value is none.
SEE ALSO
create, delete, edit, glob, list, modify, regex, run, show, stop, 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, 2012-2014, 2017. All rights reserved.
BIG-IP 2017-08-16 ltm monitor soap(1)