manageprofiles parameters: custom profiles

Use the following parameters with the manageprofiles command when you create custom profiles. Custom profiles are used to create managed node profiles for subsequent federation to a deployment manager.

The manageprofiles command file is located in the install_root/bin directory. The command file is a script named manageprofiles.sh for Linux and UNIX platforms, or manageprofiles.bat for Windows platforms.

Before you use the manageprofiles command, make sure that you understand all prerequisites for creating and augmenting profiles. For more information about prerequisites, see:Prerequisites for creating or augmenting profiles For more information about creating and augmenting profiles, see:Creating WSRR profiles using the manageprofiles command and Augmenting profiles using the manageprofiles command.

Attention: When you create a profile, use only the parameters that are documented in the WebSphere Service Registry and Repository Information Center.

Note: All parameters are case-sensitive.

The following options are available for the manageprofiles command:

-create: Creates the profile. Specify manageprofiles -create -templatePath fully_qualified_file_path_to_template -help for specific information about creating a profile. For creating a custom profile, the template is managed.wsrr.

-delete

Deletes the profile. Deleting a profile does not delete the profile directory. For example, if you create a profile in the /usr/WebSphere/ProcServer/profiles/managedProfile/usr/WebSphere/ESB/profiles/managedProfile directory, the directory remains after you delete the profile.

You can delete or leave the directory. However, the profile_root/logs directory contains information about uninstalling the profile. For example, you might retain the _nodeuninst.log file to determine the cause of any problem during the uninstallation procedure.

If you delete a profile that has augmenting templates that are registered to it in the profile registry, then unaugment actions are performed automatically.

-deleteAll

Deletes all registered profiles.

Deleting a profile does not delete the profile directory. For example, suppose that you create a profile in the /usr/WebSphere/ProcServer/profiles/managedProfile/usr/WebSphere/ESB/profiles/managedProfile directory, the directory remains after you delete the profile.

If you delete a profile that has augmenting templates that are registered to it in the profile registry, then unaugment actions are performed automatically.

-enableAdminSecurity true | false

Enables administrative security. Valid values include true or false. The default value is true. If you are creating profiles for a deployment environment, you must set this parameter to true. Use this parameter when you create profiles only. Do not supply this parameter when you augment an existing profile.

When enableAdminSecurity is set to true, you must also specify the parameters -adminUserName and -adminPassword along with the values for these parameters. If samples were installed during the application server installation, you must also specify the -samplesPassword parameter when you create a profile for which administrative security is enabled. If the -samplesPassword parameter is not specified when administrative security is enabled, the profile is created successfully, but when you attempt to run the samples, exceptions and failures are entered in the server system out log.

-getDefaultName: Returns the name of the default profile.

-getName: Gets the name for a profile that is registered at a specified-profilePath parameter.

-getPath: Gets the file system location for a profile of a given name. Requires the –profileName parameter.

-help: Displays command syntax.

-hostName host_name: Specifies the host name where you are creating the profile. Do not supply this parameter when you augment an existing profile. This should match the host name that you specified during installation of the initial product. The default value for this parameter is the long form of the domain name system. This parameter is required for profile creation only. The value for this parameter must be a valid IPv6 host name and must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, and |.

-importPersonalCertKS keystore_path

Specifies the path to the keystore file that you use to import a personal certificate when you create the profile. The personal certificate is the default personal certificate of the server.

When you import a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, the manageprofiles adds the public key of the personal certificate to the trust.p12 file and creates a root signing certificate.

The -importPersonalCertKS parameter is mutually exclusive with the -personalCertDN parameter. If you do not specifically create or import a personal certificate, one is created by default.

When you specify any of the parameters that begin with -importPersonal, you must specify them all.

--importPersonalCertKSType keystore_type

Specifies the type of the keystore file that you specify on the -importPersonalCertKS parameter. Values might be JCEKS, CMSKS, PKCS12, PKCS11, and JKS. However, this list can change based on the provider in the java.security file.

When you specify any of the parameters that begin with -importPersonal, you must specify them all.

-importPersonalCertKSPassword keystore_password

Specifies the password of the keystore file that you specify on the -importPersonalCertKS parameter.

When you specify any of the parameters that begin with -importPersonal, you must specify them all.

-importPersonalCertKSAlias keystore_alias

Specifies the alias of the certificate that is in the keystore file that you specify on the -importPersonalCertKS parameter. The certificate is added to the server default keystore file and is used as the server default personal certificate.

When you specify any of the parameters that begin with -importPersonal, you must specify them all.

-importSigningCertKS keystore_path

Specifies the path to the keystore file that you use to import a root certificate when you create the profile. The root certificate is the certificate that you use as the server default root certificate. The -importSigningCertKS parameter is mutually exclusive with the -signingCertDN parameter. If you do not specifically create or import a root signing certificate, one is created by default.

When you specify any of the parameters that begin with -importSigning, you must specify them all.

-importSigningCertKSType keystore_path

Specifies the type of the keystore file that you specify on the -importSigningCertKS parameter. Valid values might be JCEKS, CMSKS, PKCS12, PKCS11, and JKS. However, this list can change based on the provider in the java.security file.

When you specify any of the parameters that begin with -importSigning, you must specify them all.

-importSigningCertKSPassword keystore_password

Specifies the password of the keystore file that you specify on the -importSigningCertKS parameter.

When you specify any of the parameters that begin with -importSigning, you must specify them all.

-importSigningCertKSAlias keystore_alias

Specifies the alias of the certificate that is in the keystore file that you specify on the -importSigningCertKS parameter. The certificate is added to the server default root keystore and is used as the server default root certificate.

When you specify any of the parameters that begin with -importSigning, you must specify them all.

-listAugments: Lists the registered augments on a profile that is in the profile registry. You must specify the -profileName parameter with the -listAugments parameter.

-listProfiles: Lists all defined profiles.

-nodeName node_name

Specifies the node name for the node that is created with the new profile. Do not supply this parameter when you augment an existing profile. Use a unique value within the cell or on the workstation. Each profile that shares a set of executable programs must have a unique node name.

The default value for this parameter is based on the short host name, profile type, and a trailing number. If the profile type is a deployment manager profile, the default value is of the following form:

<short_host_name>CellManager<node_number>

where <node_number> is a sequential number that starts at 01.

If the profile type is not a deployment manager profile, the default value is of the following form:

<short_host_name>Node<node_number>

The value for this parameter must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, and |, .

-personalCertDN distinguished_name: Specifies the distinguished name of the personal certificate that you are creating when you create the profile. Specify the distinguished name in quotation marks. This default personal certificate is in the server keystore file. The -importPersonalCertKSType parameter is mutually exclusive with the -personalCertDN parameter. See the -personalCertValidityPeriod parameter and the -keyStorePassword parameter.

-personalCertValidityPeriod validity_period: An optional parameter that specifies the amount of time in years that the default personal certificate is valid. If you do not specify this parameter with the -personalCertDN parameter, the default personal certificate is valid for one year.

-profileName profile_name

Specifies the name of the profile. Use a unique value when you create a profile.

Each profile that shares a set of executable programs must have a unique name. The default profile name is based on the profile type and a trailing number, for example:

profileType ProfileNumber

where profileType is a value such as WSRRSvr, Dmgr, or Custom and ProfileNumber is a sequential number that creates a unique profile name.

The value for this parameter must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, and |. The profile name that you choose must not be in use.

-profilePath profile_root

Specifies the fully qualified path to the profile, which is referred to throughout the information center as the profile_root.

Use this parameter when you create profiles only. Do not set this parameter for augmenting an existing profile.

For Windows operating system On Windows platforms: If the fully qualified path contains spaces, enclose the value in quotation marks.

The default value is based on the install_root directory, the profiles subdirectory, and the name of the file. For example, the default for profile creation is as follows:

WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName

where WS_WSPROFILE_DEFAULT_PROFILE_HOME is defined in the wasprofile.properties file in the install_root/properties directory.

The value for this parameter must be a valid path for the target system and must not be currently in use.

You must have permissions to write to the directory.

-response response_file

Accesses all API functions from the command line using the manageprofiles command. The command-line interface can be driven by a response file that contains the input arguments for a specified command in the properties file in key and value format. The following is an example response file for a create operation:

create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=install_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName

For Windows operating system On Windows platforms: The path statement in the Windows operating system can use either forward slashes (/) or backslashes (\). If the path statement uses backslashes, then the response file requires double backslashes for the response file to correctly understand the path. Here is an example of a response file for a create operation that uses the double backslashes:

create
templatePath=C:\\WAS\\profileTemplates\\managed.wsrr

To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.

-samplesPassword password: Creates a password to be used for samples. The password is used to restrict access to web application samples installed during the installation of the application server.

-signingCertDN distinguished_name: Specifies the distinguished name of the root signing certificate that you create when you create the profile. Specify the distinguished name in quotation marks. This default personal certificate is in the server keystore file. The -importSigningCertKS parameter is mutually exclusive with the -signingCertDN parameter. If you do not specifically create or import a root signing certificate, one is created by default. See the -signingCertValidityPeriod parameter and the -keyStorePassword parameter.

-signingCertValidityPeriod validity_period: An optional parameter that specifies the amount of time in years that the root signing certificate is valid. If you do not specify this parameter with the -signingCertDN parameter, the root signing certificate is valid for 20 years.

-templatePath template_path

Specifies the directory path to the template files in the installation root directory. Within the profileTemplates directory are various directories that correspond to different profile types and that vary with the type of product installed. The profile directories are the paths that you indicate while you are using the -templatePath option. You can specify profile templates that lie outside the installation root, if you have any.

Use absolute paths. The value of this parameter must be the path to a valid, existing template directory. To creating a managed node, use the managed.wsrr template.

-unaugment

Unaugments all profiles that have been augmented.

-unaugmentAll

Unaugments all profiles that have been augmented with a specific augmentation template. The -templatePath parameter is required with the -unaugmentAll parameter.

When you use the -templatePath parameter, specify the fully qualified file path for the parameter. Optionally, specify the -unaugmentDependents parameter with the -unaugmentAll parameter to unaugment all profiles that are prerequisites of the profiles that are being unaugmented.

Note: If you use this parameter when you have no profiles that are augmented with the profile templates, an error might be delivered. See also the augment parameter.

-unaugmentDependents true|false

If set to true, the parameter unaugments all the augmented profiles that are prerequisites to the profiles that are unaugmented with the-unaugmentAll parameter. The default value for this parameter is false.

Optionally, specify the -unaugmentDependents parameter with the -unaugmentAll parameter.

-validateAndUpdateRegistry: Checks all the profiles that are listed in the profile registry to see whether the profiles are present on the file system. Removes any missing profiles from the registry. Returns a list of the missing profiles that were deleted from the registry.

-validateRegistry: Checks all the profiles that are listed in the profile registry to see whether the profiles are present on the file system. Returns a list of missing profiles. This parameter refers to the WebSphere Application Server profile registry and not the WebSphere Service Registry and Repository.