Karaf shell
OpenNaaS server uses a Karaf shell to manage Fuse and the OSGi container.
This command line console provides commands to manage osgi bundles and features, and can also be extended with custom commands.
To get more information about karaf itself:
- Karaf shell - http://karaf.apache.org/
- Karaf user's guide - http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html
- Karaf complete list commands: https://cwiki.apache.org/KARAF/41-console-and-commands.html#4.1.ConsoleandCommands-OSGishell
OpenNaaS extends this shell with customized commands, providing the user with access to all components required to operate OpenNaaS.
CLI commands
As stated before, this shell 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 and the way to invoke it is as follows:
| No Format |
|---|
>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:
| No Format |
|---|
>[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 semantic, and how to invoke it, enumerating required arguments and available options. A sample of this option output is shown just below:
| No Format |
|---|
>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.
More information about these commands is available at OpenNaaS CLI section.