Use the configureAlivenessCheck command to specify whether the sphere checks the aliveness of containers or endpoints and the preferred method for doing so.

Command Syntax

btmcli configureAlivenessCheck -baseAddress baseAddress | -e epUrl1 [[epUrl2]...]
                               -method standard | skip | getwsdl |geturl | ping
                               [-alternateUrl alternateUrl]
                               [-endpointDreds username:password]
                               [-pingHostPort host:port]
                               -s sphereUrl -l username:password
Name Long Name Description
-baseAddress -- The base address for which to configure aliveness check. The effect of this flag depends on the setting of the -method flag:

If -method is set to standard, geturl, or ping, the base address is tested only once and all endpoints under this base address inherit its aliveness value.

If -method is set to getwsdl, each endpoint with the specified base address has its WSDL fetched.

If -method is set to skip, no aliveness checking is performed for this base address, but endpoints with this base address might be checked individually if specified with the -e or -alternateUrl flags.

-e -endpointUrl One or more endpoint URLs for which to configure aliveness checking. All endpoints with the given URLs are configured identically.
-method -- The method to be used for aliveness checking. Choose one of the following: standard: open and close a socket to the given host:port

skip: do not check aliveness

getwsdl: do an HTTP GET on the endpoint's WSDL

geturl: do an HTTP GET on the given url

ping: do a TCP ping on the host and port specified with the -pingHostPort flag.

See below for more details.

-alternateUrl -- The URL to use in place of the base address or endpoint URL. This flag is required when the geturl method is used.
-endpointCreds -- Authentication credentials (username:password) to use when fetching the alternate URL for an endpoint. It is ignored for any other configuration.
-pingHostPort -- The host and port to ping in place of the actual base address of the endpoint URL. This flag is required only when the method ping is specified.
-s -sphereUrl The URL of the sphere.


This flag is not required if you have set the AP_SPHERE_URL environment variable for your sphere.

-l -userLogin The username and password associated with the sphere, in the format: username:password. This set of credentials must belong to a user in the btmadmin role.

See Security Options in Accessing CLI Commands for information on the various options available for furnishing login credentials.

You can encrypt passwords using the encryptPassword command.

Choose the method that best suits the endpoint you are monitoring. For example, for WebLogic JAX_RPC or JAX-WS services, fetching the generated WSDL will succeed if the container is up and the service is deployed and running, so it is as good an aliveness check as actually calling the service without the inconvenience of having a sample message to send that is both valid and harmless. The advantage of the getwsdl method compared to the arbitrary http fetch (geturl) is that you can specify it at the base address level and get the effect of configuring the aliveness check for every endpoint in that base address to fetch its own wsdl without running a separate configureAlivenessCheck command for each of them. However, there are possible disadvantages:

  • loss of efficiency (WSDL may be large and generating it resource-intensive)

  • inappropriate for endpoints registered from a copy of the WSDL that was hand-created and/or copied from another server, since you are then checking the aliveness of that HTTP server instead of the endpoint

  • inappropriate for observer-discovered endpoints whose WSDL is saved as text in the sphere, since you are then checking the aliveness of the sphere.


The following example shows the configureAlivenessCheck command with the getwsdl method for performing the aliveness check.

btmcli configureAlivenessCheck -baseAddress http://jbujesPC:8080 -method getwsdl
                  -s http://localhost:8080/btmcentral/sphere/ -l admin:abracadabra