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="74fa3152-c5a5-497f-b4f8-b48365d5c96f"><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="fe090684-5f49-4a1d-bd25-49fa80c4de0b"><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="00eb4d4f-b22a-4324-bda5-2f98bcbd84f3"><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="e75b6022-a552-4e80-953b-7debfdda7676"><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="6a9f05c8-1a48-4d23-bf4d-27d8b3534d7c"><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="68bae4c7-e9b7-4014-b1fe-94a1bbf0d3af"><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
Profile commands
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
||
---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="80eb9acb-40b0-4519-986e-9dd3e1180138"><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="ea119d6a-001e-47ec-b5f9-771731fae1d8"><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="f4b8112e-9db4-44d8-a38a-3d432ba9aa30"><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="70e6a9d9-cdf8-4a58-a7e2-90619a19fce1"><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="86bf78dd-c543-4018-a66b-56ce243b3e3a"><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="8a38b0ed-e846-4f1d-bd4f-1daf8f603a5e"><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="7d92a461-9537-4260-b4ba-4904869d7576"><ac:plain-text-body><![CDATA[ |
chassis:up |
Up a physical interface |
chassis:up [options] resourceType:resourceName interface |
resourceType:resourceName |
|
IPv4
COMMAND |
DESCRIPTION |
SYNTAX |
ARGUMENTS |
OPTIONS |
|
---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3beb895d-71aa-4242-a2f4-c2ab73b16b0d"><ac:plain-text-body><![CDATA[ |
ipv4:list |
List all the interfaces of a given resource. |
ipv4:list [options] resourceType:resourceName |
resourceType:resourceName |
--refresh, -r |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8a219c94-daca-4843-8fd3-0be435b80df9"><ac:plain-text-body><![CDATA[ |
ipv4:setIP |
Set a IP in a given interface of a resource |
ipv4:setIP [options] resourceType:resourceName interface ip mask |
resourceType:resourceName |
|