gtm monitor soap
gtm monitor soap(1) BIG-IP TMSH Manual gtm monitor soap(1)
NAME
soap - Configures a Simple Object Access Protocol (SOAP) monitor.
MODULE
gtm monitor
SYNTAX
Configure the soap component within the gtm monitor module using the
syntax in the following sections.
CREATE/MODIFY
create soap [name]
modify soap [name]
options:
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
expect-fault [no | yes]
ignore-down-response [enabled | disabled]
interval [integer]
method [string]
namespace [ [name] | none]
parameter-name [ [name] | none]
parameter-type [bool | int | long | [string] ]
parameter-value [none | [integer] | [string] ]
password [none | [password] ]
probe-timeout [integer]
protocol [[none] | [protocol] ]
return-type [bool | char | double | int | long | short | [string] ]
return-value [none | [integer] | [string] ]
soap-action [string]
timeout [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 running-config soap
show running-config soap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete soap [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the soap component to configure a custom monitor, or you
can use the default SOAP monitor that the Global Traffic Manager
provides. This type of monitor tests a Web service based on SOAP.
EXAMPLES
create soap my_soap defaults-from soap
Creates a monitor named my_soap that inherits values from the system
default SOAP monitor.
list soap
Displays the properties of all of the SOAP monitors.
OPTIONS
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.
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.
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 30 seconds.
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, and modify.
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 bool.
parameter-type
Specifies the parameter type. The default value is none.
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.
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.
protocol
Specifies the protocol that the monitor uses to communicate with
the target. The default value is none.
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.
timeout
Specifies the number of seconds the target has in which to respond
to the monitor request. The default value is 120 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.
username
Specifies the user name 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-2014. All rights reserved.
BIG-IP 2017-08-15 gtm monitor soap(1)