Server Console

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/latest-2.2.x/users-guide/index.html
Karaf complet list commands: https://cwiki.apache.org/KARAF/41-console-and-commands.html#4.1.ConsoleandCommands-OSGishell

OSGI Commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
osgi:list	list all installed bundles	osgi:list [options]		-s Shows the symbolic name -l Show the locations -u Shows the update locations
osgi:ls	list OSGi services	osgi:ls [options] [ids]	ids Show only services for the given bundle ids	-u Shows services which are in use -a Shows all services
osgi:start	Start bundle(s)	osgi:start [options] ids	ids The list of bundle IDs separated by white spaces	--force Forces the command to execute
osgi:stop	Stop bundle(s)	osgi:stop [options] ids	ids The list of bundle IDs separated by white spaces	--force Forces the command to execute

Features Management Commands

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

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
nexus:platform	Get platform details	nexus:platform

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 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 The URI passed to the protocol implementation of the context	--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 Mantychore, 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 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...

Resource commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
resource:create	Create one or more resources from a given descriptor	resource:create [options] paths or urls	paths or urls A space delimited list of file paths or urls to resource descriptors	--profile, -p Allows explicit declaration of profile to be used
resource:export	Export the descriptor of a resource to a file	resource:export resourceType:resourceName fileName	resourceType:resourceName The resource whose descriptor is going to be exported fileName The path to the file where the descriptor will be exported
resource:info	Provides extended information about one or more resources	resource:info resourceType:resourceName	resourceType:resourceName A space delimited list of resource type and name
resource:list	List the resources in the platform	resource:list [options]		--type, -t The resource's type you want to obtain a list
resource:modify	Modify one or more existing resources	resource:modify resourceType:resourceName path or url	resourceType:resourceName The name of the existing resource to modify path or url The file path or url to new resource descriptor
resource:remove	Remove one or more resources from the platform	resource:remove resourceType:resourceName	resourceType:resourceName A space delimited list of resource type:name to be deleted
resource:start	Start one or more resources	resource:start resourceType:resourceName	resourceType:resourceName A space delimited list of resource type:name to be started
resource:stop	Stop one or more resources	resource:stop resourceType:resourceName	resourceType:resourceName A space delimited list of resource type:name to be stopped

Profile commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
profile:info	Provides extended information about one or more profiles	profile:info profile ids	profile ids A space delimited list of profiles ids.
profile:list	List all available profiles	profile:list
profile:remove	Remove a profile from available ones.	profile:remove profileName	profileName The profile Id to be deleted

IP Capability commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
chassis:listInterfaces	List all the interfaces of a given resource	chassis:listInterfaces resourceType:resourceName	resourceType:resourceName The resource name to show the interfaces
chassis:setInterface	Set a IP in a the interface of a given resource	chassis:setInterface resource type:name interface IP MASK	resourceType:resourceName 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

ROADM Connections Capability commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
connections:listConnections	Shows given resource connections	connections:listConnections resourceType:resourceName	resourceType:resourceName The resource id to show connections
connections:getInventory	Shows given resource cards and connections information	connections:getInventory [options] resourceType:resourceName	resourceType:resourceName The resource id to set the interface	--refresh, -r Refresh model prior to show information
connections:makeConnection	Makes a connection between given ports af given resource, and configures which lambda enters and which gets out of the connection	connections:makeConnection resourceType:resourceName sourceport inputlambda porttarget outputlambda	resourceType:resourceName The resource id to make connection sourceport Connection source port (input) inputlambda Input lambda (wavelength in nm) porttarget Connection target port (output) outputlambda Output lambda (wavelength in nm)
connections:removeConnection	Removes a connection between given ports af given resource	connections:removeConnection resourceType:resourceName sourceport inputlambda porttarget outputlambda	resourceType:resourceName The resource id to make connection. sourceport Connection source port (input) inputlambda Input lambda (wavelength in nm) porttarget Connection target port (output) outputlambda Output lambda (wavelength in nm)

Description

All the capability operations which work above a resource have the same work flow. A capability command is sent to the resource's queue and it will be executed

Monitoring Capability commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
alarms:list	List alarms of given resource (all alarms if no resource is given)	alarms:list resourceType:resourceName	resourceType:resourceName A space delimited list of resource type and name
alarms:clear	Clear alarms	alarms:clear resourceType:resourceName	resourceType:resourceName A space delimited list of resource type and name

Description

The alarm commands include operations to list and clear the received alarms.

Child pages

Server Console

Karaf's Commands

OSGI Commands

Features Management Commands

Mantychore Commands

Nexus commands

Protocol commands

Description

Resource commands

Profile commands

IP Capability commands

ROADM Connections Capability commands

Description

Monitoring Capability commands