Sun GlassFish Enterprise Server v211 Reference Manual

[Pages:848]Sun GlassFish Enterprise Server v2.1.1 Reference Manual

Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A.

Part No: 821?0179 October 2009

Copyright 2009 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. All rights reserved.

Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more U.S. patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights ? Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. This distribution may include materials developed by third parties. Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. Sun, Sun Microsystems, the Sun logo, the Solaris logo, the Java Coffee Cup logo, docs., Java, and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. The OPEN LOOK and SunTM Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges the pioneering efforts of Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun holds a non-exclusive license from Xerox to the Xerox Graphical User Interface, which license also covers Sun's licensees who implement OPEN LOOK GUIs and otherwise comply with Sun's written license agreements. Products covered by and information contained in this publication are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical or biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited. DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Copyright 2009 Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, CA 95054 U.S.A. Tous droits r?serv?s. Sun Microsystems, Inc. d?tient les droits de propri?t? intellectuelle relatifs ? la technologie incorpor?e dans le produit qui est d?crit dans ce document. En particulier, et ce sans limitation, ces droits de propri?t? intellectuelle peuvent inclure un ou plusieurs brevets am?ricains ou des applications de brevet en attente aux Etats-Unis et dans d'autres pays. Cette distribution peut comprendre des composants d?velopp?s par des tierces personnes. Certaines composants de ce produit peuvent ?tre d?riv?es du logiciel Berkeley BSD, licenci?s par l'Universit? de Californie. UNIX est une marque d?pos?e aux Etats-Unis et dans d'autres pays; elle est licenci?e exclusivement par X/Open Company, Ltd. Sun, Sun Microsystems, le logo Sun, le logo Solaris, le logo Java Coffee Cup, docs., Java et Solaris sont des marques de fabrique ou des marques d?pos?es de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays. Toutes les marques SPARC sont utilis?es sous licence et sont des marques de fabrique ou des marques d?pos?es de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont bas?s sur une architecture d?velopp?e par Sun Microsystems, Inc. L'interface d'utilisation graphique OPEN LOOK et Sun a ?t? d?velopp?e par Sun Microsystems, Inc. pour ses utilisateurs et licenci?s. Sun reconna?t les efforts de pionniers de Xerox pour la recherche et le d?veloppement du concept des interfaces d'utilisation visuelle ou graphique pour l'industrie de l'informatique. Sun d?tient une licence non exclusive de Xerox sur l'interface d'utilisation graphique Xerox, cette licence couvrant ?galement les licenci?s de Sun qui mettent en place l'interface d'utilisation graphique OPEN LOOK et qui, en outre, se conforment aux licences ?crites de Sun. Les produits qui font l'objet de cette publication et les informations qu'il contient sont r?gis par la legislation am?ricaine en mati?re de contr?le des exportations et peuvent ?tre soumis au droit d'autres pays dans le domaine des exportations et importations. Les utilisations finales, ou utilisateurs finaux, pour des armes nucl?aires, des missiles, des armes chimiques ou biologiques ou pour le nucl?aire maritime, directement ou indirectement, sont strictement interdites. Les exportations ou r?exportations vers des pays sous embargo des Etats-Unis, ou vers des entit?s figurant sur les listes d'exclusion d'exportation am?ricaines, y compris, mais de mani?re non exclusive, la liste de personnes qui font objet d'un ordre de ne pas participer, d'une fa?on directe ou indirecte, aux exportations des produits ou des services qui sont r?gis par la legislation am?ricaine en mati?re de contr?le des exportations et la liste de ressortissants sp?cifiquement design?s, sont rigoureusement interdites. LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.

091102@22749

Contents

Preface ...................................................................................................................................................13

Sun GlassFish Enterprise Server Section 1: Administration Commands ................................... 15 add-resources(1) .................................................................................................................................. 16 apply-http-lb-changes(1) ................................................................................................................... 20 asadmin(1) ........................................................................................................................................... 22 backup-domain(1) .............................................................................................................................. 26 clear-ha-store(1) .................................................................................................................................. 28 change-admin-password(1) ............................................................................................................... 31 change-master-password(1) .............................................................................................................. 32 configure-ha-cluster(1) ...................................................................................................................... 34 configure-ha-persistence(1) ............................................................................................................... 39 configure-lb-weight(1) ....................................................................................................................... 43 configure-webservice-management(1) ............................................................................................ 46 copy-config(1) ..................................................................................................................................... 49 create-admin-object(1) ....................................................................................................................... 52 create-application-ref(1) .................................................................................................................... 55 create-audit-module(1) ...................................................................................................................... 58 create-auth-realm(1) ........................................................................................................................... 61 create-cluster(1) ................................................................................................................................... 64 create-connector-connection-pool(1) .............................................................................................. 69 create-connector-resource(1) ............................................................................................................ 73 create-connector-security-map(1) .................................................................................................... 76 create-custom-resource(1) ................................................................................................................. 79 create-domain(1) ................................................................................................................................. 82 create-file-user(1) ................................................................................................................................ 88 create-ha-store(1) ................................................................................................................................ 91 create-http-health-checker(1) ........................................................................................................... 94

3

Contents 4

create-http-lb(1) .................................................................................................................................. 97 create-http-lb-config(1) .................................................................................................................... 102 create-http-lb-ref(1) .......................................................................................................................... 106 create-http-listener(1) ...................................................................................................................... 111 create-instance(1) .............................................................................................................................. 115 create-iiop-listener(1) ....................................................................................................................... 120 create-javamail-resource(1) ............................................................................................................. 123 create-jbi-application-configuration(1) ......................................................................................... 127 create-jbi-application-variable(1) ................................................................................................... 130 create-jdbc-connection-pool(1) ...................................................................................................... 133 create-jdbc-resource(1) .................................................................................................................... 139 create-jmsdest(1) ............................................................................................................................... 142 create-jms-host(1) ............................................................................................................................. 145 create-jms-resource(1) ..................................................................................................................... 148 create-jndi-resource(1) ..................................................................................................................... 154 create-jvm-options(1) ....................................................................................................................... 158 create-lifecycle-module(1) ............................................................................................................... 161 create-management-rule(1) ............................................................................................................. 164 create-mbean(1) ................................................................................................................................ 172 create-message-security-provider(1) .............................................................................................. 176 create-node-agent(1) ........................................................................................................................ 180 create-node-agent-config(1) ............................................................................................................ 183 create-password-alias(1) .................................................................................................................. 186 create-persistence-resource(1) ........................................................................................................ 189 create-profiler(1) ............................................................................................................................... 193 create-resource-adapter-config(1) .................................................................................................. 196 create-resource-ref(1) ....................................................................................................................... 199 create-service(1) ................................................................................................................................ 202 create-ssl(1) ........................................................................................................................................ 204 create-system-properties(1) ............................................................................................................. 208 create-threadpool(1) ......................................................................................................................... 210 create-transformation-rule(1) ......................................................................................................... 213 create-virtual-server(1) ..................................................................................................................... 216 delete-admin-object(1) ..................................................................................................................... 223 delete-application-ref(1) .................................................................................................................. 226 delete-audit-module(1) .................................................................................................................... 229

Sun GlassFish Enterprise Server v2.1.1 Reference Manual ? October 2009

Contents

delete-auth-realm(1) ......................................................................................................................... 232 delete-cluster(1) ................................................................................................................................. 235 delete-config(1) .................................................................................................................................. 238 delete-connector-connection-pool(1) ............................................................................................ 241 delete-connector-resource(1) .......................................................................................................... 244 delete-connector-security-map(1) .................................................................................................. 247 delete-custom-resource(1) ............................................................................................................... 250 delete-domain(1) ............................................................................................................................... 253 delete-file-user(1) .............................................................................................................................. 254 delete-http-health-checker(1) ......................................................................................................... 257 delete-http-lb(1) ................................................................................................................................ 260 delete-http-lb-config(1) .................................................................................................................... 262 delete-http-lb-ref(1) .......................................................................................................................... 265 delete-http-listener(1) ....................................................................................................................... 268 delete-iiop-listener(1) ....................................................................................................................... 271 delete-instance(1) .............................................................................................................................. 274 delete-javamail-resource(1) ............................................................................................................. 276 delete-jbi-application-configuration(1) ......................................................................................... 279 delete-jbi-application-variable(1) ................................................................................................... 282 delete-jdbc-connection-pool(1) ...................................................................................................... 285 delete-jdbc-resource(1) .................................................................................................................... 288 delete-jmsdest(1) ............................................................................................................................... 291 delete-jms-host(1) ............................................................................................................................. 294 delete-jms-resource(1) ..................................................................................................................... 297 delete-jndi-resource(1) ..................................................................................................................... 300 delete-jvm-options(1) ....................................................................................................................... 303 delete-lifecycle-module(1) ............................................................................................................... 306 delete-management-rule(1) ............................................................................................................. 309 delete-mbean(1) ................................................................................................................................ 312 delete-message-security-provider(1) .............................................................................................. 315 delete-node-agent(1) ........................................................................................................................ 318 delete-node-agent-config(1) ............................................................................................................ 319 delete-password-alias(1) .................................................................................................................. 322 delete-persistence-resource(1) ........................................................................................................ 324 delete-profiler(1) ............................................................................................................................... 327 delete-resource-adapter-config(1) .................................................................................................. 330

5

Contents 6

delete-resource-ref(1) ....................................................................................................................... 333 delete-ssl(1) ........................................................................................................................................ 336 delete-system-property(1) ................................................................................................................ 339 delete-threadpool(1) ......................................................................................................................... 342 delete-transformation-rule(1) ......................................................................................................... 345 delete-virtual-server(1) ..................................................................................................................... 348 deploy(1) ............................................................................................................................................ 351 deploydir(1) ....................................................................................................................................... 357 deploy-jbi-service-assembly(1) ....................................................................................................... 363 disable(1) ............................................................................................................................................ 366 disable-http-lb-application(1) ......................................................................................................... 369 disable-http-lb-server(1) .................................................................................................................. 372 display-error-distribution(1) ........................................................................................................... 375 display-error-statistics(1) ................................................................................................................. 378 display-license(1) .............................................................................................................................. 381 display-log-records(1) ...................................................................................................................... 384 enable(1) ............................................................................................................................................. 388 enable-http-lb-application(1) .......................................................................................................... 391 enable-http-lb-server(1) ................................................................................................................... 394 export(1) ............................................................................................................................................. 397 export-http-lb-config(1) ................................................................................................................... 398 export-jbi-application-environment(1) ......................................................................................... 402 flush-jmsdest(1) ................................................................................................................................. 405 freeze-transaction-service(1) ........................................................................................................... 408 generate-diagnostic-report(1) ......................................................................................................... 411 generate-jvm-report(1) ..................................................................................................................... 415 get-client-stubs(1) ............................................................................................................................. 418 get(1) ................................................................................................................................................... 421 get-health(1) ....................................................................................................................................... 433 help(1) ................................................................................................................................................. 435 install-jbi-component(1) .................................................................................................................. 451 install-jbi-shared-library(1) ............................................................................................................. 454 install-license(1) ................................................................................................................................ 457 jms-ping(1) ......................................................................................................................................... 458 list(1) ................................................................................................................................................... 461 list-acls(1) ........................................................................................................................................... 471

Sun GlassFish Enterprise Server v2.1.1 Reference Manual ? October 2009

Contents

list-admin-objects(1) ........................................................................................................................ 472 list-application-refs(1) ...................................................................................................................... 475 list-audit-modules(1) ........................................................................................................................ 478 list-auth-realms(1) ............................................................................................................................ 481 list-backups(1) ................................................................................................................................... 484 list-clusters(1) .................................................................................................................................... 485 list-components(1) ............................................................................................................................ 488 list-configs(1) ..................................................................................................................................... 491 list-connector-connection-pools(1) ............................................................................................... 494 list-connector-resources(1) .............................................................................................................. 496 list-connector-security-maps(1) ..................................................................................................... 499 list-custom-resources(1) .................................................................................................................. 502 list-domains(1) .................................................................................................................................. 505 list-file-groups(1) .............................................................................................................................. 506 list-file-users(1) .................................................................................................................................. 509 list-http-lb-configs(1) ....................................................................................................................... 512 list-http-lbs(1) .................................................................................................................................... 515 list-http-listeners(1) .......................................................................................................................... 517 list-iiop-listeners(1) .......................................................................................................................... 520 list-instances(1) ................................................................................................................................. 523 list-javamail-resources(1) ................................................................................................................. 526 list-jbi-application-configurations(1) ............................................................................................. 529 list-jbi-application-variables(1) ....................................................................................................... 532 list-jbi-binding-components(1) ...................................................................................................... 535 list-jbi-service-assemblies(1) ........................................................................................................... 538 list-jbi-service-engines(1) ................................................................................................................ 541 list-jbi-shared-libraries(1) ................................................................................................................ 544 list-jdbc-connection-pools(1) .......................................................................................................... 547 list-jdbc-resources(1) ........................................................................................................................ 549 list-jmsdest(1) .................................................................................................................................... 552 list-jms-hosts(1) ................................................................................................................................. 555 list-jms-resources(1) ......................................................................................................................... 558 list-jndi-entries(1) ............................................................................................................................. 561 list-jndi-resources(1) ........................................................................................................................ 564 list-lifecycle-modules(1) ................................................................................................................... 567 list-management-rules(1) ................................................................................................................ 570

7

Contents 8

list-mbeans(1) .................................................................................................................................... 573 list-message-security-providers(1) ................................................................................................. 576 list-node-agents(1) ............................................................................................................................ 579 list-password-aliases(1) .................................................................................................................... 582 list-persistence-resources(1) ............................................................................................................ 584 list-registry-locations(1) ................................................................................................................... 587 list-resource-adapter-configs(1) ...................................................................................................... 589 list-resource-refs(1) ........................................................................................................................... 592 list-sub-components(1) .................................................................................................................... 595 list-system-properties(1) .................................................................................................................. 598 list-threadpools(1) ............................................................................................................................. 601 list-timers(1) ...................................................................................................................................... 604 list-transformation-rules(1) ............................................................................................................. 607 list-virtual-servers(1) ........................................................................................................................ 610 login(1) ............................................................................................................................................... 613 migrate-timers(1) .............................................................................................................................. 616 monitor(1) .......................................................................................................................................... 619 multimode(1) ..................................................................................................................................... 624 ping-connection-pool(1) .................................................................................................................. 625 publish-to-registry(1) ....................................................................................................................... 628 recover-transactions(1) .................................................................................................................... 631 remove-ha-cluster(1) ........................................................................................................................ 634 restore-domain(1) ............................................................................................................................. 637 rollback-transaction(1) ..................................................................................................................... 639 set(1) .................................................................................................................................................... 642 set-jbi-component-configuration(1) .............................................................................................. 650 set-jbi-component-logger(1) ........................................................................................................... 653 set-jbi-runtime-configuration(1) .................................................................................................... 656 set-jbi-runtime-logger(1) ................................................................................................................. 659 show-component-status(1) .............................................................................................................. 662 show-jbi-application-configuration(1) .......................................................................................... 665 show-jbi-binding-component(1) .................................................................................................... 668 show-jbi-runtime-configuration(1) ................................................................................................ 671 show-jbi-runtime-loggers(1) ........................................................................................................... 674 show-jbi-service-assembly(1) .......................................................................................................... 676 show-jbi-service-engine(1) .............................................................................................................. 679

Sun GlassFish Enterprise Server v2.1.1 Reference Manual ? October 2009

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download