manageprofiles command

You can use the manageprofiles utility to create profiles with the WebSphere® eXtreme Scale template, and augment and unaugment existing application server profiles with the eXtreme Scale augment templates. To use the features of the product, your environment must contain at least one profile augmented for the product.

Purpose

The manageprofiles command creates the runtime environment for a product process in a set of files called a profile. The profile defines the runtime environment. You can perform the following actions with the manageprofiles command:
  • Create and augment a deployment manager profile
  • Create and augment a custom profile
  • Create and augment stand-alone application server profile
  • Create and augment a cell profile
  • Unaugment any type of profile
When you augment an existing profile, you change the profile by applying a product-specific augmentation template.
  • Augment the profile with the xs_augment template if you installed the eXtreme Scale client or both the client and server.

Location

The command file is in the install_root/bin directory.

Usage

For detailed help, use the -help parameter:
./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/dmgr -help

In the following sections, each task that you can perform using the manageprofiles command, along with a list of required parameters, is described. For details on the optional parameters to specify for each task, see the manageprofiles command in the WebSphere Application Server Information Center.

Create a deployment manager profile

You can use the manageprofiles command to create a deployment manager profile. The deployment manager administers the application servers that are federated into the cell.

Parameters

-create
Creates a profile. (Required)
-templatePath template_path
Specifies the file path to the template. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/dmgr

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/dmgr

Create a custom profile

You can use the manageprofiles command to create a custom profile. A custom profile is an empty node that you customize through the deployment manager to include application servers, clusters, or other Java™ processes.

Parameters

-create
Creates a profile. (Required)
-templatePath template_path
Specifies the file path to the template. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/managed

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/managed

Create a stand-alone application server profile

You can use the manageprofiles command to create a stand-alone application server profile.

Parameters

-create
Creates a profile. (Required)
-templatePath template_path
Specifies the file path to the template. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/default

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/default

Create a cell profile

You can use the manageprofiles command to create a cell profile, which consists of a deployment manager and an application server.

Parameters

Specify the following parameters in the deployment manager template:
-create
Creates a profile. (Required)
-templatePath template_path
Specifies the file path to the template. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/cell/dmgr
Specify the following parameters with the application server template:
-create
Creates a profile. (Required)
-templatePath template_path
Specifies the file path to the template. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/cell/default

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/cell/dmgr 
    -nodeProfilePath install_root/profiles/AppSrv01 -cellName cell01dmgr -nodeName node01dmgr 
    -appServerNodeName node01
    
    ./manageprofiles.sh|bat -create -templatePath install_root/profileTemplates/xs_augment/cell/default 
    -dmgrProfilePath install_root/profiles/Dmgr01 -portsFile 
    install_root/profiles/Dmgr01/properties/portdef.props -nodePortsFile 
    install_root/profiles/Dmgr01/properties/nodeportdef.props -cellName cell01dmgr 
    -nodeName node01dmgr -appServerNodeName node01

Augment a deployment manager profile

You can use the manageprofiles command to augment a deployment manager profile.

Parameters

-augment
Augments the existing profile. (Required)
-profileName
Specifies the name of the profile. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/dmgr

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -augment -profileName profile01 
    -templatePath install_root/profileTemplates/xs_augment/dmgr

Augment a custom profile

You can use the manageprofiles command to augment a custom profile.

Parameters

-augment
Augments the existing profile. (Required)
-profileName
Specifies the name of the profile. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/managed

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -augment -profileName profile01 
    -templatePath install_root/profileTemplates/xs_augment/managed

Augment a stand-alone application server profile

You can use the manageprofiles command to augment a stand-alone application server profile.

Parameters

-augment
Augments the existing profile. (Required)
-profileName
Specifies the name of the profile. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/default

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -augment -profileName profile01 
    -templatePath install_root/profileTemplates/xs_augment/default

Augment a cell profile

You can use the manageprofiles command to augment a cell profile.

Parameters

Specify the following parameters for the deployment manager profile:
-augment
Augments the existing profile. (Required)
-profileName
Specifies the name of the profile. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/cell/dmgr
Specify the following parameters for the application server profile:
-augment
Augments the existing profile. (Required)
-profileName
Specifies the name of the profile. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Required)
Use the following format:
-templatePath install_root/profileTemplates/template_type/cell/default

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -augment -profileName profile01 -templatePath install_root
    				/profileTemplates/xs_augment/cell/dmgr
    
    ./manageprofiles.sh|bat -augment -profileName profile01 -templatePath install_root
    				/profileTemplates/xs_augment/cell/default

Unaugment a profile

To unaugment a profile, specify the -ignoreStack parameter with the -templatePath parameter in addition to specifying the required -unaugment and -profileName parameters.

Parameters

-unaugment
Unaugments a previously augmented profile. (Required)
-profileName
Specifies the name of the profile. The parameter is issued by default if no values are specified. (Required)
-templatePath template_path
Specifies the path to the template files that are located in the installation root directory. (Optional)
Use the following format:
-templatePath install_root/profileTemplates/template_type/profile_type
where template_type is xs_augment or pf_augment and profile_type is one of four profile types:
  • dmgr: deployment manager profile
  • managed: custom profile
  • default: stand-alone application server profile
  • cell: cell profile
-ignoreStack
Used with the -templatePath parameter to unaugment a particular profile that has been augmented. (Optional)

Example

  • Using the xs_augment template:
    ./manageprofiles.sh|bat -unaugment -profileName profile01 -ignoreStack 
    -templatePath install_root/profileTemplates/xs_augment/profile_type