Page History

Karaf

...

shell

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

The shell is local to the server (although it can be configured to be acceded remotely) and is the primary interface to administer OpenNaaS.

It supports scripting, among many other interesting features you would like to take advantage of, for sure

To get more information about karaf itself:

• Karaf shell - http://karaf.apache.org/
• Karaf user's guide - http://karaf.apache.org/manual/latest-2.12.99-SNAPSHOTx/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

Protocol commands

...

COMMAND

...

DESCRIPTION

...

SYNTAX

...

ARGUMENTS

...

OPTIONS

...

protocols:add

...

protocols:add [options] resourceType:resourceName protocol

...

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7178cef1-494f-4de6-87b9-b86b5619fa9f"><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]

...

• html
• Karaf complete list commands: https://cwiki.apache.org/KARAF/41-console-and-commands.html#4.1.ConsoleandCommands-OSGishell&nbsp;

CLI commands

Karaf command line console offers a set of pre-defined commands to manage osgi bundles and features, but it has been extended by exporting other customized commands required to operate OpenNaaS.

Each command has a namespace and a command name. The way to invoke them is as follows:

>namespace:commandname [options] arguments

As a quick reference, each OpenNaaS module exports commands required to interact with it. Namespaces are used to identify the context of a command or, more precisely, the component it comes from. In this manner, ResourceManager defines the "resources" namespace, ProtocolSessionManager the "protocols" one, and so on. Each capability defines a namespace that identifies its functionality, too.

The list of all available commands (and its namespaces) is accessible by pressing "tab" key twice form a clean prompt:

>[tab tab]
>Display all 341 possibilities? (y or n)

For a description of the commands, each one has a "--help" option that describes the command syntax, its semantics and how to invoke it, enumerating required arguments and available options. An example of this option output is shown just below:

>resource:list --help
DESCRIPTION
        resource:list

    List all resources in the platform

SYNTAX
        resource:list [options]

OPTIONS
        --help
                Display this help message
        --all, -a
                Extensive version 
        --type, -t
                Specifies the type of resources to list (if specified, only resources of this type will be listed)

If you are having problems using the shell, please refer to Getting Support section.

...

  --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="8d8bf326-04db-49d4-b010-42bb277b5c64"><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="90153597-beec-46eb-8bab-cffa76d2649a"><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="7086bd39-0d7f-4d22-9344-daf953125229"><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]

...

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="71cec3e3-8a8d-4cc8-adf8-fd5811d25657"><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

Capability commands

Chassis

IPv4

...

...

...

...

...

...

...

...

...

...

...