Page History

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="621e65e2ea2d74cf-6e40543d-421a45a3-936b90c1-2ffd6b42d23410931e4ff914"><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="38fe3de18daefe56-d4838478-44954d43-8a7598d1-973a8b7a844b65e3fbf5623e"><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="6437485cf5828774-e3a89423-4ff343b0-bb86bc7a-4988313c3ce08e54824b2d00"><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="87dadeb719b0e89f-d457c173-42d54a32-9e6c83a7-cc919a5cc496bbb06674c00b"><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="9a5791d6883ed9a9-ef4ef91e-449e4e70-ac32908e-f204f2c4c8ca122103fefdc0"><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="4b9d46d661b05fe8-6a3234d2-4cfd4d94-8ece89e1-beb238dd42dc061a2fc5151a"><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.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ebecbfd9df62e4b1-3cd7074b-497f4313-bf86aa59-0347341fd9e301651783a742"><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="79f34ba8b4f04197-1f93a6d9-4af94692-814299be-d0752c0e7f8356a1431018de"><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="fcd90a172972b115-05101b2c-477c4193-be959ac5-4df56f958a480cb2e86380b2"><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="fe92fe564a9842dc-e634192d-41994d2b-b5878323-5a6e2d031eb7764a6e9e74ff"><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="a968b25689ef0c77-11bcb372-48e9410f-8be19316-b731cabdd962bd31b69e7f89"><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="eee64c70d693582a-fb59bc12-48724e37-b7b49a54-f3dd1d7fe9d3b992f284c3cb"><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="fcd0c1d9e45e6dd9-b28807a8-445e478e-bedc921e-688fdd27436c568b09f8a7f4"><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="4c09eb4e0bdee85e-927c8d96-4fa74c11-b2afb6d8-37ca1fcaf7dcb3eb5a108d84"><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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="39357d70-5231-4ba8-93d8-13194a094a9c"><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="deddaafaf6a21fa8-919da75d-43804268-8e1cb048-39bcf70384581f6bf982ef2f"><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="430c680b-5d87-492e-9453-30d251033188"><ac:plain-text-body><![CDATA[

chassis:showInterfaces

List all the interfaces of a given resource

chasis:listInterfaces 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="e7064bba686c2d92-4e1023e9-485f4be6-86539e3e-f3876b967882d6dd21b101ab"><ac:plain-text-body><![CDATA[

chassis:setInterfaceup

Set a IP in a the interface of a given resource

Up a physical interface

chassis:up chasis:setInterface [options] resource typeresourceType:name resourceName 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 up

chassis:up

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b74981a7a010aa6e-6d725999-4bd64712-8ec09c27-7069699812b3f726c2ed3dfd"><ac:plain-text-body><![CDATA[

chassis:setVLANsetInterface

Set a VLAN id in IP in a the interface of a given interface. resource

chassis chasis:setVLAN setInterface [options] resource type:name interface VLANidIP 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
VLANid
The VLAN id
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.