WAS的manageprofiles.sh对创建概要文件过程中的参数配置解析

WAS概要文件的作用：概要文件定义运行时环境，所以学会使用manageprofiles创建profile是掌握好WAS的基本功~本博文主要介绍了如何使用 manageprofiles 命令来创建、删除、扩充、备份和复原概要文件。

注意：manageprofiles 命令及其图形用户界面（概要文件管理工具）是用于创建运行时环境的唯一方式。

一、manageprofiles.sh的功能简介：

manageprofiles 命令用来执行下列任务：

• 创建概要文件 (-create)

• 删除概要文件 (-delete)

• 扩充概要文件 (-augment)

• 对概要文件取消扩充 (-unaugment)

• 对已通过特定扩充模板来扩充的所有概要文件取消扩充 (-unaugmentAll)

• 删除所有概要文件 (-deleteAll)

• 列出所有概要文件 (-listProfiles)

• 列出对概要文件的扩充 (-listAugments)

• 获取概要文件名称 (-getName)

• 获取概要文件路径 (-getPath)

• 验证概要文件注册表 (-validateRegistry)

• 验证并更新概要文件注册表 (-validateAndUpdateRegistry)

• 获取缺省概要文件名称 (-getDefaultName)

• 备份概要文件 (-backupProfile)

• 恢复概要文件 (-restoreProfile)

• 执行响应文件中包含的 manageprofiles 命令任务 (-response)

对于用 manageprofiles 命令完成的每个任务，要在包括必需参数时获取详细的帮助，使用 -help 参数。以下示例在Linux操作系统上将 help 参数与 manageprofiles -augment 命令配合使用：

~/bin/manageprofiles.sh -augment -help

命令行工具验证是否提供了必需参数以及对这些参数输入的值是否有效。请确保以正确的大小写形式输入这些参数的名称，因为命令行工具不会验证参数名称的大小写情况。如果输入的参数的大小写不正确，那么可能导致错误的结果。

二、以下是manageprofiles.sh可以使用的参数清单

• -adminPassword adminPassword

• -adminUserName adminUser_ID

• -applyPerfTuningSetting standard | production | development

• -appServerNodeName application_server_node_name

• -augment

• -backupFile backupFile_name

• -backupProfile

• -cellName cell_name（可选参数）

• -create

• -debug

• -defaultPorts

• -delete

• -deleteAll

• -dmgrAdminPassword password

• -dmgrAdminUserName user_name

• -dmgrHost dmgr_host_name（可选参数）

• -dmgrPort dmgr_port_number

• -dmgrProfilePath dmgr_profile_path

• -enableAdminSecurity true | false

•  -enableService true | false

• -federateLater true | false

• -getDefaultName

• -getPath

• -getName

• -help

• -hostName host_name

• -ignoreStack（可选参数）

• -importPersonalCertKS keystore_path

• -importPersonalCertKSAlias keystore_alias

• -importPersonalCertKSPassword keystore_password

• -importPersonalCertKSType keystore_type

• -importSigningCertKS keystore_path

• -importSigningCertKSAlias keystore_alias

• -importSigningCertKSPassword keystore_password

• -importSigningCertKSType keystore_type

• -isDefault

• -isDeveloperServer

• -keyStorePassword keystore_password

• -listAugments

• -listProfiles

• -nodeDefaultPorts

• -nodeName node_name

• -nodePortsFile node_ports_file_path

• -nodeProfilePathnode_profile_path

• -omitAction feature1 feature2... featureN（可选参数）

• -personalCertDN distinguished_name

• -personalCertValidityPeriod validity_period（可选参数）

• -portsFile file_path（可选参数）

• -profileName profile_name

• -profilePath profile_root

• -response response_file

• -restoreProfile

• -securityLevel security_level

• -serverName server_name

• -serverType DEPLOYMENT_MANAGER | ADMIN_AGENT | JOB_MANAGER

•  -serviceUserName service_user_ID

• -setDefaultName

• -signingCertDN distinguished_name

• -signingCertValidityPeriod validity_period（可选参数）

• -startingPort starting_port | -portsFile ports_file_path | -defaultPorts

• -supportedProtocols supported_protocols

• -templatePath template_path

• -unaugment

• -unaugmentAll

• -unaugmentDependents

• -validateAndUpdateRegistry

• -validatePorts

• -validateRegistry

• -webServerCheck true | false

• -webServerHostnamewebserver_host_name

• -webServerInstallPath webserver_installpath_name

• -webServerName webserver_name

• -webServerOS webserver_operating_system

• -webServerPluginPath webserver_plugin_path

• -webServerPort webserver_port

• -webServerType webserver_type

•  -winserviceAccountType specifieduser | localsystem

•  -winserviceCheck true | false

•  -winservicePassword winservice_password

•  -winserviceStartupType manual | automatic | disabled

•  -winserviceUserName winservice_user_ID

三、manageprofiles.sh参数使用说明

-adminPassword adminPassword

为使用 -adminUserName 参数指定的管理安全性用户标识指定密码。

-adminUserName adminUser_ID

指定用于管理安全性的用户标识。

-applyPerfTuningSetting option

指定与环境（应用程序服务器将在其中运行）的类型匹配度最高的性能调整设置。

此参数仅对缺省概要文件模板有效。

standard：标准设置是针对常规用途进行优化的现有标准缺省配置设置。production：生产性能设置针对生产环境进行优化，在生产环境中极少进行应用程序更改并且最佳运行时性能很重要。development：开发设置针对开发环境进行优化，在开发环境中需要经常执行应用程序更新并且系统资源最少。

注意： 请不要对生产服务器使用开发设置。

如果同时指定 -isDeveloperServer 和 -applyPerfTuningSetting 参数，那么根据为 -applyPerfTuningSetting 选择的选项，-applyPerfTuningSetting 可能会覆盖 -isDeveloperServer。

-appServerNodeName application_server_node_name

指定要联合至单元的应用程序服务器的节点名。创建单元的 Deployment Manager 部分及创建单元的应用程序服务器部分时，请指定此参数。

-augment

使用 augment 参数以通过扩充模板对现有概要文件进行更改。augment 参数导致 manageprofiles 命令使用 -templatePath 参数中的模板更新或扩充在 -profileName 参数中标识的概要文件。可以使用的扩充模板由环境中安装的 IBM? 产品及版本确定。

要点： WebSphere? Application Server Network Deployment 产品附带的模板只能用于创建概要文件，而不能用于扩充现有概要文件，因为该产品仅提供了创建模板。

此外，不要手动修改 install_dir/ profileTemplates 目录中的文件。例如，如果要在创建概要文件期间更改端口，请对 manageprofiles 命令使用 -startingPort 或 -portsFile 参数，而不是在概要文件模板目录中修改该文件。

 -templatePath 指定标准文件路径。

如果概要文件模板相对于 app_server_root/profileTemplates 目录，那么可以为 -templatePath 参数指定一个相对路径。否则，指定一个标准模板路径。

-backupFile backupFile_name

将概要文件注册表文件备份到指定的文件。您必须为 backupFile_name 提供标准文件路径。

-backupProfile

对概要文件文件夹和概要文件注册表文件中的概要文件元数据执行文件系统备份。在调用带 -backupProfile 选项的 manageprofiles 命令之前，必须首先停止任何正在使用要备份的概要文件的服务器。-backupProfile 参数必须与 -backupFile 和 -profileName 参数一起使用。

-cellName cell_name（可选参数）

指定概要文件的单元名。请对每个概要文件使用唯一单元名。

-create

创建概要文件。

指定 manageprofiles -create -templatePath fully_qualified_file_path_to_template -help 以获取关于创建概要文件的特定信息。可用的模板包括：

·         cell - Deployment Manager 单元（dmgr 和缺省值）

·         management - 管理。与 -serverType 参数配合使用，以指示管理概要文件的类型。

·         secureproxy - 安全代理

·         default - 应用程序服务器

·         managed - 定制

-debug

打开 manageprofiles 命令使用的 Ant 实用程序的调试功能。

-personalCertValidityPeriod validity_period（可选参数）

一个可选参数，用于指定缺省个人证书有效的时间量（以年计）。如果未将此参数与 -personalCertDN 参数一起指定，那么缺省个人证书有效的时间为一年。

-defaultPorts

对概要文件指定缺省端口值或基本端口值。不要在使用 -startingPort 或 -portsFile 参数时使用此参数。在创建概要文件时，如果您未指定 -startingPort 参数、-defaultPorts 参数或 -portsFile 参数，那么 manageprofiles 命令使用一组自动生成的建议端口。根据缺省端口的可用性，建议的端口值可与缺省端口值不同。

切记： 如果您要使用受管概要文件模板，那么请不要使用此参数。

-delete

删除概要文件。删除概要文件不会删除概要文件目录。例如，假定您在 /usr/WebSphere/AppServer/profiles/managedProfile 目录中创建一个概要文件。在您删除概要文件之后，该目录仍然存在。您可以删除或保留该目录。然而，profile_root/logs 目录包含关于卸载概要文件的信息。例如，您可以保留 _nodeuninst.log 文件以确定在卸载过程中发生的任何问题的原因。如果您在概要文件注册表中删除某个概要文件，而该概要文件已有扩充模板向它注册，那么会自动执行取消扩充操作。如果要删除已迁移的旧节点，请先关闭新迁移的 Deployment Manager，然后再删除旧节点。这将确保不会从新迁移的单元中意外移除新迁移的节点。

-deleteAll

删除所有已注册的概要文件。删除概要文件不会删除概要文件目录。例如，假定您在 /usr/WebSphere/AppServer/profiles/managedProfile 目录中创建一个概要文件。在您删除概要文件之后，该目录仍然存在。您可以删除或保留该目录。然而，profile_root/logs 目录包含关于卸载概要文件的信息。例如，您可以保留 _nodeuninst.log 文件以确定在卸载过程中发生的任何问题的原因。如果您在概要文件注册表中删除某个概要文件，而该概要文件已有扩充模板向它注册，那么会自动执行取消扩充操作。

-dmgrAdminPassword password

如果正在联合节点，那么当对 Deployment Manager 启用了管理安全性时为该 Deployment Manager 指定有效用户名。请将此参数与 -dmgrAdminUserName 参数和 -federateLater 参数配合使用。

-dmgrAdminUserName user_name

如果正在联合节点，那么当对 Deployment Manager 启用了管理安全性时为该 Deployment Manager 指定有效密码。请将此参数与 -dmgrAdminPassword 参数和 -federateLater 参数配合使用。

-dmgrHost dmgr_host_name（可选参数）

标识正在运行 Deployment Manager 的机器。指定此参数和 dmgrPort 参数在创建时联合定制概要文件。主机名可以是 Deployment Manager 机器的长 DNS 名、短 DNS 名或 IP 地址。指定此可选参数会指示 manageprofiles 命令尝试将定制节点联合到 Deployment Manager 单元，因为它会使用受管 -templatePath 参数创建定制概要文件。创建 Deployment Manager 概要文件或应用程序服务器概要文件时，会忽略 -dmgrHost 参数。如果您在 Deployment Manager 未运行或者由于启用了安全性或其他原因导致 Deployment Manager 不可用时联合定制节点，那么日志中的安装指示信息将为 INSTCONFFAIL，表示安装完全失败。得到的定制概要文件将不可用。在创建具有相同概要文件名的另一个定制概要文件之前，必须将定制概要文件目录从概要文件存储库（概要文件安装根目录）中移出。如果您已 经启用了安全性或更改了缺省 JMX 连接器类型，那么无法用 manageprofiles 命令联合。请使用 addNode 命令替代。此参数的缺省值为 localhost。此参数的值必须为格式正确的主机名并且不能包含空格或无效字符（例如，*、?、"、<、>、,、/、\、| 等等）。在与dmgrPort 参数一起使用时，与 Deployment Manager 的连接也必须可用。

-dmgrPort dmgr_port_number

标识 Deployment Manager 的 SOAP 端口。指定此参数和 dmgrHost 参数在创建时联合定制概要文件。Deployment Manager 必须在运行中并且可访问。如果已启用安全性或已更改缺省 Java 管理扩展 (JMX) 连接器类型，那么无法使用 manageprofiles 命令进行联合。请使用 addNode 命令替代。此参数的缺省值为 8879。在与 dmgrHost 参数一起使用时，您指示的端口必须为正整数且与 Deployment Manager 的连接必须可用。

-dmgrProfilePath dmgr_profile_path

指定单元的 Deployment Manager 部分的概要文件路径。创建单元的应用程序服务器部分时，请指定此参数。

-enableAdminSecurity true | false

启用管理安全性。有效值包括 true 或 false。缺省值为 false。当 enableAdminSecurity 设置为 true 时，您还必须指定参数 -adminUserName 和 -adminPassword 以及这些参数的值。您无法使用 -enableAdminSecurity 参数来为定制概要文件启用管理安全性。要为定制概要文件启用安全性，定制概要文件必须联合到 Deployment Manager。要为联合定制概要文件启用安全性，必须为 Deployment Manager 启用管理安全性。

-enableService true | false

允许创建 Linux 服务。有效值包括 true 或 false。此参数的缺省值为 false。在 -enableService 选项设置为 true 的情况下运行 manageprofiles 命令时，如果该命令由 root 用户运行，那么会随概要文件创建 Linux 服务。当非 root 用户运行 manageprofiles 命令时，会创建概要文件，但不会创建 Linux 服务。因为非 root 用户没有足够的许可权来设置 Linux 服务，所以不会创建该服务。在概要文件创建结束时会显示 INSTCONPARTIALSUCCESS 结果，并且概要文件创建日志app_server_root/logs/manageprofiles_create_profilename.log 包含一条消息，指示当前用户没有足够的许可权来设置 Linux 服务。

-federateLater true | false

指示是在概要文件创建期间联合受管概要文件，还是稍后使用 addNode 命令联合它。如果 dmgrHost、dmgrPort、dmgrAdminUserName 和dmgrAdminPassword 参数没有值，那么此参数的缺省值为 true。有效值包括 true 或 false。

-getDefaultName

返回缺省概要文件的名称。

-getPath

获取给定名称的概要文件的文件系统位置。需要 –profileName 参数。

-getName

获取以给定的 -profilePath 参数注册的概要文件的名称。

-help

显示命令语法。

-hostName host_name

指定您创建概要文件的主机名。这应该与您在初始产品安装过程中指定的主机名相匹配。此参数的缺省值为长格式的域名系统。此参数的值必须为有效的 IPv6 主机名并且不能包含空格或任何无效字符（例如，*、?、"、<、>、,、/、\、| 等等）。

-ignoreStack（可选参数）

这是一个可选参数，它与 -templatePath 参数一起用来取消扩充已经扩充的特定概要文件。请参阅 -unaugment 参数。

-importPersonalCertKS keystore_path

指定当创建概要文件时用来导入个人证书的密钥库文件的路径。该个人证书是服务器的缺省个人证书。最佳实践： 导入个人证书作为缺省个人证书时，请导入签署该个人证书的根证书。 否则，manageprofiles 命令会将个人证书的公用密钥添加至 trust.p12 文件并创建根签名证书。

-importPersonalCertKS 参数与 -personalCertDN 参数互斥。

如果未特地创建或导入个人证书，那么在缺省情况下会创建一个个人证书。当指定任何以 -importPersonal 开始的参数时，必须指定所有的此类参数。

-importPersonalCertKSAlias keystore_alias

指定对 -importPersonalCertKS 参数指定的密钥库文件中证书的别名。该证书被添加至服务器缺省密钥库文件，并且用作服务器缺省个人证书。

当指定任何以 -importPersonal 开始的参数时，必须指定所有的此类参数。

-importPersonalCertKSPassword keystore_password

指定对 -importPersonalCertKS 参数指定的密钥库文件的密码。当指定任何以 -importPersonal 开始的参数时，必须指定所有的此类参数。

-importPersonalCertKSType keystore_type

指定对 -importPersonalCertKS 参数指定的密钥库文件的类型。值可能为 JCEKS、CMSKS、PKCS12、PKCS11 和 JKS。但是，此列表可根据 java.security 文件中的提供程序更改。当指定任何以 -importPersonal 开始的参数时，必须指定所有的此类参数。

-importSigningCertKS keystore_path

指定当创建概要文件时用来导入根证书的密钥库文件的路径。该根证书是用作服务器缺省根证书的证书。-importSigningCertKS 参数与 -signingCertDN 参数互斥。如果未特地创建或导入根签名证书，那么在缺省情况下会创建一个根签名证书。

当指定任何以 -importSigning 开始的参数时，必须指定所有的此类参数。

-importSigningCertKSAlias keystore_alias

指定对 -importSigningCertKS 参数指定的密钥库文件中证书的别名。该证书被添加至服务器缺省根密钥库，并且用作服务器缺省根证书。

当指定任何以 -importSigning 开始的参数时，必须指定所有的此类参数。

-importSigningCertKSPassword keystore_password

指定对 -importSigningCertKS 参数指定的密钥库文件的密码。

当指定任何以 -importSigning 开始的参数时，必须指定所有的此类参数。

-importSigningCertKSType keystore_path

指定对 -importSigningCertKS 参数指定的密钥库文件的类型。有效值可能为 JCEKS、CMSKS、PKCS12、PKCS11 和 JKS。但是，此列表可根据 java.security 文件中的提供程序更改。

当指定任何以 -importSigning 开始的参数时，必须指定所有的此类参数。

-isDefault

指定由一起使用的 -profileName 参数标识的概要文件在注册后将成为缺省概要文件。当发出针对缺省概要文件的命令时，那么不必使用命令的 -profileName 属性。

-isDeveloperServer

指定服务器仅用于开发目的。将应用程序部署到其生产应用程序服务器上之前，创建概要文件以在非生产服务器上测试应用程序时，此参数很有用。

此参数仅对缺省概要文件模板有效。

如果同时指定 -isDeveloperServer 和 -applyPerfTuningSetting 参数，那么根据为 -applyPerfTuningSetting 选择的选项，-applyPerfTuningSetting 可能会覆盖 -isDeveloperServer。

-keyStorePassword keystore_password

指定要对概要文件创建期间创建的所有密钥库文件使用的密码。密钥库文件是为缺省个人证书和根签名证书创建的。

-listAugments

列出对概要文件注册表中概要文件的已注册扩充。必须将 -profileName 参数与 -listAugments 参数一起指定。

-listProfiles

列示概要文件注册表中的概要文件。

-nodeDefaultPorts

在结合单元模板创建概要文件时定义端口集。如果指定此选项，那么不能同时指定 -nodePortsFile 或 nodeStartingPort 选项。

-nodeName node_name

指定用新概要文件创建的节点的节点名。请在单元内或机器上使用唯一值。每个共享同一个产品二进制文件集的概要文件必须具有唯一节点名。

此参数的缺省值基于短主机名、概要文件类型和尾随数字，如下所示：

·         应用程序服务器概要文件：shortHostNameNodeNodeNumber

·         定制概要文件：shortHostNameNodeNodeNumber

·         Deployment Manager 服务器的管理概要文件：shortHostNameCellManagerNodeNumber

·         具有作业管理器服务器的管理概要文件：shortHostNameJobMgrNodeNumber

·         具有管理代理程序服务器的管理概要文件：shortHostNameAANodeNodeNumber

·         单元概要文件，应用程序服务器部分：shortHostNameNodeNodeNumber

·         单元概要文件，Deployment Manager 部分：shortHostNameCellManagerNodeNumber

·         安全代理概要文件：shortHostNameNodeNodeNumber

其中 NodeNumber 是从 01 开始的序号。

此参数的值不能包含空格或任何无效字符（例如，*、?、"、<、>、,、/、\、| 等等）。