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="2979e512-3ba8-4130-90de-56a0521fe5cc"><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="0d569afd-e864-46c8-a227-9a2351cddcc7"><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="baf70d1c-652d-4d2e-bd9d-2b35459e7e60"><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="a80b5788-5dd3-4cce-9136-b4efbbdcf4fe"><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="02114de6-ef1a-419d-bf4f-9cc66f3f3e43"><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="3bc224f7-07ab-4d3b-a893-2b951351919b"><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="fe0a96d7-c17b-4559-98b8-af2f15224dae"><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="c9b0da3e-54d7-4899-94b0-7d2978e49a47"><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="6b24d93f-8cc0-4c74-9848-dfb8ed4de7b2"><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="3334f22c-ed6a-4980-897d-f6286ef13262"><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="a9e374a4-e5ee-41f6-80e2-9eff8aec0836"><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="55f655df-e037-4d03-8213-eda8a9fd9282"><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="86b0c797-4b34-497c-8344-ee676d59d3c0"><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="4c30bc34-ae39-447f-b5c1-05be156fa73e"><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="26cf86a5-1cdc-426c-999b-1257e867ae72"><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="b1cd4c51-611a-4f51-ae35-4494acdb8a87"><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="77c9d20a-e6c5-4d54-b467-cafc0c939676"><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="b6dec07d-015d-42a0-a602-d72ed347d83c"><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="37b9e1f4-aadc-4b3f-92cd-5f60a5c48d7b"><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="453dfdec-8594-4d38-ac7d-be25e9312d26"><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="35bcf048-f5de-4a88-8d2e-98c4c0ef4bae"><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="5be31fb3-42e9-4330-856e-e022aa7fc8a9"><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="6632878e-e543-44ae-a306-561d05291ae8"><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="87b5e8c3-3ecc-4065-b45d-3bf33d279de1"><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="48b033a1-d5d7-41b6-9acf-69b80525f621"><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 |
|