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="e96270f2-340b-45a4-a4bb-ec57ce5fff54"><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="94ae1044-6cef-431b-a30e-deb4c08ecaae"><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="776f3068-675b-4b32-8cff-6c192ffffbd6"><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="7d0f6163-2e97-4615-bcbb-ab375a680e6e"><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="43737d21-1a04-4c2b-a382-45ab91ad9f79"><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="1da03d60-3aba-4c20-bd68-646806560701"><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="969d2e2e-5abb-47a1-ab06-2600538b75c9"><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="a5a2ed7c-e3a4-40ef-999a-9a214e2f6877"><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="d4c16671-163b-486d-9c45-ae60025097b0"><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="2cbcd458-6993-49c1-8757-c722f39ad6ef"><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="837a65ee-2e28-4e5b-b884-494ef62fb6ce"><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="d1071835-e258-4b01-ba1d-7eabb5f92726"><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="96e9430f-d55f-45e8-b4c7-79187aeac2eb"><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="b5518fa3-ff4e-4779-8dd4-76ea844af6f0"><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="525311a6-5aef-405e-94c8-a3b00d879178"><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="515fe649-f453-4a66-b2e7-0ef0e2dd6c3e"><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="50624cf5-0605-47c0-bdc0-f1cab1db2702"><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="c4f329cb-9cc8-483a-bd64-17e6b4dcfc0f"><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="cc2fbd7f-8bdb-4249-b1da-9abf53cd63cc"><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="b04f1227-7f8d-42f2-8c01-2db37df6e6fc"><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="d1e56766-9d97-4361-98a4-14298c8e776e"><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="c51dc65b-2b59-4313-a59e-cf68d8224c93"><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="3f647560-a3a5-493c-b783-eb9318e125f4"><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="0e683644-ea48-4a7e-b88d-447f34de7cab"><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="d22ea2b9-aecc-4a40-b1c8-11ee097f38a9"><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 |
|