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/2.1.99-SNAPSHOT/users-guide/index.htm
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="67bf81d1-1ea6-4297-a14f-4068f42c8cae"><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="854549f9-effb-443f-a24b-3a5a41a1d6c5"><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="ebc4c397-51e6-441f-949b-dab80819218f"><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="3157a82f-d44a-480f-8ab3-faf7c3029b8b"><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="3149689e-0fa3-41af-8dd1-d59a611fdc08"><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="31683938-35f2-4eae-bff0-ee381acb40b5"><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="929686bc-c35a-41d7-8b65-83b6671fa8a4"><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="5772c83e-d523-484f-b529-718438040dbe"><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="8b702884-8d04-4f18-b312-7bb126c5df82"><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="80ab86a8-6579-40ae-a2e9-2364178f3de7"><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="9776cb1e-1bbe-424f-950f-779bda364fd4"><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="8ebcdc3b-1c33-4fa3-81d1-67fd3cc006de"><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="2dddee87-1fd1-4edb-abc4-f9aed299be53"><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="de1884b9-3a61-4f96-bd15-7dfe6b288634"><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="9730224e-d966-4098-9815-119615da9855"><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="9ef732a5-681d-403f-9669-eb14bf87aab8"><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="247e031f-5cbe-43ae-a175-e2fb72ad3f5f"><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="44db8a55-e2dd-46e6-a4e5-2766d5d05856"><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 |
|