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="bf9f8394-5de9-4bc4-986b-7630d991018b"><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 |
|
---|---|---|---|---|---|
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="56c36bd9-1db3-4d7b-b9f2-4305e542d8e3"><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 |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cbb6f179-11b1-4d07-8958-8974764c97b2"><ac:plain-text-body><![CDATA[ |
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="161a347d-067d-4c6c-862b-4fc16078ea3b"><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="fc8e9c0c-1d12-464e-889e-82fbc29916c4"><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="573b96fe-0b96-4b71-b663-a648adbc6224"><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="29af0d77-4a2b-4f48-977c-cab98fb72849"><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="ddd87786-a7a9-43a9-b6ac-4c401313e5cc"><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="b1ff5dcb-f0c8-4729-a73d-cbc465bd8d60"><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="f63824d9-eb7c-4de0-9b34-06ac25c9f87d"><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="a2333237-8368-4aa0-8bb2-58287e589f8a"><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="c40fbaaf-7bb0-468b-8841-22e2a57433a1"><ac:plain-text-body><![CDATA[ |
resource:remove |
Remove one or more resources from the platform |
resource:remove [options] resourceType:resourceName |
resourceType:resourceName |
|
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2119a44e-9639-471e-9a13-b93f92c2cd56"><ac:plain-text-body><![CDATA[ |
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="a0e7b8c5-8bcc-4234-aa5e-2d69f1a5d583"><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="27dd37fb-8aa2-498a-b2de-910129ea37df"><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="709fe7a6-994b-4b23-822d-fb2ee78d38ae"><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="8a37a0fb-a5b9-4e7d-8e68-122781504afe"><ac:plain-text-body><![CDATA[ |
profile:remove |
Remove a profile from available ones. |
profile:remove [options] profileName |
profileName |
|
Capability commands
Chassis
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c833138f-f966-45e6-93b4-922358c0cccc"><ac:plain-text-body><![CDATA[ |
chassis:down |
Down a physical interface |
chassis:down [options] resourceType:resourceName interface |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6dc9db53-6cf3-4430-93e0-0643c092ebaf"><ac:plain-text-body><![CDATA[ |
chassis:setVLAN |
Set a VLAN id in a given interface. |
chassis:setVLAN [options] resourceType:resourceName interface VLANid |
resourceType:resourceName |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1c920e66-e3e8-4be9-8783-46586a0893ed"><ac:plain-text-body><![CDATA[ |
chassis:showInterfaces |
List all the interfaces of a given resource |
chasis:showInterfaces [options] resourceType:resourceName |
resourceType:resourceName |
--refresh, -r |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8a9ac1d2-2591-46b1-91d3-eea5e3ea43c4"><ac:plain-text-body><![CDATA[ |
chassis:up |
Up a physical interface |
chassis:up [options] resourceType:resourceName interface |
resourceType:resourceName |
|
|
|
|
|
|
|
chassis:up |
|
|
|
|
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f42f09cf-78a4-491e-bac4-188962598dae"><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 |
|
chassis:setVLAN |
Set a VLAN id in a given interface. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
IPv4
|
|
|
---|---|---|
|
|
|
|
|
|
|
|
|