OSGi Commands

You can run commands to gather data about running AppNodes and applications.

Command Reference

  • To view all commands, use 

    curl -v http://localhost:8090/bw/framework.json/osgi?command=help

  • To view command syntax, use 
    curl -v http://localhost:8090/bw/framework.json/osgi?command=help%20<command_name>
    For example, 
    curl -v http://localhost:8090/bw/framework.json/osgi?command=help%20pauseapp

The following table lists some of the commands.

OSGi Commands
Command Description Options Scope Parameters Flags Usage
dsr Diagnoses Shared Resource issues. - bw String: Partial or full name of a Shared Resource. Case is ignored. - osgi "dsr" OR osgi "dsr <id>" OR osgi "dsr <name>"
geticon

  • Test for availability of all the ActiveMatrix BusinessWorks Activity Icons with a given ID.

  • Test for availability of an ActiveMatrix BusinessWorks Activity Icon with a given ID and type.

  • Test for availability of an ActiveMatrix BusinessWorks Activity Icon.

- bw

  • String

  • String : id
    String : type

 - For activity type, use osgi "lat" command.
osgi "geticon activityid"
lais Retrieves statistics of activities that have been executed in the process(es) for the application.

-p, --process
Name of the process. [optional]

-v, --version
Version of the application. [optional]

 bw String: Name of the application - osgi "lais continuousTimer.application"
lapi

Retrieves information about process instances of the application.

-o, --output
File path to export output in CSV format. [optional]

-p, --process
Name of the process. [optional]

-s, --state
State of the process instance to be filtered. (Currently the possible values to filter based on process instance state are [SUSPENDED, ACTIVE, ALL].) [optional]

-v, --version
Version of the application. [optional]

 bw String: Name of the application
(use * instead of application name to list process instances of all the applications)		 - osgi "lapi continuousTimer.application"
lapis Prints summary of active process instances. - bw String: ProcessInstance ID - osgi "lapis 1ef60fb4-29b-4db1-b0ec-cdce681254ee"
las Lists all instantiated activities. - bw - - osgi "las"
lat Lists all registered activity types. - bw - - osgi "lat"
lbwes Lists all subscribers that are currently listening to ActiveMatrix BusinessWorks statistics events. - bw - - osgi "lbwes"
le Prints information about ActiveMatrix BusinessWorks engines. - bw - - osgi "le"
lec Prints information about ActiveMatrix BusinessWorks engine configurations. - bw - - osgi "lec"
lendpoints Lists endpoints exposed by the ActiveMatrix BusinessWorks engine.

-a, --app
Name of the application. [optional]

-t, --type
Endpoint Type [optional]

 bw - - osgi "lendpoints"
les Lists all instantiated EventSources. - bw - - osgi "les"
lmetrics Prints job metrics for application(s) running on the AppNode.

-a, --app
Name of the application. [optional]

-v, --version
Version of the application. [optional]

 bw - - osgi "lmetrics"
lpis Prints statistics of process(es) that have been executed for the application.

-p, --process
Name of the process [optional]

-v, --version
Version of the application [optional]

 bw String: Name of the application - osgi "lpis continuousTimer.application"
lr
  • Lists all resources.

  • Lists all resource details.

long
Shared Resource ID		 bw - - osgi "lr"
lrhandlers Lists all resource handlers. - bw - - osgi "lrhandlers"
lrproxies Lists all resource proxies. - bw - - osgi "lrproxies"
startesc Starts collection of execution statistics for a given entity (activity/process) for application(s).

-a, --app
Name of the application [optional]

-v, --version
Version of the application [optional]

 bw String: (Activity Name/Process Name) - osgi "startesc activity | startesc Process"
stopesc Stops collection of execution statistics for a given entity (activity/process) for application(s).

-a, --app

Name of the application [optional]

-v, --version
Version of the application [optional]

 bw String: (Activity Name/Process Name) - osgi "stopesc activity | stopesc Process"
startpsc Starts collection of process statistics for application(s).

-a, --app
Name of the application [optional]

-v, --version
Version of the application [optional]

 bw - - osgi "startpsc"
stoppsc Stops collection of process statistics for application(s).

-a, --app

Name of the application [optional]

-v, --version
Version of the application [optional]

 bw - - osgi "stoppsc"
appnodeprocessinfo Prints information about the AppNode system processes. - frwk - - osgi "appnodeprocessinfo"
dc Delete a configuration with a given PID. - frwk String: PID of the configuration - osgi "dc <process id>"
getcompdetail Get the detail of a specific component of an ActiveMatrix BusinessWorks application. -v, --version
Version of the application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application

String: Name of the Component

 - osgi "getcompdetail tibco.bw.sample.binding.rest.Basic.application Componentbooks"
getcomps Get the list of components of an ActiveMatrix BusinessWorks application. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "getcomps tibco.bw.sample.binding.rest.Basic.application"
la Print information about all applications. - frwk - - osgi "la"
lap Print all application properties. - frwk - - osgi "lap"
lb
  • List all installed bundles.
  • List installed bundles matching a substring.
- frwk String: Substring matched against name or symbolic name

  • -l, --location show location

  • -s,
    --symbolicname show symbolic name

  • -u,
    --updatelocation show update location

 osgi "lb"
lcfg Print all CAS configuration details. - frwk String: Filter expression - osgi "lcfg"
lp Print information about all known ActiveMatrix BusinessWorks processes. - frwk - - osgi "lp"
ll Print information about all libraries. - frwk - - osgi "ll"
lloggers Print all loggers currently configured on the AppNode. - frwk - - osgi "lloggers"
pauseapp Stop the process starters and their bindings. Also pause all jobs of the ActiveMatrix BusinessWorks application. -v, --version
Version of the application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "pauseapp tibco.bw.sample.binding.rest.Basic.application"
resumeapp Start the process starters and their bindings. Also resume all jobs of the ActiveMatrix BusinessWorks application. -v, --version
Version of the application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "resumeapp tibco.bw.sample.binding.rest.Basic.application"
resumepi Resumes the process instances for specified process instance ids. - frwk String: ActiveMatrix BusinessWorks generated process instance id or list of ids separated by comma. For example, resumepi p_id1,p_id2. - osgi " resumepi p_id1,p_id2"
setloglevel Sets the log level for a given logger. -l, --level
Log level to set. The valid values are {Trace, Debug, Info, Error, Warn}. If not provided, log level is set to parent log level. [optional]		 frwk String : Name of the Logger - osgi "setloglevel ROOT -l DEBUG"
startcomps Start all process starters and their bindings of the ActiveMatrix BusinessWorks application. -v, --version
Version of the application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "startcomps tibco.bw.sample.binding.rest.Basic.application"
startps Start the process starters of the ActiveMatrix BusinessWorks application. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "startps tibco.bw.sample.binding.rest.Basic.application"
stopps Stop the process starters of the ActiveMatrix BusinessWorks application. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "stopps tibco.bw.sample.binding.rest.Basic.application"
startapp Start an ActiveMatrix BusinessWorks application gracefully. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application - osgi "start tibco.bw.sample.binding.rest.Basic.application"
stopapp Stop an ActiveMatrix BusinessWorks application gracefully. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk String: Name of the Application

-g, --graceful

If set causes the application to shutdown gracefully.

 osgi "stopapp tibco.bw.sample.binding.rest.Basic.application"
startcomp Start the specific component of an ActiveMatrix BusinessWorks application. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk

String: Name of the Application

String: Name of the Component

 - osgi "startcomp tibco.bw.sample.binding.rest.Basic.application Componentbooks"
stopcomp Stop the specific component of an ActiveMatrix BusinessWorks application. -v, --version
Version of the Application. If omitted, all versions are affected. [optional]		 frwk

String: Name of the Application

String: Name of the Component

 - osgi "stopcomp tibco.bw.sample.binding.rest.Basic.application Componentbooks"
suspendpi Suspends the process instances for specified process instance ids. - frwk String : ActiveMatrix BusinessWorks generated process instance id or list of ids separated by comma. For example, suspendpi p_id1,p_id2. - osgi "suspendpi p_id1,p_id2"
td Print a full thread dump. - frwk - - osgi "td"
type - - gogo String [] - -
clean Removes caches for the bundle with the given id. - wsdl String - wsdl:clean 5
clean Removes caches for all known bundles. - wsdl - - wsdl:clean
collisions Lists collisions for given bundle id. - wsdl String - wsdl:collisions 5
collisions Lists collisions across all projects. - wsdl - - wsdl:collisions
elem Locates element declarations with the given local name across all projects. - wsdl String - wsdl:elem testname
elem Locates element declarations across all projects. - wsdl - - wsdl:elem
elemLoc Locates element declarations with the schemaComponentCache for the wsdl at the provided location. - wsdl String - wsdl:elemLoc location
errors Prints error messages for specified bundle id. - wsdl long - wsdl:errors 7
errors Prints error messages for all bundles. - wsdl - - wsdl:errors
ids Prints bundle IDs of all bundles with component caches. - wsdl - - wsdl:ids
imports Shows basic info such as locations, targetNamespaces, and imports. - wsdl - - wsdl:imports
imports Shows information related to imports for a given bundle ID. - wsdl long - wsdl:imports 12
load Loads resources for all known bundles. - wsdl - - wsdl:load
load Loads resources for the bundle with the given ID. - wsdl String - wsdl:load 1
locations Lists the locations for a given namespace. - wsdl String - wsdl:locations namespace
locations Prints the locations across all bundles. - wsdl - - wsdl:locations
ns Prints the namespaces for the given bundle ID. - wsdl String - wsdl:ns 12
ns Prints namespaces for all bundles. - wsdl - - wsdl:ns
nsLoc Prints "ns" in the ModuleCache for each WSDL location. - wsdl - - wsdl:nsLoc
type Locates type definitions with the given local name across all projects. - wsdl String - wsdl:type testlocalname
types Lists all type definitions for a specified project. - wsdl long - wsdl:types 5
types Lists all type definitions across all projects. - wsdl - - wsdl:types
typeLoc Prints type declarations with the schemaComponentCache for the wsdl at the provided location. - wsdl String - wsdl:typeLoc location
wires Prints cache dependencies (as bundle IDs) for the given bundle ID. - wsdl String - xsd:wires 5
att Locates attribute declarations with the given local name across all projects. - xsd String - xsd:att testlocalname
atts Lists all attribute declarations for a specified bundle. - xsd long - xsd:atts 5
atts Lists all attribute declarations across all projects. - xsd - - xsd:atts

clean

Removes caches for the bundle with the given ID. - xsd String - xsd:string 5
clean Removes caches for all known bundles. - xsd - - xsd:clean
collisions Lists collisions for a given bundle ID. - xsd String - xsd:collisions 5
collisions Lists collisions across all projects. - xsd - - xsd:collisions
elem Locates element declarations with the given local name across all projects. - xsd - - xsd:elem testname
elem Locates element declarations with the given local name across all projects. - xsd String - xsd:elem
elemLoc Locates element declarations with the schemaComponentCache for the schema at the provided location. - xsd String - wsdl:elemLoc location
elemLoc Locates element declarations with the schemaComponentCache for the schema at the provided location. - xsd String

String

 - xsd:elemLoc location elemName
elemNs Locates element declarations with the given targetNamespace. - xsd String - xsd:elemNs namespace
elemNsEmpty Locates element declarations with empty string targetNs. - xsd - - xsd:elemNsEmpty
elemNsNull Locates element declarations with null targetNs. - xsd - - xsd:elemNsNull
elemsNullLocEmptyNs Locates all element declarations with the null location and empty "tns". - xsd - - xsd:elemsNullLocEmptyNs
elemsNullLocNullNs Locates all element declarations with the null location and null "tns". - xsd - - xsd:elemsNullLocNullNs
errors Prints error messages for a specified bundle ID. - xsd long - xsd:errors 5
errors Prints error messages for all the bundles. - xsd - - xsd:errors
errorsLoc Prints error messages for a specified location. - xsd String - xsd:errorsLoc location
errorsNs Prints error messages for a specified namespace. - xsd String - xsd:errorNs namespace
ids Prints bundle IDs of all the bundles with component caches. - xsd - - xsd:ids
imports Shows basic information such as locations, targetNamespaces, and imports. - xsd - - xsd:imports
imports Shows information related to imports for a given bundle ID. - xsd long - xsd:imports 12
load Loads resources for all known bundles. - xsd - - xsd:load
load Loads resources for the bundle with the given ID. - xsd String - xsd:load 1
locations Prints xsd locations across all bundles. - xsd - - xsd:locations
locations Lists locations for a given namespace. - xsd String - xsd:locations namespace
mg Locates specific named model group declaration. - xsd String - xsd:mg name
mg Locates all named model group declarations. - xsd - - xsd:mg
ns Prints namespaces for the given bundle ID. - xsd String - xsd:ns 12
ns Prints namespaces for all bundles. - xsd - - xsd:ns
nsLoc Prints namespaces in the ModuleCache for each WSDL location. - xsd - - xsd:nsLoc
type Locates type definitions with the given local name across all projects. - xsd String - xsd:type testlocalname
types Lists all type definitions for specified projects. - xsd long - xsd:types 30
types Lists all type definitions across all projects. - xsd - - xsd:types
typeLoc Prints type declarations with the schemaComponentCache for the xsd at the provided location. - xsd String - xsd:typeLoc location
wires Prints cache dependencies (as bundle IDs) for all bundles. - xsd - - xsd:wires

Note: To run some of the statistics retrieval commands such as lapi, you must first run the startpsc statistics activation command.