Page History

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9613ed051ec25eaa-c624b3ff-45574b84-99b99b8c-c143f86d182d84839f41b560"><ac:plain-text-body><![CDATA[

nexus:platform

Get platform details

nexus:platform [options]

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

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

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="ed29c733329e9227-dfcb3b2c-41da4600-93f1a27c-e4a81a5308a5bb09d6348455"><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="4cfc162fe545d417-e8079c5b-4af24c99-b63096cf-58b78bbb93270ecb4e50f4c9"><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.

protocols:info
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="23b1b2ccc4dec100-34fc0093-42a04af3-8465973a-911a9fa07b862065d70181cb"><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="f3fdf5037326e15c-e558bf7b-48ce4791-881ca8e8-9ef2c03b8c28b795b916ef10"><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="c7bfebb0a7795c8c-2ed260e3-4fd94a3a-a6899d1d-b97b025330496be2b72dc739"><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="c8a02d01daf6eb06-a7d8fe75-4684476a-a73c883b-86b856ab050e935058751ccf"><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="6698702b01cd38e9-d291f995-4cd94044-996a885e-5ae517537d1a4a4972b49b65"><ac:plain-text-body><![CDATA[

profileresource:infocreate

Create Provides extended information about one or more profiles resources from a given descriptor

resource:create profile:info [options] profile ids paths or urls

paths or urls profile ids
]]></ac:plain-text-body></ac:structured-macro>
A space delimited list of profiles ids. 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="271bc8728fe68720-5cb5f648-4b8341fd-a1699229-5f290099421856469f707be7"><ac:plain-text-body><![CDATA[

profileresource:list

List all available profiles

export

Export the descriptor of a resource to a file

resource:export profile:list [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="6fa4dffe816889a9-5c3ddd0b-49ff45e7-a98e8764-ed45f8a10213a8b2a225e83c"><ac:plain-text-body><![CDATA[

profileresource:remove

Remove a profile from available ones.

profile:remove [options] profileName

info

Provides extended information about one or more resources

resource:info [options] resourceType:resourceName

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

A space delimited list of resource type and name

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="92f8ff1f-92f1-4ffb-b24c-1a754abe5841"><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="e50d797fbbb4306d-7ab22402-4f244417-9439a2e0-bf1a4d1728db6aebcdb22bf6"><ac:plain-text-body><![CDATA[

chassisresource:down

Down a physical interface

modify

Modify one or more existing resources

resource:modify chassis:down [options] resourceType:resourceName interface path or url

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The name of the existing resource id to set the interface
interface
The name of the interface to be down 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="6e2d0caf868c8559-e503a87b-484f4f72-83ec99db-e42378ce487599d73fdf93c9"><ac:plain-text-body><![CDATA[

chassisresource:setVLAN

Set a VLAN id in a given interface.

remove

Remove one or more resources from the platform

resource:remove chassis:setVLAN [options] resourceType:resourceName 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 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="3be06176-d16d-4e70-bf4f-ffea33444b20"><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="e7ab235677d8cd80-f325200b-4f6c4acb-9e92b3cd-e03f0991ad8d6aae7283f1ce"><ac:plain-text-body><![CDATA[

chassis:showInterfaces

List all the interfaces of a given resource

resource:stop

Stop one or more resources

resource:stop chasis:showInterfaces [options] resourceType:resourceName

resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource name to show the interfaces --refresh, -r
Force to refresh the model with the last router configuration 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="2140c5a2-4243-46eb-88db-76cacd277adc"><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="0eeabb5348cad878-ed6f57b3-4ac14a20-b43093cf-069e238befa12654113d6ca0"><ac:plain-text-body><![CDATA[

chassisprofile:up

Up a physical interface

chassis:up [options] resourceType:resourceName interface

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="cd2f8d62-da57-46eb-85d7-07b1f1d0cf0d"><ac:plain-text-body><![CDATA[

profile:remove

Remove a profile from available ones.

profile:remove [options] profileName

profileName resourceType:resourceName
]]></ac:plain-text-body></ac:structured-macro>
The resource id to set the interface
interface
The name of the interface to be up

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="689c8fd473f3e937-c2817323-4efb4dc6-86e99ad1-485429658eb1568bbbd4401e"><ac:plain-text-body><![CDATA[

ipv4chassis:listlistInterfaces

List all the interfaces of a given resource .

ipv4 chasis:list listInterfaces [options] resourceType:resourceName

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

--refresh, -r
Force to refresh the model with the last router configuration

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9818aa792f81ffb7-6255d946-42004e27-b2508ff7-7d8518edf3f10c159fc586a3"><ac:plain-text-body><![CDATA[

ipv4chassis:setIPsetInterface

Set a IP in a given the interface of a given resource

ipv4 chasis:setIP setInterface [options] resourceTyperesource type:resourceName name interface ip maskIP 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.xx 
MASK
A valid MASK IPv4: x.x.x.x