Versions Compared

Old Version 17

changes.mady.by.user Unknown User (evelyn_torras)

Saved on

compared with

New Version 18

changes.mady.by.user Unknown User (pau_minoves)

Saved on

Key

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

...

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

...

Nexus commands

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="49c9fadf7780c898-7fd7b046-43e94680-adfebef2-1752ec34744a4c8a4c2e45be"><ac:plain-text-body><![CDATA[

nexus:listDevicesplatform

Get platform details List the device ids registered in the protocol manager

nexus:listDevices platform [options]

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="bbc89003-1150-4d6a-acc2-f7b275b772e3"><ac:plain-text-body><![CDATA[

nexus:listProtocolFactories

List the protocol factories registered in the protocol manager

nexus:listProtocolFactories [options]

 

 

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="64a4e24d-78f2-4dfb-af4f-e03b471b59a9"><ac:plain-text-body><![CDATA[

nexus:platform

Get platform details

nexus:platform [options]

Protocols commands

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS ]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3bbbc4f989df8b07-d86d97ae-4795492c-961db36a-14c191d92da47e7cc4cb3342"><ac:plain-text-body><![CDATA[

protocols:add

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

protocols:add [options] resourceType:resourceName protocol

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the session to create.

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


<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="04a3db5392febd7e-d3fd900d-4187492a-b23485d1-814ed0e81efbe60a6d21fe0b"><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]

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
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.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1aee20753bcabe31-8eeeb282-409b4822-b85baf9d-6701225f3336d4886bd1d5b8"><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]

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the session to create.

Seconds
How old are the sessions to be destroyed.


...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b28b113cf4e4e69c-f6767694-4e794df9-bb718c27-b89dddd61773c897d5b1d50c"><ac:plain-text-body><![CDATA[

resource:create

Create one or more resources from a given descriptor

resource:create [options] paths or urls

paths or urls
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of file paths or urls to resource descriptors

--profile, -p
 
Allows explicit declaration of profile to be used

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fe2d335108295818-22c12109-4dd9475d-90d0af55-8d23d603f62187a329adddda"><ac:plain-text-body><![CDATA[

resource:export

Export the descriptor of a resource to a file

resource:export [options] resourceType:resourceName fileName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource whose descriptor is going to be exported
fileName
The path to the file where the descriptor will be exported

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1d123f05524a7f7b-9f0f0c47-4c224e44-81378063-2f7178278aa932d41870e23c"><ac:plain-text-body><![CDATA[

resource:info

Provides extended information about one or more resources

resource:info [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of resource type and name

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b953d56683394528-5eafcf34-492f4399-b3a79fe1-14ee89f7dd28a4bbcadc2319"><ac:plain-text-body><![CDATA[

resource:list

List the resources in the platform

resource:list [options]

 

--type, -t
]]></ac:plain-text-body></ac:structured-macro>
The resource's type you want to obtain a list

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="83cd1a4a1481ca5c-c8cadc2d-4ffb4162-8c10a589-b32df433954b3331057dab19"><ac:plain-text-body><![CDATA[

resource:modify

Modify one or more existing resources

resource:modify [options] resourceType:resourceName path or url

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The name of the existing resource to modify
path or url
The file path or url to new resource descriptor

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3a771b4d601c1d79-7393c4dd-4ce542d8-89f68a7d-f0197907102b3bbec50570a9"><ac:plain-text-body><![CDATA[

resource:remove

Remove one or more resources from the platform

resource:remove [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of resource type:name to be deleted

 

resource:start
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="862d94b91a30ae4a-be40dfec-40314a35-8779a4b0-75a6755f286c39098d6d4e36"><ac:plain-text-body><![CDATA[ 

Start one or more resources

resource:start [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of resource type:name to be started

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6aebadf951cc0260-7b483730-49404637-a4869f11-c81d10d51b7b71e25cb4b921"><ac:plain-text-body><![CDATA[

resource:stop

Stop one or more resources

resource:stop [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of resource type:name to be stopped

 

...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4d97e2549c61a3f3-1dded3ce-4dc14584-aac091e3-9bd19cae0e81547b55f43849"><ac:plain-text-body><![CDATA[

profile:info

Provides extended information about one or more profiles

profile:info [options] profile ids

profile ids
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of profiles ids.


<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2768c6fdf4e106e6-af3e6393-4fa14252-8fbc8ab3-ad5372b223373f74e668875f"><ac:plain-text-body><![CDATA[

profile:list

List all available profiles

profile:list [options]



]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="70f8d110170e87ef-b815a12c-42884a43-9e4c94ba-1d3e0ab91e43380be9c7a1f5"><ac:plain-text-body><![CDATA[

profile:remove

Remove a profile from available ones.

profile:remove [options] profileName

profileName
]]></ac:plain-text-body></ac:structured-macro>
The profile Id to be deleted


...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e8fefb18bec51730-47bee39f-47b342d4-88c7ad9e-f8e2d110da0e35e658c35b1f"><ac:plain-text-body><![CDATA[

chasischassis:listInterfaces

List all the interfaces of a given resource

chasis:listInterfaces [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource name to show the interfaces


<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9ccd558eb8448361-9b096594-4bbb4963-8a0daa7f-7d3df2a5d1f04f2bc90bfcb4"><ac:plain-text-body><![CDATA[

chasischassis:setInterface

Set a IP in a the interface of a given resource

chasis:setInterface [options] resource type:name interface IP MASK

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
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