Versions Compared

Key

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

...

OSGI Commands

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="699f00f3861370ad-eca4e7c1-4cd14946-bcda93a4-d568841de19c768acac14a5e"><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="d8d605da67f06da7-87d1d2b2-41f545bb-b6f0b7ef-49ce1602ad3f88c79cc820ee"><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="0e2f3fddc4769a70-13b6ef50-403048f1-8ec985df-0dbb4e1e551225973297d834"><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="62abcd3fb3dc1ad7-8b8fdc6c-48c544cb-bc5faac7-d9c0e10e4054231954fc6355"><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>

...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d4a677246c9f6d33-618c4317-4a0647fb-b9bb882d-daefb472f0aaeaa5a7b8d6ba"><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="a314ebc4e3f8c0ba-cf964cfa-4399470a-b9c48162-a0034640603bf6c553f53643"><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

-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="0f528c2a84a8ad90-01417886-44cc4bb3-804e8727-712b38885f958263ffa3fb75"><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

 

...

COMMAND

DESCRIPTION

SYNTAX

ARGUMENTS

OPTIONS

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b76c8780adc820d0-43f7eb0c-44184ff1-bfc1bb32-f87bd29744c5ccca99122da9"><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="6dce16e13fb6ca49-1be52fe7-4d6f4770-9b47aaa4-4ccc7a8ddaa059cbe8582512"><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="188e19af54e8eab7-189a4155-4c9147fe-a197ad2b-287eccab487d5eedcc470c99"><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="31409f65ac2882f6-0f195267-4b154ed9-a8c792cc-2e2674bd696f3b3de4f82ddc"><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="d37c8079c4bd3968-08e10484-48e04b49-bc85aec0-d123b571e66afca19ec8e4b4"><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="7e7887dffc54c604-4eaa9d61-401648fa-9f89b4d2-3c6fb0082ac80012dc0bf9c7"><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="5e238f6320e8c54b-d4214a1d-4eed4ec3-bf9c8d2d-c161dc1cbd501b24c03d9cbc"><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="fa3abf9d06e569b8-292a8f53-430246fa-8edcb8d6-2aaf16765379b84a22f83ed9"><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="a6fddc5f79f0c4dd-86fbe27c-4dc149f5-a4d9abd4-0247c749488706e7f8872e3e"><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="3332c56d03e7ca45-b1c96028-42284991-90cda705-1abf6c93bde51f50d7a91f67"><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="6697febe5bb8185c-aa6e8e79-4fbf42bb-8344b687-9f42cd8776ffe11ee6666406"><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="e4a4b9d6e3e3d49d-9cb1c733-4d154508-a6428bbc-f8b8d3e4d4b2865675afe445"><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="0b3bf0ca312db86e-7dd034fd-4b3241c8-b4bf840e-a9763c3ebf0b361817dad17f"><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="afc9662e62f25db9-d17f0b83-4b024671-b2ea9157-71119c0698c0c034ffbbe66d"><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="a8d84bd75c8f5da9-ff8e88b8-442a446b-9507a5e6-a7ae55acc13bf2ad222aeafe"><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="3664d50c7ceb8da8-50129f20-4fad4dc2-aae58802-e4b8e99986d14e8f7980d14a"><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="50e94b507ed0e9e8-d69948e2-4cd84689-83cbbe67-9f7d3fb8d53e8da425ee73dc"><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="e6a6f8942fb0040d-f26c2d9a-4c274233-bbcca118-dc03b399f3fcff5c6ebe9eec"><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="cadc2208dfecef33-b1a10efd-446f4551-9cbab0b0-570e7b335c30f7a56d094ad4"><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="0aa763c6cf2c70d7-593efc90-46ce44bb-80719b16-085e4774907054811348923f"><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