Server Console

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3407bb10-582c-4708-ae66-0d2f8bc67eda"><ac:plain-text-body><![CDATA[

nexus:platform

Get platform details

nexus:platform [options]

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

protocols:add

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


<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="57de4a04-0b88-4cce-8dea-e80843bc4ca9"><ac:plain-text-body><![CDATA[

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="7e776e19-204d-4791-94a5-81417996847c"><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="d8dfbcf4-741b-4c55-aace-fcb5da9ce6ea"><ac:plain-text-body><![CDATA[

protocols:info

Provide extended information on a protocol session.

protocols:info [options] resourceType:resourceName sessionId

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="875a81e4-476a-4fc7-9235-aab0cd16eac4"><ac:plain-text-body><![CDATA[

protocols:list

List devices to which we have a live protocol session.

protocols:list [options] [resourceType:resourceName]

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="be68a25f-7f3b-4710-8c67-bb8066d47569"><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.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a00bf76b-e842-474c-bd98-001009928748"><ac:plain-text-body><![CDATA[

protocols:remove

Removes a live connection from the pool, closing it.

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

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource owning the session.
sessionId
The name of the session id that will be destroyed.

--all, -a
Remove all active sessions.

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="85f36c23-34d2-481e-8d9b-5bf3810281ba"><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="fddc2e8f-0e9e-4d45-b0aa-0058aa2abf15"><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="dde5c473-ec22-4dfb-a6a4-a17ee8b23658"><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="6cfb2d0d-cca7-4fec-a3ee-2e7a9cf647c3"><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="ae197856-4ffb-4421-a708-fcc1642be0ad"><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="c08f9f5a-43bf-4186-9155-1e1fbaf4e719"><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="8f7c169d-6953-4b0b-a934-5f0de3a83679"><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="59c4007e-69fb-424e-8eef-40bd6a26a673"><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="c65ca487-74bb-4a81-95c3-7a5577e2b289"><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="4f844a62-7e49-427e-9ab1-feef5f5e859a"><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="0a18c1bf-374b-4cc3-8f38-e573c613f618"><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="195c1e4d-99ab-4496-b384-df2952e10d40"><ac:plain-text-body><![CDATA[

chassis:setVLAN

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="cd6d54a3-ac31-45a3-b310-faad2668ade9"><ac:plain-text-body><![CDATA[

chassis: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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7a5d719d-ea34-429b-849c-509f51527929"><ac:plain-text-body><![CDATA[

chassis:setVLAN

Set a VLAN id in a given interface.

chassis:setVLAN [options] resource type:name interface VLANid

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
VLANid
The VLAN id