Index Changes
View Info

JBI ADMIN CLI

JBI Pre Sierra Release CLI Commands

The list below contain links to Pre Sierra CLI commands.

JBI Pre Sierra Release CLI Commands (With additional options added for Sierra)

Some existing CLI commands have had options added to them so they can support the Sierra use cases. The follow list contains links to pages that contain detailed information for each of the existing CLI commands. (*) Additional options were added for Sierra release

JBI Sierra Release CLI Commands

JBI CLI commands that were added for the Sierra release. The follow list contain links to pages that contain detailed information for each of the new Sierra CLI commands

Use Cases

Actor Inventory

  • Installed JBI component (Binding Component or Service Engine)
  • JBI Common Client
  • ASADMIN CLI
  • Administrator: this is the administrative user using the asadmin console
Use Case Name
Set configuration for JBI run time or an installed component
Date written
08/03/2007
Description
This command modifies parameters for several different configuration types for JBI runtime or an installed component (SE or BC). Typically these configuration types include static/constant configuration, application configuration, application variable and logger.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
1. Based on different configuration type, the configuration parameters could be specified directly from command line, or in an input XML file, or in an input property file.
2. Component is assumed to be installed if the configuration for a component is going to be set.
3. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
4. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
5. If the target option is specified as a cluster name, the task is executed against all instances in the specified cluster.
6. If the target option is specified as an instance name, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the set configuration command which specifies an installed component (optional), the type of the configuration, the name of a configuration, the path to the file which contains the configuration parameters (optional), and a server instance name ("domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. ASADMIN CLI interprets the task and gets the configuration parameters.
2. ASADMIN CLI passes all the parameters to JBI common client.
Error Flow: System Action
1. If the path to the input file is not a valid location, an error message should be returned from ASADMIN CLI.
2. If the failure is due to the reason other than invalid file/path location, ASADMIN CLI should print out the detailed failure message returned from JBI common client.
3. Administrator should get a failure message, detailing the reason why the set application configuration command fails.


Use Case Name
List configuration value for JBI runtime or an installed component.
Date written
08/03/2007
Description
This task lists parameters for several different configuration types for JBI runtime or an installed component (SE or BC). Typically these configuration types include static/constant configuration, application configuration, application variable and logger.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
1. Component is assumed to be installed if the configuration data is queried for an installed component.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a cluster name, the task is executed against all instances in the specified cluster.
5. If the target option is specified as an instance name, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the list configuration command with the required input such as configuration name key, configuration type, a component, a server instance name (or a cluster name, or not being specified).
Basic Flow: System Action
1. ASADMIN CLI interprets the task, as well as the input parameters.
2. ASADMIN CLI passes all the parameters to JBI common client.
3. ASADMIN CLI prints out the configuration value (i.e., the query result) which is returned from JBI component client.


Use Case Name
Add application configuration data to an installed component.
Date written
08/03/2007
Description
This task adds configuration data for an installed component. The configuration data which can be added includes two configuration types: application configuration and application variable.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
1. The specified component is assumed to be installed.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a cluster name, the task is executed against all instances in the specified cluster.
5. If the target option is specified as an instance name, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the add configuration command which specifies input parameters such as a configuration type, the name of the application configuration, application variable tuples (key/type/value), the component name, a server instance name ("domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. ASADMIN CLI interprets the task, as well as the input parameters.
2. ASADMIN CLI passes all the parameters to JBI common client.


Use Case Name
Delete application configuration data from an installed component.
Date written
08/03/2007
Description
This task deletes confi
2000 guration data for an installed component. The configuration data which can be deleted includes two configuration types: application configuration and application variable.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
1. The specified component is assumed to be installed.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a cluster name, the task is executed against all instances in the specified cluster.
5. If the target option is specified as an instance name, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the delete configuration command which specifies input parameters such as a configuration type, the name of the application configuration, application variable tuples (key/type/value), the component name, a server instance name (or "domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. ASADMIN CLI interprets the task, as well as the input parameters.
2. ASADMIN CLI passes all the parameters to JBI common client.


Use Case Name
List monitoring statistics data for JBI runtime or an installed component
Date written
08/03/2007
Description
This task prints out monitoring statistics data for JBI framework, or NMR, or an installed component, or an endpoint.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
1. Component is assumed to be installed if the monitoring statistics data of the component is going to be queried.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a cluster name, the task is executed against all instances in the specified cluster.
5. If the target option is specified as an instance name, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the list monitoring statistics command which specified the input parameters, such as the type of monitoring statistics data, an installed component name (optional), a server instance name (or "domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. ASADMIN CLI interprets the task and the included parameters.
2. ASADMIN CLI passes all the parameters to JBI common client.
3. ASADMIN CLI prints out the monitoring statistics data returned from JBI common client.


Use Case Name
Upgrade component
Date written
08/03/2007
Description
This command is to provide a simple way to upgrade a JBI component in a non-destructive way, preserving all existing deployments to that component.
Actors
Installed JBI component, ASADMIN CLI, Administrator, JBI common client
Preconditions & Assumptions
The precondition is that the component, which will be upgraded, has already been installed.
Basic Flow: User Action
Administrator executes the component upgrade command, specifying where the new archive is located.
Basic Flow: System Action
1. ASADMIN CLI interprets the command and gets the input parameters from the command line.
2. Before calling JBI common client, ASADMIN CLI validates the location of the archive.
3. ASADMIN CLI passes all the parameters to JBI common client.
Error Flow: System Action
1. If the path to the new archive location is not a valid location, an error message should be returned from ASADMIN CLI.
2. If the failure is due to the reason other than invalid archive location, ASADMIN CLI should print out the detailed failure message returned from JBI common client.
3. Administrator should get a failure message, detailing the reason why the upgrade command fails.


Use Case Name
Application Verifier command
Date written
08/03/2007
Description
This project would aid the system administrator in verifying if all the configurations needed by an application can be resolved during deployment. For this use case, please refer to SierraUpdateAppVerifier

Sierra CLI Schedule

The following link will display a matrix that shows all commands that need to be developed for the Sierra release. Use and update this matrix so the development status can be easily retrieved.

G'day, Anonymous Guest

JSPWiki v2.4.100
[RSS]
« Home Index Changes Prefs
This page (revision-147) was last changed on 22-Jan-08 16:59 PM, -0800 by Mark Saunders