manageprofiles command


 

+

Search Tips   |   Advanced Search

 

To create, delete, augment, back up, and restore profiles...

APP_ROOT/bin/manageprofiles

Options include...

-create Create a profile
-delete Delete a profile
-augment Augment a profile
-unaugment Unaugment a profile
-unaugmentAll Unaugment profiles with a template
-deleteAll Delete all profiles
-listProfiles List all profiles
-listAugments List augments for a profile
-getName Get a profile name
-getPath Get a profile path
-validateRegistry Validate a profile registry
-validateAndUpdateRegistry Validate and update a profile registry
-getDefaultName Get the default profile name
-setDefaultName Set the default profile name
-backupProfile Back up a profile
-restoreProfile Restore a profile
-response Execute tasks contained in a response file
-help Get detailed help

The output from the help command will specify which parameters are required and which are optional.

APP_ROOT/bin/manageprofiles.sh -augment -help

Depending on the operation, provide one or more of the following parameters. Parameters are case sensitive.

Example of -create command

 
cd c:/IBM/WAS70/AppServer/bin

./manageprofiles.sh -create  
                     -profileName MyProfile  
                     -profilePath c:/opt/WAS/AppServer/profiles/MyProfile  
                     -templatePath /opt/WAS/AppServer/profileTemplates/default

 

Parameters

-adminUserName adminUser_ID

User ID used for administrative security.

-adminPassword adminPassword

Password for the administrative security user ID specified with the -adminUserName parameter.

-appServerNodeName nodename

Node name of the appserver that we are federating into the cell. Specify when creating the dmgr portion of the cell and when creating the application server portion of the cell.

-augment

Make changes to an existing profile with an augmentation template.

Usage:

./manageprofiles.sh -augment -profileName MyProfile -templatePath template_path

Use manageprofiles command line arguments like -startingPort, instead modifying files in...

install_dir/profileTemplates

You can specify a relative path for the -templatePath parameter if the profile templates are relative to...

APP_ROOT/profileTemplates

Otherwise, specify the fully qualified template path.

-backupProfile

Perform a file system backup of profile folder metadata from the profile registry file.

Stop appservers prior to invoking.

The -backupProfile parameter must be used with -backupFile and -profileName...

./manageprofiles.sh -backupProfile -profileName MyProfile -backupFile /tmp/myProfile.bak

-backupFile /path/to/myProfile.bak

Backs up the profile registry file to the specified file. Provide a fully qualified file path

-cellName cell_name

Cell name of the profile.

Always use a unique cell name for each profile, for the following reasons...

  • Federation requires unique cell names.

  • If WAS is running in a sysplex.

  • When network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells.

  • If their namespaces are federated. Otherwise, we might encounter errors such as...

    javax.naming.NameNotFoundException

    The default value is based on a combination of...

    • short host name
    • constant cell
    • trailing number

    Application serverfile Not any
    Custom profile Not any
    Management profile with the dmgr server shortHostNameCellCellNumber
    Management profile with the job manager server shortHostNameJobMgrCellCellNumber
    Management profile with the administrative agent server shortHostNameAACellCellNumber
    Cell profile, appserver portion shortHostNameCellCellNumber
    Cell profile, dmgr portion shortHostNameCellCellNumber
    Secure proxy profile Not any

    ...where CellNumber is a sequential number starting at 01.

The value must not contain spaces or any invalid characters that are not valid such as the following: *, ?, ", <, >, ,, /, /, |, and so on.

-create

Create the profile.

For specific information about creating a profile...

manageprofiles -create 
               -templatePath fully_qualified_file_path_to_template 
               -help 

Available templates include:

cell Deployment manager cell (dmgr and default)
management Management

Use in conjunction with the -serverType parameter to indicate the type of management profile.

secureproxy Secure proxy
default Application Server
managed Custom

-debug

Turn on the debug function of the Ant utility, which manageprofiles uses.

-personalCertValidityPeriod validity_period

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

-defaultPorts

Assigns the default or base port values to the profile.

Do not use this parameter when using the -startingPort or -portsFile parameter.

During profile creation, manageprofiles uses an automatically generated set of recommended ports if we do not specify...

  • -startingPort
  • -defaultPorts
  • -portsFile

The recommended port values can be different than the default port values based on the availability of the default ports.

Do not use this parameter if using the managed profile template.

-delete

Delete the profile.

Deleting a profile does not delete the profile directory. You can delete manually.

To debug problems with deletion, see...

$PROFILE_ROOT/logs/_nodeuninst.log

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

-deleteAll

Delete all registered profiles.

Deleting a profile does not delete the profile directory. You can delete manually.

To debug problems with deletion, see...

$PROFILE_ROOT/logs/_nodeuninst.log

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

-dmgrAdminPassword password

If federating a node, specify a valid user name for a dmgr if administrative security is enabled on the deployment manager.

Use this parameter with...

  • -dmgrAdminUserName
  • -federateLater

-dmgrAdminUserName user_name

If federating a node, specify a valid password for a deployment manager if administrative security is enabled on the dmgr.

Use this parameter with...

  • -dmgrAdminPassword
  • -federateLater

-dmgrHost dmgr_host

Identifies the machine where the dmgr is running.

Specify with dmgrPort to federate a custom profile as it is created.

The host name can be the long or short DNS name or the IP address of the deployment manager machine.

Specifying this optional parameter directs manageprofiles to attempt to federate the custom node into the dmgr cell as it creates the custom profile with managed -templatePath. The -dmgrHost parameter is ignored when creating a dmgr profile or an appserver profile.

If we federate a custom node when the dmgr is unavailable, for security or any other reason, the logs indicate INSTCONFFAIL and the resulting custom profile is unusable. To fix...

  1. Move the custom profile directory out of PROFILE_HOME

  2. Create another custom profile with the same profile name

If security is enabled or the default JMX connector type has changed, we cannot federate with manageprofiles. Use addNode instead.

The default value is localhost.

The value must be a properly formed host name and must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, /, |, and so on. A connection to the dmgr must also be available in conjunction with dmgrPort.

-dmgrPort dmgr_port_number

Identifies the SOAP port of the dmgr. Specify this parameter and dmgrHost to federate a custom profile as it is created. The dmgr must be running and accessible.

If we have enabled security or changed the default JMX connector type, we cannot federate with manageprofiles. Use the addNode command instead.

The default value is 8879.

The port that you indicate must be a positive integer and a connection to the dmgr must be available in conjunction with the dmgrHost parameter.

-dmgrProfilePath dmgr_profile_path

Profile path to the dmgr portion of the cell. Specify when creating the appserver portion of the cell.

-enableAdminSecurity true | false

Enables administrative security. Valid values include true or false. The default value is false.

When enableAdminSecurity is set to true, also specify the parameters -adminUserName and -adminPassword along with the values for these parameters. If samples were installed during the appserver install, also specify -samplesPassword when creating a profile for which administrative security is enabled. If -samplesPassword is not specified when administrative security is enabled, the profile is created successfully, but when you attempt to run the samples, exceptions and failures will be put in the server system out log.

We cannot use the -enableAdminSecurity parameter to enable administrative security for a custom profile. For security to be enabled for a custom profile, the custom profile must be federated into a dmgr. Administrative security enabled for the dmgr is required to enable security for the federated custom profile.

-enableService true | false

Enables the creation of a Linux service.

Valid values include true or false.

Default is false.

When manageprofiles is run with the -enableService option set to true , the Linux service is created with the profile when the command is run by the root user.

When a non-root user runs manageprofiles, the profile is created, but the Linux service is not. The Linux service is not created because the non-root user does not have sufficient permission to set up the service. An INSTCONPARTIALSUCCESS result is displayed at the end of the profile creation and the profile creation log...

APP_ROOT/logs/manageprofiles_create_profilename.log

...contains a message indicating the current user does not have sufficient permission to set up the Linux service.

-federateLater true | false

Indicate if the managed profile will be federated during profile creation or if we will federate it later using addNode command.

If dmgrHost, dmgrPort, dmgrAdminUserName and dmgrAdminPassword do not have values, the default value is true.

Valid values include true or false.

-getDefaultName

Returns the name of the default profile.

-getName

Gets the name for a profile registered at a given -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

Host name where we are creating the profile. Should match the host name specified during installation of the initial product. The default value is the long form of the domain name system.

The value must be a valid IPv6 host name and must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, /, |, and so on.

-ignoreStack

An optional parameter used with -templatePath to unaugment a particular profile that has been augmented. See -unaugment.

-importPersonalCertKS keystore_path

Path to the keystore file that you use to import a personal certificate when creating the profile. The personal certificate is the default personal certificate of the server.

Best practice: 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 we 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, specify them all.

-importPersonalCertKSType keystore_type

Type of the keystore file specified on the -importPersonalCertKS parameter. Values might be...

  • JCEKS
  • CMSKS
  • PKCS12
  • PKCS11
  • 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, specify them all.

-importPersonalCertKSPassword keystore_password

Password of the keystore file specified on the -importPersonalCertKS parameter.

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

-importPersonalCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file specified 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, specify them all.

-importSigningCertKS keystore_path

Path to the keystore file that you use to import a root certificate when creating 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 we 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, specify them all.

-importSigningCertKSType keystore_path

Type of the keystore file specified 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, specify them all.

-importSigningCertKSPassword keystore_password

Password of the keystore file specified on the -importSigningCertKS parameter.

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

-importSigningCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file specified 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, specify them all.

-isDefault

Specify that the profile identified by the accompanying -profileName parameter is to be the default profile once it is registered. When issuing commands that address the default profile, it is not necessary to use the -profileName attribute of the command.

-isDeveloperServer

Specify whether the server is intended for development purposes only.

Useful when creating profiles to test applications on a non-production server prior to deploying the applications on their production appservers. The parameter is valid only for the default profile template.

-keyStorePassword keystore_password

Password to use on all keystore files created during profile creation. Keystore files are created for the default personal certificate and the root signing certificate.

-listAugments

Lists the registered augments on a profile that is in the profile registry. Specify the -profileName parameter with the -listAugments parameter.

-nodeDefaultPorts

Define a set of ports when creating a profile in conjunction with a cell template. If we specify this option, we cannot specify the -nodePortsFile or nodeStartingPort options at the same time.

-nodePortsFile node_ports_path

Specify ports for the node portion of the cell that we are creating. If we specify this option, we cannot specify the -nodeDefaultPorts or -nodeStartingPort options at the same time.

-nodeProfilePath node_profile_path

Profile path to the node portion of the cell. Specify this parameter when creating the dmgr portion of the cell.

-nodeName node_name

Node name for the node that is created with the new profile.

Use a unique value within the cell or on the machine. Each profile that shares the same set of product binaries must have a unique node name.

Default values...

Application Server profile shortHostNameNodeNodeNumber
Custom profile shortHostNameNodeNodeNumber
Management profile with dmgr server shortHostNameCellManagerNodeNumber
Management profile with the job manager server shortHostNameJobMgrNodeNumber
Management profile with administrative agent server shortHostNameAANodeNodeNumber
Cell profile, appserver portion shortHostNameNodeNodeNumber
Cell profile, dmgr portion shortHostNameCellManagerNodeNumber
Secure proxy profile shortHostNameNodeNodeNumber

...where NodeNumber is a sequential number starting at 01.

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

-omitAction feature1 feature2... featureN

Exclude profile features.

Each profile template comes predefined with certain optional features. The samplesInstallAndConfig option is only available when WAS is installed with Sample applications selected.

The following optional features can be used with the -omitAction parameter for the following profile templates:

  • default - Application Server

    • deployAdminConsole
    • samplesInstallAndConfig
    • defaultAppDeployAndConfig

  • management - Management profile for the dmgr, administrative agent, or job manager

    • deployAdminConsole

  • cell - Deployment manager cell which is composed of both a dmgr and a default profile template

    • cell_dmgr (dmgr created during cell profile creation)

      • deployAdminConsole
      • samplesInstallAndConfig
      • defaultAppDeployAndConfig

-personalCertDN distinguished_name

Distinguished name of the personal certificate that we are creating when creating the profile. Specify the distinguished name in quotes. This default personal certificate is located in the server keystore file. The -importPersonalCertKSType parameter is mutually exclusive with the -personalCertDN parameter. See the -personalCertValidityPeriod parameter and the -keyStorePassword parameter.

-portsFile file_path

An optional parameter that specifies the path to a file that defines port settings for the new profile.

Do not use this parameter when using the -startingPort or -defaultPorts parameter.

During profile creation, manageprofiles uses an automatically generated set of recommended ports if we do not specify...

  • -startingPort
  • -defaultPorts
  • -portsFile

The recommended port values can be different than the default port values based on the availability of the default ports.

-profileName MyProfile

Name of the profile. Use a unique value when creating a profile. Each profile that shares the same set of product binaries must have a unique name. The default profile name is based on the profile type and a trailing number...

<profile_type><profile_number>
where

  • <profile_type> is a value such as AppSrv, Dmgr, AdminAgent, JobMgr, or Custom
  • <profile_number> is a sequential number that creates a unique profile name

The value must not contain spaces or characters that are not valid such as any of the following: *, ?, ", <, >, ,, /, /, |, and so on.

The profile name that you choose must not be in use.

-profilePath profile_root

Fully qualified path to the profile, which is referred to as the profile_root. Specify the full path to avoid an Ant scripting limitation that can cause a failure when federating the profile into a cell. For example:

-profilePath profile_root

(Windows) If the fully qualified path contains spaces, enclose the value in quotation marks.

The default value is based on the APP_ROOT directory, the profiles subdirectory, and the name of the profile.

For example, the default is:

WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName

The WS_WSPROFILE_DEFAULT_PROFILE_HOME element is defined in...

APP_ROOT/properties directory/wasprofile.properties

The value 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 reponse_file

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

create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=APP_ROOT/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1, myOptionalAction2

(Windows) The path statement in the Windows operating system can use either forward slashes (/) or back slashes (/). If the path statement uses back slashes, then the response file requires double back slashes for the response file to correctly understand the path.

create templatePath=C:\\WebSphere\\AppServer\\profileTemplates\\default

The best practice is to use forward slashes in order to reduce the chance of errors when switching between platforms.

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

-restoreProfile

Restore a profile backup.

Used with the -backupFile parameter...

manageprofiles.sh -restoreProfile -backupFile /path/to/myProfile.bak
To restore a profile...

  1. Stop the server and the running processes

  2. Manually delete the directory for the profile from the file system.

  3. Run...

    manageprofiles -validateAndUpdateRegistry

  4. Restore the profile

    manageprofiles -restoreProfile

-samplesPassword samplesPassword

Create a password to be used for samples.

The password is used to restrict access to Web app samples installed during the install of the appserver.

-securityLevel security_level

Initial security level settings for the secure proxy server. Valid values are low, medium, and high. The default value is high. The security level is based on startup user permissions, routing considerations, administration options, and error handling. We can optionally change your security settings after you create the secure proxy server profile.

-serverName server_name

Name of the server.

Specify only for the default and secureproxy templates.

If we do not specify this parameter when using the default or secureproxy templates, the default server name is server1 for the default profile, and proxy1 for the secure proxy profile.

-serverType DEPLOYMENT_MANAGER | ADMIN_AGENT | JOB_MANAGER

Type of management profile.

DEPLOYMENT_MANAGER dmgr server
ADMIN_AGENT administrative agent server
JOB_MANAGER job manager server

Required when you create a management profile.

-serviceUserName service_user_ID

User ID used during the creation of the Linux service so that the Linux service runs from this user ID. The Linux service runs whenever the user ID is logged on.

-setDefaultName

Set the default profile to one of the existing profiles.

Use with the -profileName parameter...

./manageprofiles.sh -setDefaultName -profileName MyProfile

-signingCertDN distinguished_name

Distinguished name of the root signing certificate that you create when creating the profile.

Specify in quotes. This default personal certificate is located in the server keystore file.

The -importSigningCertKS parameter is mutually exclusive with -signingCertDN.

If we do not specifically create or import a root signing certificate, one is created by default.

See...

  • -signingCertValidityPeriod
  • -keyStorePassword

-signingCertValidityPeriod validity_period

Amount of time in years that root signing certificate is valid.

If not specified with -signingCertDN parameter, the root signing certificate is valid for 20 years.

-startingPort startingPort

Starting port number for generating and assigning all ports for the profile.

Port values are assigned sequentially from the -startingPort value, omitting those ports that are already in use. The system recognizes and resolves ports that are currently in use and determines the port assignments to avoid port conflicts.

Do not use this parameter with the -defaultPorts or -portsFile parameters.

During profile creation, manageprofiles uses an automatically generated set of recommended ports if we do not specify...

  • -startingPort
  • -defaultPorts
  • -portsFile

The recommended port values can be different than the default port values based on the availability of the default ports.

Do not use this parameter if using the managed profile template.

-supportedProtocols supported_protocols

Protocols that are valid for the secure proxy server to proxy requests. Valid values are SIP, HTTP, and HTTP,SIP.

-templatePath template_path

Directory path to template files. Default location is...

APP_ROOT/profileTemplates/profile_type

We can specify profile templates that lie outside of APP_ROOT.

We can specify a relative path for the -templatePath parameter if the profile templates are relative to...

APP_ROOT/profileTemplates

Otherwise, specify the fully qualified template path.

-unaugment

Specify -unaugment and -profileName.

If a series of manageprofiles augmentations were performed, and you specify only these two parameters to unaugment a profile, the unaugment action undoes the last augment action first.

To unaugment a particular profile, additionally specify -ignoreStack with -templatePath. Normally, you would not unaugment a particular profile template to avoid violating profile template dependencies.

When using -templatePath, specify the fully qualified file path.

-unaugmentAll

Unaugments all profiles that have been augmented with a specific augmentation template.

The -templatePath parameter is required with -unaugmentAll.

When using -templatePath, specify the fully qualified file path.

Optionally specify the -unaugmentDependents parameter with the -unaugmentAll parameter to unaugment all profiles that are prerequisites of the profiles that are being unaugmented.

-unaugmentDependents true | false

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

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

-validateAndUpdateRegistry

Check profiles listed in the profile registry to see if the profiles are present on the file system.

Remove any missing profiles from the registry.

Return a list of the missing profiles that were deleted from the registry.

-validateRegistry

Check profiles listed in the profile registry to see if the profiles are present on the file system.

Return a list of missing profiles.

-validatePorts

Ports that should be validated to ensure they are not reserved or in use.

If a port is determined to be in use, the profile creation stops and an error message displays.

Use this parameter at any time on the create command line. IBM recommends to use this parameter with the -portsFile parameter.

-webServerCheck true | false

Indicates whether to set up Web server definitions. Valid values include true or false. The default value is false.

-webServerHostname webserver_host

Host name of the web server. The default value is the long host name of the local machine.

-webServerInstallPath /path/to/webserver

The installation path of the Web server, local or remote. The default value is dependent on the operating system of the local machine and the value of the webServerType parameter.

For example:

(Windows)

For webServerType=IHS:                 webServerInstallPath default: "C:/Program Files/IBM/HTTPServer" 
For webServerType=IIS:                 webServerInstallPath default: "C:/" 
For webServerType=SUNJAVASYSTEM:       webServerInstallPath default: "C:/" 
For webServerType=DOMINO:              webServerInstallPath default: "" 
For webServerType=APACHE:              webServerInstallPath default: "" 
For webServerType=HTTPSERVER_ZOS:      webServerInstallPath default: "n/a"

[Linux]

For webServerType=IHS:                 webServerInstallPath default: "/opt/IBM/HTTPServer" 
For webServerType=IIS:                 webServerInstallPath default: "n/a" 
For webServerType=SUNJAVASYSTEM:       webServerInstallPath default: "/opt/sun/webserver" 
For webServerType=DOMINO:              webServerInstallPath default: "" 
For webServerType=APACHE:              webServerInstallPath default: "" 
For webServerType=HTTPSERVER_ZOS:      webServerInstallPath default: "n/a"

[AIX]

For webServerType=IHS:                  webServerInstallPath default: "/usr/IBM/HTTPServer" 
For webServerType=IIS:                  webServerInstallPath default: "n/a" 
For webServerType=SUNJAVASYSTEM:        webServerInstallPath default: "/opt/sun/webserver" 
For webServerType=DOMINO:               webServerInstallPath default: "" 
For webServerType=APACHE:               webServerInstallPath default: "" 
For webServerType=HTTPSERVER_ZOS:       webServerInstallPath default: "n/a"

[HP-UX]

For webServerType=IHS:                  webServerInstallPath default: /opt/IBM/HTTPServer 
For webServerType=IIS:                  webServerInstallPath default: n/a 
For webServerType=SUNJAVASYSTEM:        webServerInstallPath default: /opt/sun/webserver 
For webServerType=DOMINO:               webServerInstallPath default:  
For webServerType=APACHE:               webServerInstallPath default:  
For webServerType=HTTPSERVER_ZOS:       webServerInstallPath default: n/a

[Solaris]

For webServerType=IHS:                  webServerInstallPath default: /opt/IBM/HTTPServer 
For webServerType=IIS:                  webServerInstallPath default: n/a 
For webServerType=SUNJAVASYSTEM:        webServerInstallPath default: /opt/sun/webserver 
For webServerType=DOMINO:               webServerInstallPath default:  
For webServerType=APACHE:               webServerInstallPath default:  
For webServerType=HTTPSERVER_ZOS:       webServerInstallPath default: n/a

-webServerName webserver_name

The name of the Web server. The default value is webserver1.

-webServerOS webserver_operating_system

The operating system from where the Web server resides. Valid values include: windows, linux, solaris, aix, hpux, os390, and os400.

Use this parameter with the webServerType parameter.

-webServerPluginPath webserver_pluginpath

The path to the plug-ins that the Web server uses. The default value is WAS_HOME/plugins.

-webServerPort webserver_port

Port from where the Web server will be accessed. The default value is 80.

-webServerType webserver_type

The type of the Web server. Valid values include: IHS, SUNJAVASYSTEM, IIS, DOMINO, APACHE, and HTTPSERVER_ZOS.

Use this parameter with webServerOS .

-winserviceAccountType specifieduser | localsystem

Windows. The type of the owner account of the Windows service created for the profile. Valid values include specifieduser or localsystem.

The localsystem value runs the Windows service under the local account of the user who creates the profile. The default value is localsystem.

If the value is specifieduser, the winservicePassword parameter is required. The winserviceUserName parameter defaults to the environment user.name value if not specified.

-winserviceCheck true | false

Windows. The value can be either true or false. Specify true to create a Windows service for the server process that is created within the profile. Specify false to not create the Windows service. The default value is false.

With a custom profile, we cannot create a Windows service with this parameter. Instead, use the WASService command to create the service separately.

-winservicePassword winservice_password

Windows. Password for the specified user or the local account that is to own the Windows service.

-winserviceStartupType manual | automatic | disabled

Windows. Possible startup_type values are:

  • manual
  • automatic
  • disabled

Read the topic on the WASService command for more information about Windows services.

The default value is automatic.

-winserviceUserName winservice_user_ID

Windows. User ID so that the Windows operating system can verify you as an ID that is capable of creating a Windows service. Your user ID must belong to the administrator group and have the following advanced user rights:

  • Exist as part of the operating system
  • Log on as a service

The default value is the current user name.

The value must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, /, |, and so on. The user specified must have the proper permissions to create a Windows service. Specify the correct password for the user name that you choose.

 

Usage scenario

The following examples demonstrate correct syntax. Issue the command in any of the following examples on one line. Each example shows the command on more than one line to increase clarity.

 

Create a dmgr

The following example uses the management template to create a deployment manager named Dmgr001. The dmgr ports start at port number 20000.

 
cd APP_ROOT/bin
./manageprofiles.sh -create 
                    -profileName Dmgr001 
                    -profilePath profile_root 
                    -templatePath APP_ROOT/profileTemplates/management 
                    -serverType DEPLOYMENT_MANAGER 
                    -nodeName Dmgr001Node 
                    -cellName Dmgr001NodeCell 
                    -hostName localhost 
                    -isDefault 
                    -startingPort 20000 

 

Create an administrative agent

The following example uses the management template to create an administrative agent named AdminAgent001. The administrative agent ports start at port number 24000.

cd APP_ROOT/bin/
./manageprofiles.sh -create 
                    -profileName AdminAgent001
                    -profilePath profile_root
                    -templatePath APP_ROOT/profileTemplates/management
                    -serverType ADMIN_AGENT
                    -nodeName AdminAgent001Node
                    -hostName localhost
                    -isDefault
                    -startingPort 24000

 

Create a job manager

The following example uses the management template to create a job manager named JobMgr001. The job manager ports start at port number 25000.

cd APP_ROOT/bin/
./manageprofiles.sh -create 
                    -profileName JobMgr001
                    -profilePath profile_root
                    -templatePath APP_ROOT/profileTemplates/management
                    -serverType JOB_MANAGER
                    -nodeName JobMgr001Node
                    -cellName JobMgr001NodeCell
                    -hostName localhost
                    -isDefault
                    -startingPort 25000

 

Create a secure proxy

Use the secureproxy template to create a secure proxy named SecureProxySrv001. The secure proxy ports start at port number 26000.

cd APP_ROOT/bin/
./manageprofiles.sh -create 
                    -profileName SecureProxySrv001
                    -profilePath profile_root
                    -templatePath APP_ROOT/profileTemplates/secureproxy
                    -nodeName SecureProxySrv001Node
                    -serverName secproxy1
                    -hostName localhost
                    -isDefault
                    -startingPort 26000

 

Create a custom profile

Creates a custom profile and federate the profile into the dmgr cell.

 
cd APP_ROOT/bin
./manageprofiles.sh -create 
                    -profileName Custom01
                    -profilePath profile_root
                    -templatePath APP_ROOT/profileTemplates/managed
                    -nodeName Custom01Node
                    -cellName Custom01Cell
                    -hostName myhost.mycity.mycompany.com
                    -isDefault
                    -dmgrHost myhost.mycity.mycompany.com
                    -dmgrPort 8879
                    -startingPort 22000

 

Create an application server profile

Create an appserver profile named Default01 with the following command.

Windows. The command also creates a Windows service for the appserver, personal and root signing certificates for the profile, and a keystore password for the two certificates.

cd APP_ROOT/bin 
./manageprofiles.sh -create 
                    -profileName Default01 
                    -profilePath profile_root
                    -templatePath APP_ROOT/profileTemplates/default 
                    -nodeName Default01Node
                    -cellName Default01Cell
                    -hostName myhost.mycity.mycompany.com
                    -isDefault 
                    -winserviceCheck true
                    -winserviceAccountType specifieduser
                    -winserviceUserName my_user_id
                    -winservicePassword my_password
                    -winserviceStartupType manual
                    -startingPort 21000
                    -personalCertDN "cn=testa, ou=Rochester, o=IBM, c=US"
                    -signingCertDN "cn=testc, ou=Rochester, o=IBM, c=US"
                    -keyStorePassword ap3n9krw

APP_ROOT/bin/manageprofiles.sh -create 
   -profileName Default01
   -profilePath profile_root
   -templatePath APP_ROOT/profileTemplates/default
   -nodeName Default01Node
   -cellName Default01Cell
   -hostName myhost.mycity.mycompany.com
   -isDefault
   -startingPort 21000
   -personalCertDN "cn=testa, ou=Rochester, o=IBM, c=US"     
   -signingCertDN "cn=testc, ou=Rochester, o=IBM, c=US"     
   -keyStorePassword ap3n9krw

 

Create a cell profile

Create a cell profile requires the creation of both the dmgr and the appserver portion of the cell profile. The two profiles are linked and some parameters must match between the creation parameters of the deployment manager and the appserver portion of the cell profile.

The following example shows the creation of a cell profile named Dmgr001 having a cell name of Default01Cell and a node name of Default01Node. To create a full working cell, the -nodeProfilePath, -cellName, -appServerNodeName, -nodeName parameters are required to match between the cell_dmgr profile and the cell_node profile.

  1. Create the dmgr portion of the cell profile.

     APP_ROOT/bin/manageprofiles.sh -create 
                                   -templatePath APP_ROOT/profileTemplates/cell/dmgr
                                   -nodeProfilePath APP_ROOT/profiles/AppSrv01
                                   -profileName Dmgr001
                                   -cellName Default01Cell
                                   -nodeName Default01Node
                                   -appServerNodeName Default02Node
    
  2. Create the appserver portion of the cell profile.

     APP_ROOT/bin/manageprofiles.sh -create
                                   -templatePath APP_ROOT/profileTemplates/cell/default
                                   -dmgrProfilePath APP_ROOT/profiles/Dmgr001
                                   -portsFile APP_ROOT/profiles/Dmgr001/properties/portdef.props
                                   -nodePortsFile APP_ROOT/profiles/Dmgr001/properties/nodeportdef.props
                                   -profileName AppSrv01
                                   -cellName Default01Cell
                                   -nodeName Default01Node
                                   -appServerNodeName Default02Node
    
    

 

Logs

manageprofiles creates a log for every profile that it creates.

APP_ROOT/logs/manageprofiles/MyProfile_create.log

manageprofiles also creates a log for every profile that it deletes. The logs are in...

APP_ROOT/logs/manageprofiles/MyProfile_delete.log





Subtopics

Example: Creating a dmgr profile
Manageprofiles command: Example for creating a cell profile
Example: Using predefined port numbers
Example: Incrementing default port numbers from a starting point

 

Related tasks

Delete a profile
Manage profiles
Manage profiles using commands

 

Related information

Use command line tools