Page History

...

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="98817190a3a827c7-d0a3cd2a-4c4840e4-a273a23c-86b552912dae825882e311eb"><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="a79c5ef729e90b5f-70b382f5-4d5e4e0d-88d79c20-ad3c4c05461b763d32267db3"><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="fc49413fc0af7bad-8ef3c136-448e461b-9095b200-7388baef7ce428edba79a087"><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="83f2fe7941cf5e7c-87e8370b-400f4d4e-a32797fe-2a5294ae5e3698fb259fd509"><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="f6e467e4fa3a42c0-2aa98007-4f524134-b5019d2c-3647e725ca47afa12d8932a8"><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="8d818bc7f7b10164-62274ac1-435b49ce-8f20b8b7-cde0fd2a18b9b3f4845370bb"><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="2af273d813f3c53e-3307be6c-40b44a7a-8a8a810e-58774f6d2517958de5c8145c"><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.

Resource commands

...

COMMAND

...

DESCRIPTION

...

SYNTAX

...

ARGUMENTS

...

OPTIONS

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="347624fe-1b8e-4706-9bac-e25f16f3eba3"><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

...

...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3d230a84-c750-45c6-b494-043bf195a00e"><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="2515b8ea-3f61-46ac-8431-9ea18f7cf49a"><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="b253e328-f6bf-4e4e-b098-972d1d1273c1"><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="30a6e64c-a226-4178-8cd7-bcf14418ea0f"><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="b00b5bab-8fa6-41fc-8bde-5218bee6ce90"><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
...

...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f129b02c-5964-4424-85fe-3bc3ee7004bc"><ac:plain-text-body><![CDATA[
...
resource:start
...
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="032baf80-e406-4bfc-8020-1dbeda37d34d"><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
...

Profile commands

COMMAND	DESCRIPTION	SYNTAX	ARGUMENTS	OPTIONS
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2d577190161c5638-10b205ef-44af4fa7-b00c8816-ad3b6b73a62fe4bc2ed2f117"><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="b49a3cb42a9c8012-f2bbe931-416a4b28-8034b967-d3b74a515465c830d6a85c9d"><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="56f133e5f384ccec-76803ba8-4dd34f55-a3a49c68-f5451300558996ec018cd773"><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="501593aaee6685b4-c101d0aa-4c934dca-844ebd9f-5b6f9141ec8dd19070abe24c"><ac:plain-text-body><![CDATA[	chassis:down	Down a physical interface	chassis:down [options] resourceType:resourceName interface	resourceType:resourceName ]]></ac:plain-text-body></ac:structured-macro> The resource id to set the interface interface The name of the interface to be down
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5db423d52eec4ad4-0d3be0c2-41e049f7-acc69bcf-6f599775aef33ecca3c2787b"><ac:plain-text-body><![CDATA[	chassis:setVLAN	Set a VLAN id in a given interface.	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
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ec11caedec46c3db-f319d83d-42634541-be599687-fb547b07116a345b3af5d34a"><ac:plain-text-body><![CDATA[	chassis:showInterfaces	List all the interfaces of a given resource	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
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="93decf45fe7b208a-5324e5d7-4a674b51-ae85b346-bfb4ad8899e11ca4500bc842"><ac:plain-text-body><![CDATA[	chassis:up	Up a physical interface	chassis:up [options] resourceType:resourceName interface	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

chassis:up		<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0c139720-743a-4e07-9ea0-a73e81b1c567"><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	chassis:setVLAN	Set a VLAN id in a given interface.

IPv4

Child pages

Versions Compared

Old Version 23

New Version 24

Key

Resource commands

Profile commands

IPv4