unregisterMonitor

Use the unregisterMonitor command to unregister the specified monitor from the sphere.

Use this command only when the monitor has been taken offline permanently. Monitors must be offline long enough for the system to mark them down before you can unregister them.

Unregistering a monitor agent has the following consequences:

  • Any monitored endpoints associated with the monitor will be unmonitored.

  • Measurements for unmonitored endpoints will be lost; use this command only when the monitor has been taken offline permanently.

Command Syntax

btmcli unregisterMonitor -baseAddress address  | -fn friendlyName
                         - s sphereUrl -l username:password
Name Long Name Description
-- -baseAddress The base address of the monitor in the sphere. For example,

http://localhost:8080/btmmonitor/agent/agent

-fn -friendlyName The friendly name of the monitor agent to unregister.

If the friendly name is not unique, you must use the -baseAddress option instead.

-s -sphereUrl The URL of the sphere where the WSDL is installed.

http://hostname:port/btmcentral/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 furnishing login credentials.

You can encrypt passwords using the encryptPassword command.


Example

The following example unregisters the monitor with the specified base address.

btmcli unregisterMonitor -base address
                               http://localhost:8080/btmmonitor/agent/agent 
              -s http://mydomain.com/btmcentral/sphere/ -l admin:abracadabra