Apache Gogo Shell Commands Description

lb

Display list of bundles installed in OSGi module framework

lb | grep <BUNDLE_MATCH_PATTERN>

List of bundles with filter using grep command and you can pass any string or valid regex pattern.

bundle <BUNDLE_ID>

Print specific bundle information. It required bundle Id as parameter

headers <BUNDLE_ID>

Print all OSGi headers which is used by specified bundle. These headers are in MANIFEST.MF file. It is required bundle Id as parameter.

install [URI_JAR_FILE_PATH]

Install bundle into OSGi container and we need to specify the valid URI path.

start [BUNDLE_ID]

Command will start bundle and it is required bundle Id.

stop [BUNDLE_ID]

Command will stop bundle and it is required bundle Id.

uninstall [BUNDLE_ID]

Uninstall bundle and it required bundle Id.

inspect requirement service [BUNDLE_ID]

List all services required by bundle. Require-Capability header is in MANIFEST.MF file is relevant to this command.

inspect capability service [BUNDLE_ID]

List all services provided by bundle. Provide-Capability header is in MANIFEST.MF file is related to this command.

diag [BUNDLE_ID]

Command will print unsatisfied constraints to specific bundle and its required bundle Id.

upgrade:check

Command will display all Upgrade Step Process Steps registered in the registry.

system:check

Command will show all unsatisfied components list along with Gogo shell commands to troubleshoot in detail. It will run Declarative Service Soft Circular Dependency Checker, Declarative Service Unsatisfied Component Checker, Spring Extender Unavailable Component Checker

history

history will print all commands used in the current session. It is similar to Unix/Linux history command.

help

It will show all available commands and its description.

services

Command will print all registered service components available in the OSGi module framework.

services grep [SEARCH-PATTERN]

Command will print all registered service components available in the OSGi module framework with filter. It will narrow down the list.

ds:unsatisfied

Command will display all unsatisfied service component list in the OSGi module framework.

ds:unsatisfied [BUNDLE_ID]

Command will display unsatisfied service components to specified bundle. It’s required bundle Id

scr:info [COMPONENT_ID]

Command will print detailed information of given component. It required the component Id and we can get component Id when we use services/ ds:unsatisfied commands.

scr:list

It will display all components registered in service registry.

scr:list | grep [SEARCH-PATTERN]

It will display matching components registered in service registry.

dm

List all dependency manager components and these are mostly service builder service components from Liferay OSGi Module Framework.

dm OR grep [SEARCH-PATTERN]

List all matching dependency manager components and these are mostly service builder service components from Liferay OSGi Module Framework.

dm cp OR  dm compact

Display components in compact from.

dm nd OR dm nodeps

Command will display only components and it is hiding dependencies of the component.

dm na OR dm notavail

It will print only not available dependency components. It is very useful when we troubleshoot unsatisfied service builder components.

dm wtf

Detects where are the root failures for components. This is also most useful command to troubleshoot service builder components

Example Usage of Commands

lb lb | grep student bundle 1076 headers 1076 install "file:C://Liferay/Liferay7.2/student-web/target/student-web-1.0.0.jar" start 1076 stop 1076 uninstall 1076 inspect requirement service 1076 inspect capability service 1076 diag 1076 upgrade:check system:check history help services services | grep student ds:unsatisfied ds:unsatisfied 1075 scr:info 4884 scr:list scr:list | grep student dm dm | grep student dm cp dm nd dm na dm wtf

Author

Meera Prince

Liferay Contributor of the Year 2016
Liferay Top Contributor Award Winner 2015

Liferay Contributor of the Year 2014

Liferay Top Contributor Award Winner 2013

http://www.liferaysavvy.com