AdminApp 对象的命令.doc

AdminApp 对象的命令AdminApp 对象的命令使用 AdminApp 对象来安装、修改和管理应用程序。AdminApp 对象与 WebSphere Application Server 管理和配置服务进行交互，以进行应用程序查询和更改。此交互包含安装和卸载应用程序、列出模块、导出等等。如果您只要使用本地操作，那么当无服务器运行时您可启动脚本客户机。要以本地方式运行，使用 -conntype NONE 选项启动脚本客户机。您会接收到正在以本地方式运行的消息。建议服务器运行的时候不要以本地方式运行 AdminApp 对象。这是因为以本地方式进行的任何配置更改将不会反映到正在运行的服务器配置中，反之亦然。如果您保存冲突的配置，那么会毁坏配置。下列命令可用于 AdminApp 对象：deleteUserAndGroupEntries edit editInteractive export exportDDL getDeployStatus help install installInteractive list listModules options publishWSDL searchJNDIReferences taskinfo uninstall update updateAccessIDs updateInteractive view =deleteUserAndGroupEntries 使用 deleteUserAndGroupEntries 命令来删除所有角色的用户或组，以及删除在应用程序中定义的所有 RunAs 角色的用户标识和密码。目标对象无。必需参数application name 指定感兴趣的应用程序。 可选参数无。示例使用 Jacl：$AdminApp deleteUserAndGroupEntries myapp使用 Jython 字符串：print AdminApp.deleteUserAndGroupEntries(myapp)=edit 使用 edit 命令以批处理方式编辑应用程序或模块。edit 命令将使用 options 参数指定的选项来更改由 application name 参数指定的应用程序。edit 命令不需要选项。目标对象无。必需参数application name 指定感兴趣的应用程序。 options 指定要应用于应用程序或模块配置的选项。 可选参数无。示例使用 Jacl：$AdminApp edit JavaMail Sample -MapWebModToVH JavaMail Sample WebApp mtcomps.war,WEB-INF/web.xml newVH使用 Jython 字符串：print AdminApp.edit(JavaMail Sample, -MapWebModToVH JavaMail 32 Sample WebApp mtcomps.war,WEB-INF/web.xml newVH)=editInteractive 使用 editInteractive 命令以交互方式编辑应用程序或模块。editInteractive 命令将更改应用程序部署。在 options 参数中指定这些更改。editInteractive 命令不需要选项。目标对象无。必需参数application name 指定感兴趣的应用程序。 options 指定要应用于应用程序或模块配置的选项。 可选参数无。示例使用 Jacl：$AdminApp editInteractive ivtApp 使用 Jython 字符串：print AdminApp.editInteractive(ivtApp)=export 使用 export 命令将 application name 参数导出到您通过 file name 指定的文件中。目标对象无。必需参数application name 指定感兴趣的应用程序。 file name 指定要将应用程序名称导出至的文件名。 可选参数无。示例使用 Jacl：$AdminApp export My App /usr/me/myapp.ear 使用 Jython 字符串：print AdminApp.export(My App, /usr/me/myapp.ear)=exportDDL 使用 exportDDL 命令将数据定义语言（DDL）从 application name 参数抽取到目录指定的 directory name 参数。options 参数是可选的。目标对象无。必需参数application name 指定感兴趣的应用程序。 directory name 指定要将应用程序名称导出至的目录的名称。 可选参数options 指定要传递给指定的应用程序名称的选项。 示例使用 Jacl：$AdminApp exportDDL My App /usr/me/DDL -ddlprefix myApp使用 Jython 字符串：print AdminApp.exportDDL(My App, /usr/me/DDL, -ddlprefix myApp)=getDeployStatus 使用 getDeployStatus 命令显示应用程序的部署状态。安装或更新大型应用程序后，请使用此命令来显示应用程序二进制文件扩展的详细状态信息。在系统抽取应用程序二进制文件后，您才能启动该应用程序。目标对象无。必需参数application name 指定所需应用程序的名称。 可选参数无。示例使用 Jacl：$AdminApp getDeployStatus myApplication使用 Jython：print AdminApp.getDeployStatus(myApplication)=help 使用 help 命令来显示有关 AdminApp 对象的一般帮助信息。目标对象无。必需参数无。可选参数operation name 指定此选项以显示有关 AdminApp 命令或安装选项的帮助。 样本输出如果您未指定参数，那么将返回以下输出：WASX7095I: The AdminApp object allows application objects to be manipulated including installing, uninstalling,editing, and listing. Most of the commands supported by AdminApp operate in two modes: the default mode is onein which AdminApp communicates with the WebSphere Application Server to accomplish its tasks. A local mode is alsopossible, in which no server communication takes place. The local mode of operation is invoked by including the-conntype NONE flag in the option string supplied to the command.The following commands are supported by AdminApp; more detailed information about each of these commandsis available by using the help command of AdminApp and supplying the name of the command as an argument.edit Edit the properties of an applicationeditInteractive Edit the properties of an application interactivelyexport Export application to a fileexportDDL Extract DDL from application to a directoryhelp Show help informationinstall Installs an application, given a file name and an option string.installInteractiveInstalls an application in interactive mode, given a file name and an option string.list List all installed applicationslistModules List the modules in a specifiedapplication options Shows the options available, either for a given file, or in general.taskInfo Shows detailed information pertaining to a given installation task for a given fileuninstall Uninstalls an application, given an application name and an option string如果您将 operation name 参数的值指定为 uninstall，那么将返回以下输出：WASX7102I: Method: uninstallArguments: application name, optionsDescription: Uninstalls application named by application name using the options supplied by String 2.Method: uninstallArguments: application nameDescription: Uninstalls the application specified by application name using default options.示例使用 Jacl：以下示例未指定任何参数： $AdminApp help以下示例指定了 operation name 参数：$AdminApp help uninstall使用 Jython：以下示例未指定任何参数： print AdminApp.help()以下示例指定了 operation name 参数：print AdminApp.help(uninstall)=install 使用 install 命令并提供标准文件名和安装选项字符串来以非交互方式安装应用程序。options 参数是可选的。目标对象无。必需参数ear file 指定要安装的 .ear 文件的路径。 可选参数options 指定命令的安装选项。 示例使用 Jacl：$AdminApp install c:/apps/myapp.ear使用 Jython：print AdminApp.install(c:/apps/myapp.ear)此命令可以使用许多选项。您可以使用以下命令获取企业归档（EAR）文件的有效选项列表：使用 Jacl：$AdminApp options myApp.ear使用 Jython：print AdminApp.options(myApp.ear)您还可以使用以下命令获取每个对象的帮助：使用 Jacl：$AdminApp help MapModulesToServers使用 Jython：print AdminApp.help(MapModulesToServers)=installInteractive 使用 installInteractive 命令并提供标准文件名和安装选项字符串来以交互方式安装应用程序。options 参数是可选的。目标对象无。必需参数ear file 指定要安装的 .ear 文件的路径。 可选参数options 指定命令的安装选项。 示例使用 Jacl：$AdminApp installInteractive c:/websphere/appserver/installableApps/jmsample.ear使用 Jython：print AdminApp.installInteractive(c:/websphere/appserver/installableApps/jmsample.ear)isAppReady 使用 isAppReady 命令来确定是否已分发并且已准备好运行所指定的应用程序。如果应用程序已准备就绪，那么返回值 true，如果应用程序未准备就绪，那么返回值 false。当 wsadmin 工具未连接到服务器时，此命令不受支持。目标对象无。必需参数application name 指定所需应用程序的名称。 可选参数ignoreUnknownState 测试是否已分发并且已准备好运行所指定的应用程序。ignoreUnknownState 参数的有效值包括 true 和 false。如果您指定值 true，那么具有未知状态的节点和服务器将不会包括在最终的就绪返回中。如果应用程序已准备就绪，那么命令返回值 true，如果应用程序未准备就绪，那么返回值 false。当 wsadmin 工具未连接到服务器时，此命令不受支持。 样本输出如果指定了 application name 参数，那么将返回以下样本输出：ADMA5071I: Distribution status check started for application DefaultApplication.WebSphere:cell=Node03Cell,node=myNode,distribution=trueADMA5011I: The cleanup of the temp directory for application DefaultApplication is complete.ADMA5072I: Distribution status check completed for application DefaultApplication.true如果指定了 application name 和 ignoreUnknownState 参数，那么将返回以下样本输出：ADMA5071I: Distribution status check started for application TEST.WebSphere:cell=myCell,node=myNode,distribution=unknownADMA5011I: The cleanup of the temp directory for application TEST is complete.ADMA5072I: Distribution status check completed for application TEST.false示例下列示例仅指定了 application name 参数：使用 Jacl：$AdminApp isAppReady DefaultApplication使用 Jython：print AdminApp.isAppReady(DefaultApplication)下列示例指定了 application name 和 ignoreUnknownState 参数：使用 Jacl：$AdminApp isAppReady TEST true使用 Jython：print AdminApp.isAppReady(TEST, true)=list 使用 list 命令来列示配置中已安装的应用程序。目标对象无。必需参数无。可选参数无。样本输出adminconsoleDefaultApplication ivtApp示例使用 Jacl：$AdminApp list使用 Jython：print AdminApp.list()listModules 使用 listModules 命令来列示应用程序中的模块。目标对象无。必需参数application name 指定感兴趣的应用程序。 可选参数options 指定安装了模块的应用程序服务器的列表。options 参数是可选的。有效选项为 -server。 样本输出以下示例由 appname、#、模块 URI、+ 和 DD URI 并置而成。您可将此字符串传递到 edit 和 editInteractive AdminApp 命令。ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml ivtApp#ivt_app.war+WEB-INF/web.xml示例使用 Jacl：$AdminApp listModules ivtApp使用 Jython：print AdminApp.listModules(ivtApp)options 使用 options 命令来显示用于安装企业归档（EAR）文件的选项列表。目标对象无。必需参数无。可选参数EAR 文件 指定感兴趣的 EAR 文件。 application name 指定要对其显示用于编辑现有应用程序的选项列表的应用程序。 application module name 指定要对其显示用于编辑现有应用程序中的模块的选项列表的模块名。此参数需要与由 listModules 命令返回的输出相同的模块名称格式。 file, operations 显示用于安装或更新应用程序或应用程序模块文件的选项列表。指定下列其中一个有效值：installapp 使用此选项来安装所指定的文件。 updateapp 使用此选项并用已指定的文件来更新现有应用程序。 addmodule 使用此选项来将指定的模块文件添加至现有应用程序。 updatemodule 使用此选项并用已指定的模块文件来更新应用程序中的现有模块。 样本输出WASX7112I: The following options are valid for ivtAppMapRolesToUsersBindJndiForEJBNonMessageBindingMapEJBRefToEJBMapWebModToVHMapModulesToServersdistributeAppnodistributeAppuseMetaDataFromBinarynouseMetaDataFromBinarycreateMBeansForResourcesnocreateMBeansForResourcesreloadEnablednoreloadEnabledverboseinstalled.ear.destinationreloadInterval示例以下示例 options 命令将返回 EAR 文件的有效选项：使用 Jacl：$AdminApp options c:/websphere/appserver/installableApps/ivtApp.ear使用 Jython：print AdminApp.options(c:/websphere/appserver/installableApps/ivtApp.ear)以下示例 options 命令将返回应用程序的有效选项：使用 Jacl：$AdminApp options ivtApp使用 Jython：print AdminApp.options(ivtApp)以下示例 options 命令将返回应用程序模块的有效选项：使用 Jacl：$AdminApp options ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml使用 Jython：print AdminApp.options(ivtApp#ivtEJB.jar+META-INF/ejb-jar.xml)以下示例 options 命令将返回输入文件请求的操作可以使用的有效选项：使用 Jacl：$AdminApp options c:/websphere/appserver/installableApps/ivtApp.ear updateapp使用 Jython：print AdminApp.options(c:/websphere/appserver/installableApps/ivtApp.ear, updateapp)publishWSDL 使用 publishWSDL 命令将在 application name 参数中指定的应用程序的 Web 服务描述语言（WSDL）文件发布到在 file name 参数中指定的文件。目标对象无。必需参数file name 指定感兴趣的文件。 application name 指定感兴趣的应用程序。 可选参数SOAP address prefixes 指定要使用的 SOAP 地址前缀。 样本输出publishWSDL 命令不会返回输出。示例以下示例 publishWSDL 命令将指定应用程序名称和文件名：使用 Jacl：$AdminApp publishWSDL JAXRPCHandlerServer c:/temp/a.zip使用 Jython：print AdminApp.publishWSDL(JAXRPCHandlerServer, c:/temp/a.zip)以下示例 publishWSDL 命令将指定应用程序名称、文件名和 SOAP 地址前缀参数值：使用 Jacl：$AdminApp publishWSDL JAXRPCHandlersServer c:/temp/a.zip JAXRPCHandlersServerApp.war http http:/localhost:9080使用 Jython：print AdminApp.publishWSDL(JAXRPCHandlersServer, c:/temp/a.zip, JAXRPCHandlersServerApp.war http http:/localhost:9080)searchJNDIReferences 使用 searchJNDIReferences 命令来列示特定节点上引用了 Java 命名和目录接口（JNDI）名称的应用程序。目标对象无。必需参数node configuration ID 指定感兴趣的节点的配置标识。 可选参数options 指定要使用的选项。 样本输出WASX7410W: This operation may take a while depending on the number of applications installed in your system.MyAppMapResRefToEJB :ejb-jar-ic.jar : eis/J2CCF1示例以下示例假定已经安装了一个名为 MyApp 的应用程序，它的 JNDI 名称为 eis/J2CCF1：使用 Jacl：$AdminApp searchJNDIReferences $node -JNDIName eis/J2CCF1 -verbose使用 Jython：print AdminApp.searchJNDIReferences(node, -JNDIName eis/J2CCF1 -verbose)taskinfo 使用 taskinfo 命令以提供有关应用程序文件的特定任务选项的信息。在 V5.x 和 V6.x 中，执行相似或完全相同操作的许多任务名称是不同的。如果要从 V5.x 迁移至 V6.x，那么可能需要更新现有脚本。目标对象无。必需参数EAR 文件 指定感兴趣的 EAR 文件。 task name 指定要对其请求信息的任务。 可选参数无。样本输出MapWebModToVH: Selecting virtual hosts for Web modulesSpecify the virtual host where you want to install the Web modules that are contained inyour application. Web modules can be installed on the same virtual host or dispersed among several hosts.Each element of the MapWebModToVH task consists of the following three fields: webModule, uri, virtualHost.Of these fields, the following fields might be assigned new values: virtualHostand the following arerequired: virtualHostThe current contents of the task after running default bindings are:webModule: JavaMail Sample WebAppuri: mtcomps.war,WEB-INF/web.xmlvirtualHost: default_host示例使用 Jacl：$AdminApp taskInfo c:/websphere/appserver/installableApps/jmsample.ear MapWebModToVH使用 Jython：print AdminApp.taskInfo(c:/websphere/appserver/installableApps/jmsample.ear, MapWebModToVH)uninstall 使用 uninstall 命令来卸载现有应用程序。目标对象无。必需参数application name 指定要卸载的应用程序的名称。 可选参数无。样本输出ADMA5017I: Uninstallation of myapp started.ADMA5104I: Server index entry for myCellManager was updated successfully.ADMA5102I: Deletion of config data for myapp from config repository completed successfully.ADMA5011I: Cleanup of temp dir for app myapp done.ADMA5106I: Application myapp uninstalled successfully.示例使用 Jacl：$AdminApp uninstall myApp使用 Jython：print AdminApp.uninstall(myApp)update 使用 update 命令以非交互方式更新应用程序。此命令支持对应用程序子组件或整个应用程序进行添加、除去和更新。提供应用程序名、content type 和更新选项。目标对象无。必需参数application name 指定要更新的应用程序的名称。 content type 使用 content type 参数表明您要更新部分应用程序，还是整个应用程序。以下列表包含 update 命令的有效 content type 值：app 表明您要更新整个应用程序。此选项与使用 install 命令指出 update 选项是相同的。使用 app 值作为 content type，您必须将 update 操作选项指定为值。使用内容选项提供新的企业归档文件（EAR）文件。您还可指定绑定信息和应用程序选项。缺省情况下，已安装模块的绑定信息合并在已更新模块的绑定信息中。要更改此缺省行为，指定 update.ignore.old 选项或 update.ignore.new 选项。 file 表明您要更新单个文件。您可在已部署应用程序中的任何作用域内添加、除去或更新个别文件。使用 file 值作为 content type，您必须使用 operation 选项对文件执行操作。根据 operation 的类型，需要更多选项。对于文件添加和更新，您必须使用 contents 选项和 conetnturi 选项提供文件内容和相对于 EAR 文件根的文件 URI。对于文件删除，您必须使用 contenturi 选项提供相对于 EAR 文件根的文件 URI，这是唯一需要的输入。您提供的任何其他选项都将被忽略。 modulefile 表明您要更新模块。您可添加、除去或更新单个应用程序模块。如果您指定 modulefile 值作为 content type，您必须使用 operation 选项表明您要对模块执行的操作。根据 operation 的类型，需要更多选项。对于安装新模块或更新应用程序中现有模块，您必须使用 contents 选项和 conetnturi 选项表明文件内容和相对于 EAR 文件根的文件 URI。您还可指定适用于新模块或已更新模块的绑定信息和应用程序选项。对于模块更新，缺省情况下，已安装模块的绑定信息合并在输入模块的绑定信息中。要更改此缺省行为，指定 update.ignore.old 选项或 update.ignore.new 选项。要删除模块，表明相对于 EAR 文件根的文件 URI。 partialapp 表明您要更新部分应用程序。您可以使用以 zip 文件格式提供的应用程序组件子集，更新、添加和删除文件和模块。该 zip 文件不是有效的 Java 2 Platform, Enterprise Edition（J2EE）归档。然而，它以 EAR 文件中显示应用程序 artifact 的相同分层构造包含这些应用程序 artifact。要获得有关如何构造部分应用程序 zip 文件的更多信息，请参阅 Java API 部分。如果您将 partialapp 值指定为 content type，使用 contents 选项指定 zip 文件的位置。当提供部分应用程序作为更新输入时，无法指定绑定信息和应用程序选项，但如果已提供将忽略它们。 可选参数options 有许多选项可用于 update 命令。有关 update 命令的每个有效选项的列表，请参阅AdminApp 对象的 install、installInteractive、edit、editInteractive、update 和 updateInteractive 命令的选项 。 样本输出Update of singleFile has started.ADMA5009I: Application archive extracted at C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0extAdded files from partial ear: performFileOperation: source=C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0ext,dest=C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0mrg, uri= META-INF/web.xml, op= addCopying file from C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0ext/META-INF/web.xml to C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0mrgMETA-INFweb.xmlCollapse list is: FileMergeTask completed successfullyADMA5005I: Application singleFile configured in WebSphere repositorydelFiles: delM: nulladdM: nullPattern for remove loose and mod:Loose add pattern: META-INF/*|WEB-INF/*|.*wsdlroot file to be copied: META-INF/web.xml to C:asvb0403.04WebSphereAppServerwstempScriptfb5a191b4eworkspacecellsBAMBIEapplicationssingleFile.eardeploymentssingleFile/META-INF/web.xmlADMA5005I: Application singleFile configured in WebSphere repository xmlDoc: #document: nullroot element: app-delta: null* delta file name: C:asvb0403.04WebSphereAppServerwstempScriptfb5a191b4eworkspacecellsBAMBIEapplicationssingleFile.ear/deltas/delta-1079548405564ADMA5005I: Application singleFile configured in WebSphere repositoryADMA6011I: Deleting directory tree C:DOCUME1lavenaLOCALS1Tempapp_fb5a1960f0ADMA5011I: Cleanup of temp dir for app singleFile done.Update of singleFile has ended.示例使用 Jacl：$AdminApp update myApp file -operation add -contents c:/apps/myApp/web.xml -contenturi META-INF/web.xml使用 Jython：print AdminApp.update(myApp, file, -operation add -contents c:/apps/myApp/web.xml -contenturi META-INF/web.xml)使用 Jython 列表：print AdminApp.update(myApp, file, -operation, add, -contents, c:/apps/myApp/web.xml, -contenturi, META-INF/web.xml)updateAccessIDs 使用 updateAccessIDs 命令来更新为应用程序中定义的各种角色指定的用户和组的访问标识信息。系统将从用户注册表中读取访问标识，并将这些标识保存在应用程序绑定中。此操作将提高应用程序的运行时性能。在安装应用程序之后或者编辑已安装应用程序的特定于安全角色的信息之后使用此命令。当 wsadmin 工具的 -conntype 选项设置为 NONE 时不能调用此方法。您必须连接到服务器以调用此命令。目标对象无。必需参数application name 指定所需应用程序的名称。 可选参数bALL bALL 布尔参数将检索和保存应用程序绑定中的用户和组的所有访问标识。指定 false 就会检索在应用程序绑定中没有访问标识的用户或组的访问标识。 样本输出ADMA5017I: Uninstallation of myapp started.ADMA5104I: Server index entry for myCellManager was updated successfully.ADMA5102I: Deletion of config data for myapp from config repository completed successfully.ADMA5011I: Cleanup of temp dir for app myapp done.ADMA5106I: Application myapp uninstalled successfully.示例使用 Jacl：$AdminApp updateAccessIDs myapp true使用 Jython：print AdminApp.updateAccessIDs(myapp, true)updateInteractive 使用 updateInteractive 命令添加、除去和更新应用程序子组件或整个应用程序。当您使用交互方式更新应用程序模块或整个应用程序时，您用于配置绑定信息的步骤类似于应用于 installInteractive 命令的步骤。如果您更新文件或部分应用程序，您不可以使用用于配置绑定信息的步骤。在这种情况下，使用的步骤与您使用 update 命令的步骤相同。目标对象无。必需参数application name 指定要更新的应用程序的名称。 content type 使用 content type 参数表明您要更新部分应用程序，还是整个应用程序。以下列表包含 updateInteractive 命令的有效 content type 值：app 表明您要更新整个应用程序。此选项与使用 install 命令指出 update 选项是相同的。使用 app 值作为 content type，您必须将 update 操作选项指定为值。使用内容选项提供新的企业归档文件（EAR）文件。您还可指定绑定信息和应用程序选项。缺省情况下，已安装模块的绑定信息合并在已更新模块的绑定信息中。要更改此缺省行为，指定 update.ignore.old 选项或 update.ignore.new 选项。 file 表明您要更新单个文件。您可在已部署应用程序中的任何作用域内添加、除去或更新个别文件。使用 file 值作为 content type，您必须使用 operation 选项对文件执行操作。根据 operation 的类型，需要更多选项。对于文件添加和更新，您必须使用 contents 选项和 conetnturi 选项提供文件内容和相对于 EAR 文件根的文件 URI。对于文件删除，您必须使用 contenturi 选项提供相对于 EAR 文件根的文件 URI，这是唯一需要的输入。您提供的任何其他