listInstruments

Use the listInstruments command to list the instruments defined by the policy templates in the system, as well as the attribute names and segments for each. You can use this information as arguments for the retrieveObjectData command.

Command Syntax

btmcli listInstruments -s sphereUrl -l username:password

Name Long Name Description

-s

-sphereUrl

Name	Long Name	Description
-s	-sphereUrl	The URL of the sphere. 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.

The URL of the sphere.

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.

Sample Output

Here is some sample output for the listInstruments command.

Avg Response Time
   Attribute Name: averageResponseTime
   Description: The average amount of time a transaction requires to complete,
                 or a service/operation requires to respond.
   Segmented By: 
           operation
           containingManagedObjectId
           clientAddress
           clientName
           businessObjectId
            businessObjectKey
Faults
    Attribute Name: faultCount
    Description: The number of faults generated by a service or operation.
    Segmented By: 
         operation
         containingManagedObjectId
         clientAddress
         clientName
         faultCode
         businessObjectId
         businessObjectKey

Example

The following example shows the listInstruments command.

btmcli listInstruments -s http://localhost:8080/btmcentral/sphere/
                       -l admin:abracadabra