Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Karaf's Commands

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

...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

features:list

List all existing features available from the defined repositories.

features:list [options]

 

-i, --installed
Display a list of all installed only

features:install

Installs a feature with the specified name and version

features:install [options] name [version]

name
The name of the feature
version
The version of the feature

-r, --no-auto-refresh
Do not automatically refresh bundles
-c, --no-clean
Do not uninstall bundles on failure

features:uninstall

Uninstalls a feature with the specified name and version

features:install name [version]

name 
The name of the feature
version 
The version of the feature

 

...

OpenNaaS Commands

The Mantychore OpenNaaS server have a custom commands implemented in order to configure the platform via console shell.

...

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 resourceType:resourceName protocol

resourceType:resourceName
The resource owning the session to create.

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

 

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
The resource owning the context.

protocol
The protocol of the context  uri

authenticationType
The type of authentication used
[password - publickey]

uri
The URI passed to the protocol implementation of the context

privateKeyPath
Path of the private key to be used.

keyPassphrase
Passphrase of the private key file.

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

protocols:info
 

Provide extended information on a protocol session.

protocols:info resourceType:resourceName sessionId

resourceType:resourceName The device owning the session.
 
sessionId
The session to lookup.

 

protocols:list

List devices to which we have a live protocol session.

protocols:list [options] [resourceType:resourceName]

resourceType:resourceName
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.

protocols:purge

Brings up a live connection from the pool with the given protocol if there is none.

protocols:purge [resourceType:resourceName] [seconds]

resourceType:resourceName
The resource owning the session to create.

Seconds
How old are the sessions to be destroyed.

 

protocols:remove

Removes a live connection from the pool, closing it.

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

resourceType:resourceName
The resource owning the session.
sessionId
The name of the session id that will be destroyed.

--all, -a
Remove all active sessions.

Description

In MantychoreOpenNaaS, each resource needs to have linked a protocol to can communicate with the physical device which it virtualises. These list of commands are responsible to save in the Mantychore OpenNaaS software which type of connection are linked to some resource. For this reason, it exists the protocol commands, protocols:context links these connection parameters. Also, in order to reuse these protocols in other resources, you can use protocols:add. Finally, for the protocol management, it exists: protocols:list, protocols:remove, protocols:info, etc...

...