Back to Show Service Engine, or Show Service Engine Info
| At line 1 changed 1 line. |
| [Project Plan Table of Contents|Glassfish 9.1 JBI CLI Project Plan] |
| %%(color:blue)<A HREF="javascript:javascript:history.go(-1)">Return To Previous Page</A>%% |
| At line 7 changed 1 line. |
| Will show the detail information about the specified service engine. |
| Will show the detail information about the specified service engine. By default general information will be displayed, more information will be shown if the --configuration, --loggers or --descriptor options are specified. |
| At line 13 changed 12 lines. |
| ||Option||Value||[Development Effort|Coding Required]||Option Description||Required |
| |--echo {{{|}}} -e |true {{{|}}} ''__false__'' |[{Image src='dot.gif}]| If true the command specified on the command line will be echoed to system output. | No |
| |--interactive{{{|}}} -I | ''__true__'' {{{|}}} false |[{Image src='dot.gif}]| If set to true (default), only the required password options are prompted. | No |
| |--terse {{{|}}} -t |true {{{|}}} ''__false__'' |[{Image src='check_blue.gif}]| If true, the output will be reduced to the minimal amount. | No |
| |--secure {{{|}}} -s | true {{{|}}} ''__false__'' |[{Image src='dot.gif}]| If set to true, uses SSL/TLS to communicate with the domain administration server. | No |
| |--port {{{|}}} -p | port number |[{Image src='check_blue_small.gif}]| The HTTP/S port for administration. Default port for PE: 4848, default port for EE: 4849 | No |
| |--host {{{|}}} -H | ''__localhost__'' |[{Image src='check_blue_small.gif}]| The machine name where the JBI application is running. The default value is localhost. | No |
| |--user {{{|}}} -u | admin user|[{Image src='check_blue_small.gif}]| The authorized domain administration server administrative username. | Yes |
| |--passwordfile | filename |[{Image src='check_blue_small.gif}]| The name of a file containing the password entries. | Yes |
| |--target | target name {{{|}}} ''__'server'__'' {{{|}}} '''domain''' |[{Image src='check_blue.gif}]| The name of the target where the service engine resides. See [Target Option Behavior] for more details.| No |
| |--display | display type {{{|}}} ''__'general'__'' {{{|}}} \\ '''loggers''' {{{|}}} '''configuration''' {{{|}}} '''descriptor'''|[{Image src='check_blue.gif}]| Specifies what information will be shown. The default value is '''general'''. | No |
| |--help|-|[{Image src='check_blue.gif}]|Displays the help text for the command.|No |
| ||Option||Value||Option Description||Required |
| |--echo {{{|}}} -e |true {{{|}}} ''__false__'' | If true the command specified on the command line will be echoed to system output. | No |
| |--interactive{{{|}}} -I | ''__true__'' {{{|}}} false | If set to true (default), only the required password options are prompted. | No |
| |--terse {{{|}}} -t |true {{{|}}} ''__false__'' | If true, the output will be reduced to the minimal amount. | No |
| |--secure {{{|}}} -s | true {{{|}}} ''__false__'' | If set to true, uses SSL/TLS to communicate with the domain administration server. | No |
| |--port {{{|}}} -p | port number | The HTTP/S port for administration. Default port for PE: 4848, default port for EE: 4849 | No |
| |--host {{{|}}} -H | ''__localhost__'' | The machine name where the JBI application is running. The default value is localhost. | No |
| |--user {{{|}}} -u | admin user| The authorized domain administration server administrative username. | Yes |
| |--passwordfile | filename | The name of a file containing the password entries. | Yes |
| |--target | target name {{{|}}} ''__'server'__'' {{{|}}} '''domain''' | The name of the target where the service engine resides. See [Target Option Behavior] for more details.| No |
| |--configuration%%(color:green)__(*)__%% | true {{{|}}} ''__false__''| Will display the service engine configuration values. | No |
| |--loggers%%(color:green)__(*)__%% | true {{{|}}} ''__false__''| Will display the service engine loggers and their levels.| No |
| |--descriptor%%(color:green)__(*)__%% | true {{{|}}} ''__false__''| Will display the service engine XML desriptor. | No |
| |--help|-|Displays the help text for the command.|No |
| %%(color:green)__(*)__ __Added for Sierra Release__%% |
| At line 26 removed 1 line. |
| At line 29 changed 1 line. |
| examples and expected output will go here |
| Example 1: |
| show-jbi-service-engine sun-javaee-engine |
| Component Information |
| --------------------- |
| Name : sun-javaee-engine |
| State : Shutdown |
| Version : 1.0 |
| Build Number: 080809 |
| Description : Java Enterprise Edition Service Engine |
| Command show-jbi-service-engine executed successfully. |
| Example 2: |
| show-jbi-service-engine --loggers sun-javaee-engine |
| Component Information |
| --------------------- |
| Name : sun-javaee-engine |
| State : Started |
| Version : 1.0 |
| Build Number: 080809 |
| Description : Java Enterprise Edition Service Engine |
| Component Logger Levels |
| ----------------------- |
| sun-javaee-engine = INFO |
| Command show-jbi-service-engine executed successfully. |
| Example 3: |
| show-jbi-service-engine --configuration sun-javaee-engine |
| Component Information |
| --------------------- |
| Name : sun-javaee-engine |
| State : Shutdown |
| Version : 1.0 |
| Build Number: 080809 |
| Description : Java Enterprise Edition Service Engine |
| Component Configuration Values |
| ------------------------------ |
| SomeConfigValue = 1234 |
| Example 4: |
| show-jbi-service-engine --descriptor cli_test_engine1 |
| Component Information |
| --------------------- |
| Name : cli_test_engine1 |
| State : Started |
| Version : 1.0 |
| Build Number: 080809 |
| Description : cli test engine with shared namespace. |
| Component Descriptor |
| -------------------- |
| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- Example jbi.xml for a BC: --> |
| <jbi xmlns="http://java.sun.com/xml/ns/jbi" version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
| <!-- identification information about this binding --> |
| <component type="service-engine"> |
| <identification> |
| <name>cli_test_engine1</name> |
| <description> |
| cli test engine with shared namespace. |
| </description> |
| </identification> |
| <component-class-name description="The Component Lifecycle class">com.sun.jbi.ui.cli.test.engine1.rt.Engine1Runtime</component-class-name> |
| <component-class-path> |
| <path-element>lib/cli-test-engine1-rt.jar</path-element> |
| <path-element>classes</path-element> |
| </component-class-path> |
| <bootstrap-class-name>com.sun.jbi.ui.cli.test.engine1.boot.Engine1Installer</bootstrap-class-name> |
| <bootstrap-class-path> |
| <path-element>cli-test-engine1-boot.jar</path-element> |
| </bootstrap-class-path> |
| <shared-library>cli_test_sns1</shared-library> |
| </component> |
| </jbi> |
| Example 5: |
| show-jbi-service-engine --loggers --configuration --descriptor cli_test_engine1 |
| Component Information |
| --------------------- |
| Name : cli_test_engine1 |
| State : Started |
| Version : 1.0 |
| Build Number: 080809 |
| Description : cli test engine with shared namespace. |
| Component Logger Levels |
| ----------------------- |
| cli_test_engine1 = INFO |
| Component Configuration Values |
| ------------------------------ |
| SomeConfigValue = 1234 |
| Component Descriptor |
| -------------------- |
| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- Example jbi.xml for a BC: --> |
| <jbi xmlns="http://java.sun.com/xml/ns/jbi" version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
| <!-- identification information about this binding --> |
| <component type="service-engine"> |
| <identification> |
| <name>cli_test_engine1</name> |
| <description> |
| cli test engine with shared namespace. |
| </description> |
| </identification> |
| <component-class-name description="The Component Lifecycle class">com.sun.jbi.ui.cli.test.engine1.rt.Engine1Runtime</component-class-name> |
| <component-class-path> |
| <path-element>lib/cli-test-engine1-rt.jar</path-element> |
| <path-element>classes</path-element> |
| </component-class-path> |
| <bootstrap-class-name>com.sun.jbi.ui.cli.test.engine1.boot.Engine1Installer</bootstrap-class-name> |
| <bootstrap-class-path> |
| <path-element>cli-test-engine1-boot.jar</path-element> |
| </bootstrap-class-path> |
| <shared-library>cli_test_sns1</shared-library> |
| </component> |
| </jbi> |
| Command show-jbi-service-engine executed successfully. |