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="e5762e74-90bd-4b4a-8c00-4590295ff1c9"><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="6f4f3a30-60a0-42ec-a490-bd548ca35757"><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="b69a0cc0-5580-4091-9dfa-c51e4a286eab"><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="20964e87-b824-4194-b798-3fe3e1cfcc24"><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="f48efc56-a3f9-4136-be64-fa770cda34a5"><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="ff337876-4213-4903-9a51-8c8692f89730"><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="02f0bb88-c7e9-4c33-81dd-bde02360ea33"><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="65a4cf8f-ffd6-4a41-ad9e-32bc9c49ec1a"><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="6a47a11d-2f5b-4236-8c39-ea8f5df6097f"><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="0b04bded-321b-4e17-9911-0d07337236a8"><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="aa242938-8557-4527-8851-8999ebad60ff"><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="d33b4cb4-add7-4cbe-9d3f-372f3d357678"><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="d31cd76e-b573-4225-a892-64a6ddaeb69e"><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="d3d0f640-c179-4695-8a8c-b8febf8c6f81"><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="e59ff584-e0da-4c0d-8fc8-267d34ce47db"><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 |
|