Administering JBI Components

JBI Command Options and Values

The Following table provides a description of the JBI command options.

Option 

Value 

Description 

Common Options: These options are common to most of the JBI Component asadmin commands.

--echo | -e 

true | false 

true indicates that the command specified on the command line is echoed to system output.

--interactive| -I 

true | false 

true (default) indicates that only the required password options are prompted.

--terse | -t 

true | false 

true indicates that the output is reduced to the minimal amount.

--port | -p 

The port number 

The HTTP/S port for administration. Default port for PE: 4848, default port for EE: 4849 

--secure | -s 

true | false 

true indicates that SSL/TLS is used to communicate with the domain administration server.

--host | -H 

localhost 

The machine name where the JBI application is running. The default value is localhost. 

--user | -u 

The admin user 

The authorized domain administration server administrative username. 

--passwordfile 

filename 

The name of a file containing the password entries. 

--target 

target name | [server]|domain 

The name of the target.  

--help 

 

Displays the help text for the command. 

Specialized Options: These options are for specific JBI Component asadmin commands only.

--assemblyname 

service assembly name 

Lists the components that have ASA deployed as part of the service assembly unit with the specified service assembly name. 

--component 

component name 

The name of the referenced component. 

--componentname 

component name 

Lists the shared libraries referenced by the specified component. 

--configuration 

true|[false] 

Displays the component's configuration values. 

--descriptor 

true|[false] 

Displays the component's XML desriptor. 

--enabled 

true|false 

true indicates that the service assembly starts automatically when the system starts up. Users are allowed to access the service assembly. For EE, this option enables the deployment on the specified instance or cluster. This option is ignored when the service assembly is deployed on the target domain.

--endpoint 

endpoint name 

Displays the endpoint statistics. 

--force| -F 

true|[false] 

true indicates that the component will be forcefully shut down.

--framework 

true|[false] 

Displays the framework statistics. 

--keeparchive 

true|[false] 

true indicates that the component will remain in the domain.

--libraryname 

shared library name 

Lists the components that currently use the specified shared library. 

--lifecyclestate 

shutdown|started|stopped 

The list can be filtered on the lifecycle state of the components. 

--loggers 

true|[false] 

Displays the component's loggers and their levels. 

--nmr 

true|[false] 

Displays the NMR (Normalized Message Router) statistics. 

--serviceassembly 

service assembly name 

Displays the component's statistics. 

--upgradefile 

[filepath] 

The new archive file path that is used to update the component. 

--upload 

[true]|false  

true indicates that it uploads the file to the administration server. If the filepath of the installable file is mounted to the server machine, or if the administration server is running locally, set the upload option to false.