Page History

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="23dbffdae8d923be-75ddaeb4-405e4b1b-981a8298-9e25fdd89342263d45b3b968"><ac:plain-text-body><![CDATA[

osgi:list

list all installed bundles

osgi:list [options]

-s Shows the symbolic name
]]></ac:plain-text-body></ac:structured-macro>
-l Show the locations
-u Shows the update locations

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d4b1e15711656e45-83694156-4e574d80-bddab64d-a59186e78e8ea35a655d0896"><ac:plain-text-body><![CDATA[

osgi:ls

list OSGi services

osgi:ls [options] [ids]

ids Show only services for the given bundle ids

-u Shows services which are in use
]]></ac:plain-text-body></ac:structured-macro>
-a Shows all services

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b7e2b0ac9f25ea99-9b5b570a-4fd4491b-a9b6a95d-104c915c89af8bc7988058dd"><ac:plain-text-body><![CDATA[

osgi:start

Start bundle(s)

osgi:start [options] ids

ids The list of bundle IDs separated by white spaces

--force Forces the command to execute

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cb4168f44867f4d5-8d33a455-49684d6d-894eae4d-cec2bf3082f7d67f6a704a4d"><ac:plain-text-body><![CDATA[

osgi:stop

Stop bundle(s)

osgi:stop [options] ids

ids The list of bundle IDs separated by white spaces

--force Forces the command to execute

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7f73acb2ffaa344a-ed0123a5-464749ae-a0448011-3aa0d441b87536a876389991"><ac:plain-text-body><![CDATA[

features:list

List all existing features available from the defined repositories.

features:list [options]

-i, --installed
]]></ac:plain-text-body></ac:structured-macro>
Display a list of all installed only

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="469ba203e2c97971-a14910c9-475942f2-b7a8b3f6-2a7aeaba472692fedcff1963"><ac:plain-text-body><![CDATA[

features:install

Installs a feature with the specified name and version

features:install [options] name [version]

name
]]></ac:plain-text-body></ac:structured-macro>
The name of the feature
version
The version of the feature

-r, --no-auto-refresh
Do not automatically refresh bundles
-c, --no-clean
Do not uninstall bundles on failure

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6f47905941e5be68-89ca1dc3-4f584597-af5db472-165d55a088a9729383bb5311"><ac:plain-text-body><![CDATA[

features:uninstall

Uninstalls a feature with the specified name and version

features:install [options] name [version]

name 
]]></ac:plain-text-body></ac:structured-macro>
The name of the feature
version 
The version of the feature

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="05c13942efca3676-84c64dca-4fab408e-8f7aadaa-116d9e4a090a338d9048fe50"><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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d6127bd2f07dc290-4a39c451-4ba7469e-a67bbe36-343d004a6421dbe2daf1b49a"><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="e67d796b7cb75546-1e3b29fc-452d465b-9ed8af43-ba14d44e241d390a377ba84d"><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="46359a3529ccfe01-59c1ab42-47fa44a8-aff38b5e-d32b232cc7e3b85d64cbc00c"><ac:plain-text-body><![CDATA[ 

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="5a888a79dff64d74-1d5e1f2c-4ad94cba-9f928f17-23a24e0f2cb07a9e16ff49cc"><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="0cce0ef4526b8e3d-201327e1-430c4ea1-b78ea5fd-0acfabf80ac7a657ae853e5f"><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="0a1f4e0ccb39fec9-b6faff5e-4c074ef0-9255a95f-00ca3f13de4d136c9877d3aa"><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="0e7146aa446370b7-2d4062f0-4ea74d13-b32cacda-8c3f097545a91bc468cde0ad"><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="5ee96503d183a385-db20fc28-4a034c03-a5caa524-116deeb89cb1a49fea521008"><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="b7030700765b15e3-a577ab21-4b3e48e5-94ffa3e1-2033fe11298b93d27153a0d8"><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="64c125183ae658f9-84cab10e-462448cf-9754827c-3a015c5e2f2cfc9ff4d96d21"><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="277a68958c286553-07d2eccd-42b3435c-b20baa2f-fef9fbb0ec6a3dc2df0cdf25"><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="f9f28049d0f0f213-5acc03ca-4c104896-bdb5854d-863635baaa1cf3bd5100b0c8"><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="b1f96e3e14eaa45a-00fad8cb-4c4d4b4a-86758348-4828255552402f4001a265f5"><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="345fc8876f37797f-f7d8bf7d-4fa340b0-ae058e24-3b9425dad89df5ded7bf0385"><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="9e8bcd23d47eea2f-e3c36139-44814d7c-9304a28f-1b71b5ef67aeb74c08696418"><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="80b538fa62654c10-9b01862e-418e4627-ad16908a-1c671c9a519537d938985af8"><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="90b4378bc52d3af0-7bb41628-4ce64038-b0c98ed0-c44b144a455d534f7941d2f3"><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="320ba1922e775bfa-b9d5740c-4db74172-b8699d0d-63501838e3c8cbcdf0c922a4"><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="067a610cfc5ac71f-8687acf3-48dd411c-ab26a7cd-85f5bc8d41643ce5ccb471e3"><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