• Created by Unknown User (isart_canyameres), last modified by Unknown User (manel_jara) on 02 Oct, 2013

The OpenNaaS server console has a custom set of commands implemented in order to provide the user with access to different OpenNaaS components.

It gives access to ResourceManager, ProtocolSessionManager, resources and capabilities among other components.

Commands per component

 

 

 

TO BE REVIEWED:

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:makeConnectionMakes a connection between given ports af given resource, and configures which lambda enters and which gets out of the connectionconnections: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:removeConnectionRemoves a connection between given ports af given resourceconnections:removeConnection  resourceType:resourceName sourceport inputlambda porttarget outputlambdaresourceType: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.

  • No labels