Karaf's Commands
The Mantychore server uses a Karaf shell to manage the OSGi container and Fuse. To get information:
- Karaf shell - http://karaf.apache.org/
- Karaf user's guide - http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html
- Karaf complet list commands: https://cwiki.apache.org/KARAF/41-console-and-commands.html#4.1.ConsoleandCommands-OSGishell
OSGI Commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
||
---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5ac16441-9358-4ffc-83bf-f021741ba8e6"><ac:plain-text-body><![CDATA[ |
osgi:list |
list all installed bundles |
osgi:list [options] |
|
-s Shows the symbolic name |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c4ca9582-f0e7-45b0-88d7-4688f6194f43"><ac:plain-text-body><![CDATA[ |
osgi:ls |
list OSGi services |
osgi:ls [options] [ids] |
ids Show only services for the given bundle ids |
-u Shows services which are in use |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="976eb127-53a8-4370-949a-fb07208846f7"><ac:plain-text-body><![CDATA[ |
osgi:start |
Start bundle(s) |
osgi:start [options] ids |
ids The list of bundle IDs separated by white spaces |
--force Forces the command to execute |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4fbc0a97-6d13-4314-810c-1d20332910e3"><ac:plain-text-body><![CDATA[ |
osgi:stop |
Stop bundle(s) |
osgi:stop [options] ids |
ids The list of bundle IDs separated by white spaces |
--force Forces the command to execute |
]]></ac:plain-text-body></ac:structured-macro> |
Features Management Commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e39c8476-b77e-4a74-83b7-e508ca1a7e3b"><ac:plain-text-body><![CDATA[ |
features:list |
List all existing features available from the defined repositories. |
features:list [options] |
|
-i, --installed |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b2b3b06a-2b87-4896-bb5c-8e98390cab08"><ac:plain-text-body><![CDATA[ |
features:install |
Installs a feature with the specified name and version |
features:install [options] name [version] |
name |
-r, --no-auto-refresh |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b8339fdf-380d-47dc-aa33-9060c7f5430d"><ac:plain-text-body><![CDATA[ |
features:uninstall |
Uninstalls a feature with the specified name and version |
features:install [options] name [version] |
name |
|
Mantychore Commands
The Mantychore server have a custom commands implemented in order to configure the platform via console shell.
Nexus commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
||
---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ce3da022-12ff-412b-9b76-957959ab9a3e"><ac:plain-text-body><![CDATA[ |
nexus:platform |
Get platform details |
nexus:platform [options] |
|
|
]]></ac:plain-text-body></ac:structured-macro> |
Protocol commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4480c4f8-33b7-4933-b40f-e216629c8675"><ac:plain-text-body><![CDATA[ |
protocols:add |
Brings up a live connection from the pool with the given protocol if there is none. |
protocols:add [options] resourceType:resourceName protocol |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fd8af8f1-f75c-4982-a71a-53468641c28f"><ac:plain-text-body><![CDATA[ |
protocols:context |
Manipulates protocol contexts for used to create new sessions. Call without protocol to list. |
protocols:Context [options] resourceType:resourceName [protocol] [uri] |
resourceType:resourceName |
--remove, -r |
protocols:info |
Provide extended information on a protocol session. |
protocols:info [options] resourceType:resourceName sessionId |
resourceType:resourceName The device owning the session. |
|
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9d9b9357-1b6a-4466-ae9d-e25da256c9bd"><ac:plain-text-body><![CDATA[ |
protocols:list |
List devices to which we have a live protocol session. |
protocols:list [options] [resourceType:resourceName] |
resourceType:resourceName |
--protocols, -p |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b968b78d-4a26-46be-bda6-5e3ebd6cd9cd"><ac:plain-text-body><![CDATA[ |
protocols:purge |
Brings up a live connection from the pool with the given protocol if there is none. |
protocols:purge [options] [resourceType:resourceName] [seconds] |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f28570d1-b9b5-400f-b3d7-442a070cfd0f"><ac:plain-text-body><![CDATA[ |
protocols:remove |
Removes a live connection from the pool, closing it. |
protocols:remove [options] resourceType:resourceName [sessionId] |
resourceType:resourceName |
--all, -a |
Resource commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="568aa5d6-0146-49fd-8848-e5867a1204f7"><ac:plain-text-body><![CDATA[ |
resource:create |
Create one or more resources from a given descriptor |
resource:create [options] paths or urls |
paths or urls |
--profile, -p |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="409b5861-70b9-41c3-9760-8e950e8eb894"><ac:plain-text-body><![CDATA[ |
resource:export |
Export the descriptor of a resource to a file |
resource:export [options] resourceType:resourceName fileName |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f19e9305-062c-4d57-99bb-a27f2e0b5755"><ac:plain-text-body><![CDATA[ |
resource:info |
Provides extended information about one or more resources |
resource:info [options] resourceType:resourceName |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="73d71bd5-98e6-45a3-acbb-572353525433"><ac:plain-text-body><![CDATA[ |
resource:list |
List the resources in the platform |
resource:list [options] |
|
--type, -t |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a799a777-1c8b-4719-b1ea-8b14b9407645"><ac:plain-text-body><![CDATA[ |
resource:modify |
Modify one or more existing resources |
resource:modify [options] resourceType:resourceName path or url |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="af155e98-dde7-42b3-8307-86e33ed2321d"><ac:plain-text-body><![CDATA[ |
resource:remove |
Remove one or more resources from the platform |
resource:remove [options] resourceType:resourceName |
resourceType:resourceName |
|
resource:start |
Start one or more resources |
resource:start [options] resourceType:resourceName |
resourceType:resourceName |
|
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6da528dc-3355-4ee9-bea8-b9895f799729"><ac:plain-text-body><![CDATA[ |
resource:stop |
Stop one or more resources |
resource:stop [options] resourceType:resourceName |
resourceType:resourceName |
|
Profile commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="57a6031e-741b-4550-babd-1c3996c901dc"><ac:plain-text-body><![CDATA[ |
profile:info |
Provides extended information about one or more profiles |
profile:info [options] profile ids |
profile ids |
|
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2d11cb32-d918-4c5d-813b-0e0947855316"><ac:plain-text-body><![CDATA[ |
profile:list |
List all available profiles |
profile:list [options] |
|
|
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a85c9430-463a-412b-8881-0f4b50c7b882"><ac:plain-text-body><![CDATA[ |
profile:remove |
Remove a profile from available ones. |
profile:remove [options] profileName |
profileName |
|
Capability commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2aaf662b-81d6-4f07-9568-2ca12ebf4196"><ac:plain-text-body><![CDATA[ |
chassis:listInterfaces |
List all the interfaces of a given resource |
chasis:listInterfaces [options] resourceType:resourceName |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b815601a-7846-4101-80d2-26393b429780"><ac:plain-text-body><![CDATA[ |
chassis:setInterface |
Set a IP in a the interface of a given resource |
chasis:setInterface [options] resource type:name interface IP MASK |
resourceType:resourceName |
|