You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Karaf's Commands

The Mantychore server uses a Karaf shell to manage the OSGi container and Fuse. To get information:

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="778408de-73a1-489f-b4cd-7fa7d39bbb70"><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.


<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b3d77026-9474-4a47-8341-92e8f2d67b28"><ac:plain-text-body><![CDATA[

protocols:add [options] resourceType:resourceName protocol

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the session to create.

protocol
The protocol to use. This argument defines the factory and context used to create this session.

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0665c05f-539b-4fe1-abbf-403b4199f4bf"><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
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the context.

protocol
The protocol of the context

 uri
The URI passed to the protocol implementation of the context

  --remove, -r
 
Instead of adding a context, remove it for the named protocol.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="67b0c935-c3d6-4105-b994-18602e5779b8"><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:plain-text-body></ac:structured-macro>
 
sessionId
The session to lookup.

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3cf22772-f709-4072-b62c-01317128c64f"><ac:plain-text-body><![CDATA[

protocols:list

List devices to which we have a live protocol session.

protocols:list [options] [resourceType:resourceName]

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
If present, only connections to this device will be listed.

--protocols, -p
Print supported protocols.
  --verbose, -v
Do not only print list devices to which we have a live protocol session, print all connections information.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0e9646c2-e23c-41f4-b137-7098b83a5aa5"><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:plain-text-body></ac:structured-macro>
The resource owning the session to create.

Seconds
How old are the sessions to be destroyed.

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="959db3d3-6d72-4d05-80ae-b81770d967de"><ac:plain-text-body><![CDATA[

protocols:remove

Removes a live connection from the pool, closing it.

protocols:remove [options] resourceType:resourceName [sessionId]

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the session.
sessionId
The name of the session id that will be destroyed.

--all, -a
Remove all active sessions.

Resource commands

Profile commands

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5a7fd0b6-b09f-430e-ac69-9e125b38bc9c"><ac:plain-text-body><![CDATA[

profile:info

Provides extended information about one or more profiles

profile:info [options] profile ids

profile ids
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of profiles ids.

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d9ff70f1-d885-46c2-b8f6-d6eb3c31cd93"><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="0937853f-de9a-4e5c-91be-f34c9f452589"><ac:plain-text-body><![CDATA[

profile:remove

Remove a profile from available ones.

profile:remove [options] profileName

profileName
]]></ac:plain-text-body></ac:structured-macro>
The profile Id to be deleted

 

Capability commands

Chassis

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="52893462-a07c-4cfd-892f-f11ad898eabe"><ac:plain-text-body><![CDATA[

chassis:down

Down a physical interface

chassis:down [options] resourceType:resourceName interface

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource id to set the interface
interface
The name of the interface to be down

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="91c9304f-7ade-42fe-ad6c-814a561f459c"><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:plain-text-body></ac:structured-macro>
The resource id to set the interface
interface
The name of the interface to be setted
VLANid
The VLAN id

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f5d1a654-e858-4869-878c-6d73124834f6"><ac:plain-text-body><![CDATA[

chassis:showInterfaces

List all the interfaces of a given resource

chasis:showInterfaces [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource name to show the interfaces

--refresh, -r
Force to refresh the model with the last router configuration

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="eeae4cc1-7a16-462f-9c23-a38824f6275d"><ac:plain-text-body><![CDATA[

chassis:up

Up a physical interface

chassis:up [options] resourceType:resourceName interface

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource id to set the interface
interface
The name of the interface to be up

 

IPv4

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c463793c-b918-4494-a75c-73b27d4c6e80"><ac:plain-text-body><![CDATA[

ipv4:list

List all the interfaces of a given resource.

ipv4:list [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource name to show the interfaces

--refresh, -r
Force to refresh the model with the last router configuration

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="87408f6d-2b75-48c5-9de1-ad6495d4a50c"><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
]]></ac:plain-text-body></ac:structured-macro>
The resource id to set the interface
interface
The name of the interface to be setted
IP
A valid IPv4: x.x.x.x
MASK
A valid MASK IPv4: x.x.x.x

 

  • No labels