Versions Compared

Key

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

...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aefb4fbfbe585e41-7f8f90df-48ff4e3a-976f850a-da43a3a42d3ba39f46cee24f"><ac:plain-text-body><![CDATA[

nexus:platform

Get platform details

nexus:platform [options]

 

 

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

...

Protocol commands

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5939c22cafac4f24-4680c7d8-404843cf-83538e07-341e7dd5c528d53bac8b279f"><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="05af53dae091732e-49efa8f1-4cdc4b26-ace99292-e5863e1523dd5524b85ba8a4"><ac:plain-text-body><![CDATA[

protocols:Contextcontext

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="ed1d54c91ede4232-3c2ee910-45744573-82828d9e-c8d7f6eab59669242a285978"><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="d86d6ea94a45be0b-ec313b64-49444da3-98c6bda6-e3bbf02359fcd933afd19e71"><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="abb621eae20a7c3e-15de7657-4c6e4e48-8b9dbdd7-4411c7e19b3a9e882c8de095"><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="9af2b90f1536c563-d52d9f9f-46054f2c-bc969fb4-b3ca9655c22d904f2674cdce"><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="a4e7e266ac39dbe7-68d039ad-4ea14899-907c96d6-24b17727e1f770485fe3a215"><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="27f3ed44eac8e1db-8bedc53e-44a34808-9b76b1a5-0dff4da4de4e162625e0d2bb"><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="ce326582b0a0b701-297f7bfe-446a4868-96e7903c-a540abf8a5f8ba7fbcce6de3"><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="bc05ebc50def2868-4bcca7b5-41ea4d6d-b747adfb-b068a1974ece9e70ebfc89a6"><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="597c3e183eeb40d7-b6191323-4d22469b-a17b8519-e8328e4c987a398de6723ad7"><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="0cbc2e31995805e5-d56b6ea8-431c4e30-9c95b8f8-8eda18f7b65ab8528112590f"><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="4679cc31e7f25ec3-cbdb42c0-49ea4ebd-ab7abb1b-10cece7f281e5530f2262692"><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="ce832d11928d087b-5218d690-47eb4b78-bcc19226-517fe940625b938b6f6f5a73"><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="f531d03de75a8104-913f5697-4c3d4098-9c3bad6e-a295bc8f66456f23af8a3b3f"><ac:plain-text-body><![CDATA[

chassis: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="001f6551aa458c42-d0337e0a-438b4d4d-84ce86f7-e6a7b435044400f752668f06"><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