2.4. Manipulate profiles using the Profile Management Tool and manageprofiles command.

2.4. Manipulate profiles using the Profile Management Tool and `manageprofiles` command.
Prev	Chapter 2. Installation, Configuration and Maintenance	Next

2.4. Manipulate profiles using the Profile Management Tool and `manageprofiles` command.


	[WAS_8.0_INFOCENTER] Useful WebSphere 8 Install Scripts

Profiles can be created at any time during or after installation using graphical or command-line tools. WebSphere Application Server provides the following profile management tools:

The manageprofiles command: A command-line interface for profile management functions.
Profile Management Tool (PMT): A GUI interface in the WebSphere Customization Toolbox (WCT) that gathers user input and invokes the manageprofiles command-line tool to manage the profiles.

Profile Management Tool

The WebSphere Customization Toolbox (WCT) for WebSphere Application Server V8 includes tools for managing, configuring, and migrating various parts of your WebSphere Application Server environment. It is an Eclipse framework application that existed in Version 7, but had a vastly smaller function (it was used only to configure z/OS servers). WebSphere Customization Toolbox is a container framework that holds various tools that are used for configuring your application server environment.

WebSphere Customization Toolbox (WCT) is available as two different offerings, and each offering has various combinations of tools on different platforms. The two offerings are as follows:

Embedded
Stand-alone

Each offering for WebSphere Customization Toolbox is installed, modified, rolled back, and updated using the Installation Manager. WebSphere Customization Toolbox can be installed silently, using the command line, or interactively using the GUI or console mode.

There are a few ways you can start the WebSphere Customization Toolbox, which depends on the WebSphere Customization Toolbox offering being used and the operating system. To start the WebSphere Customization Toolbox, use of the following methods:

On Windows and Linux platforms, a start menu shortcut is created for both the embedded and stand-alone offering.
Launch wct.sh from was_install/bin/ProfileManagement/WCT/ for the embedded offering.
Launch wct.sh from wct_install>\WCT\ for the stand-alone offering.

NOTE: The pmt.sh command is still available for backward compatibility. However, it has been deprecated in WebSphere Application Server V8.

Complete the following steps to create the profile:

Start the WebSphere Customization Toolbox.
When you start the wizard, you see the Profile Management Tool tab. Then you see a list of existing profiles. Click Create to start the profile creation process, as shown below:

Figure 2.8.
The Profile Management Tool provides multiple profile templates, including the cell template, which has the ability to create a cell in a single step. During profile creation, you will be asked to select the type of profile to create, as shown below:

Figure 2.9.
The profile options are listed next. Note that the deployment manager profile is under the Management option, along with the profile types for flexible management (administrative agent and job manager):
- Cell (deployment and a federated application server)
- Management
  - Administrative agent
  - Deployment manager
  - Job manager
- Application server
- Custom profile
- Secure proxy (configuration-only)
Figure 2.10.
While creating profiles, you are presented with a choice of following the "Typical" path, where a set of default values for most settings will be used, or an "Advanced" path, which lets you specify values for each option.

Figure 2.11.
Installing the administrative console is recommended. However, there might be some circumstances when you would not want to install an administrative console, such as though you plan to control all administrative tasks through scripting. If you do not install the administrative console during profile creation, you can install using the deployConsole.py script at a later time.

Figure 2.12.
The wizard asks for a profile name and a location where you want the profile configuration files stored.
By default, profiles are stored in install_root/profiles/profile_name. The logs for the process defined by the profile reside within this directory structure, but you can easily change this setting if space is a concern.
The first profile that you create on a machine is the default profile. The default profile is the default target for commands that are issued from the bin directory in the product installation root when the -profileName argument is not used.
You can make another profile the default profile when you create that profile by checking Make this profile the default on the Profile name and location window of the Advanced profile creation path. You can also make another profile the default profile using the manageprofiles.sh command after you create the profile.
The profile name must be unique within the installation.

Figure 2.13.
Enter the node, host, and cell names. The defaults are based on the host name of your system. The wizard recognizes if there are existing cells and nodes in the installation and takes this setup into account when creating the default names.

Figure 2.14.
Choose whether to enable administrative security. If you enable security here, you are asked for a user ID and password that will be added to a file-based user registry with the Administrator role.

Figure 2.15.
Elect to either create new default personal and root signing certificates or to import them.

Figure 2.16.
Review and modify the certificate information as needed.

Figure 2.17.
The wizard presents a list of TCP/IP ports for use by the deployment manager. If you already have existing profiles on the system, they are taken into account when the wizard selects the port assignments. However, you should verify that these ports will be unique on the system.

Figure 2.18.
If you would like to run the process as a Windows or Linux service, leave the check box selected and enter the values for the logon and startup type.

Figure 2.19.
Review the options that you have chosen. If you took the Typical path through the wizard, make sure that the default selections suit your needs. Click Create to create the profile.

Figure 2.20.

The final window indicates the success or failure of the profile creation. If you have errors, check the log at:
install_root/logs/manageprofiles/profile_name_create.log
You can also find logs for individual actions stored in:
profile_root/logs
Figure 2.21.
Verify the installation. You can do this directly from the First Steps menu. The IVT process starts the deployment manager and checks the log file for warnings or errors on start.

Figure 2.22.

Figure 2.23.
Open the administrative console by selecting the option in the First Steps window, or by accessing its URL from a web browser:
http://dmgr_host:admin_console_port/ibm/console
Here is a sample URL in the address bar:
http://http://test317.java.boot.by:9061/ibm/console/

Figure 2.24.
Log in and display the configuration from the console. You should be able to see the following items from the administrative console:
Cell information: Select System administration > Cell

Figure 2.25.

Deployment manager: Select System administration > Deployment manager

Figure 2.26.

Deployment manager node: Select System administration > Nodes

Figure 2.27.

The default node group: Select System administration > Node groups.

Figure 2.28.

manageprofiles command

Each profile you create is registered in a profile registry:

install_root/properties/profileRegistry.xml

You have already seen how profiles are created with the Profile Management Tool. At the heart of this wizard is the manageprofiles.sh command. This command enables you to maintain activities for profiles. For example, you can call this command to create profiles natively or silently, list profiles, delete profiles, validate the profile registry, and other functions.

Using the manageprofiles command

The manageprofiles.sh command can be found in the install_root/bin directory. The syntax is manageprofiles.sh -mode -arguments. The modes listed below are available:

-create Creates a new profile.
-delete Deletes a profile.
-augment Augments the given profile using the given profile template.
-unaugment Unaugments the profile.
-unaugmentAll Unaugments all the profiles.
-deleteAll Deletes all registered profiles.
-listProfiles Lists the profiles in the profile registry.
-listAugments Lists the registered augments on a profile that is in the profile registry.
-getName Returns the name of the profile at the path specified.
-getPath Returns the path of the profile name specified.
-validateRegistry Validates the profile registry and returns a list of profiles that are not valid.
-validateAndUpdateRegistry Validates the profile registry and lists the non-valid profiles that it purges.
-getDefaultName Returns the name of the default profile.
-setDefaultName Sets the default profile.
-backupProfile Back ups the given profile into a compressed file.
-restoreProfile Restores the given profile from a compressed file.
-response Manage profiles from a response file.
-help Shows help.

Creating a profile with the manageprofiles command

You can use the manageprofiles.sh command to create profiles.

Profile templates

Profiles are created based on templates supplied with the product. These templates are located in install_root/profileTemplates. Each template consists of a set of files that provide the initial settings for the profile and a list of actions to perform after the profile is created. When you create a profile using manageprofiles.sh, you need to specify one of the following templates:

Default (for application server profiles)
Management (for deployment manager, job manager, and administrative agent profiles)
Managed (for custom profiles)
Cell (for cell profiles)

As of WAS version 7.0, the old deployment manager profile template is deprecated. Instead, you are encouraged to use the management profile with a server type of DEPLOYMENT_MANAGER.

For example, the command used to create a deployment manager under profile name Dmgr01 is shown below:

test317:/opt/IBM/WebSphere/AppServer/bin # ./manageprofiles.sh -create -profileName Dmgr01 -templatePath ../profileTemplates/management -serverType DEPLOYMENT_MANAGER
INSTCONFSUCCESS: Success: Profile Dmgr01 now exists. Please consult /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/logs/AboutThisProfile.txt for more information about this profile.

Log files that result when you run the manageprofiles command are located in:

install_root/logs/manageprofile/profilename_action.log

For example:


test317:/opt/IBM/WebSphere/AppServer/bin # tail /opt/IBM/WebSphere/AppServer/logs/manageprofiles/Dmgr01_create.log

    <millis>1368838117149</millis>
    <sequence>3828</sequence>
    <logger>com.ibm.wsspi.profile.WSProfileCLI</logger>
    <level>INFO</level>
    <class>com.ibm.wsspi.profile.WSProfileCLI</class>
    <method>invokeWSProfile</method>
    <thread>0</thread>
    <message>Returning with return code: INSTCONFSUCCESS</message>
</record>
</log>

Additional log files are created in:

install_root/logs/manageprofile/profile_name/

For example:


test317:/opt/IBM/WebSphere/AppServer/bin # ls -l /opt/IBM/WebSphere/AppServer/logs/manageprofiles/Dmgr01
total 96

-rwxr-xr-x 1 root root  3267 May 17 20:47 SIBDefineChains.log
-rwxr-xr-x 1 root root 21890 May 17 20:47 SIBGenericDeployRAs.log
-rwxr-xr-x 1 root root   173 May 17 20:47 SetSecurity.log
-rwxr-xr-x 1 root root  1597 May 17 20:47 collect_metadata.log
-rwxr-xr-x 1 root root     0 May 17 20:46 copyFiles.log
-rwxr-xr-x 1 root root 13552 May 17 20:48 createOTiSinstallSchemaConvertTimeDerby.log
-rwxr-xr-x 1 root root  1453 May 17 20:48 createOTiSinstallSchemaJobManagerExt_derby.log
-rwxr-xr-x 1 root root  1654 May 17 20:48 createOTiSinstallSchemaTaskManagerSchema_derby.log
-rwxr-xr-x 1 root root  1003 May 17 20:48 createOTiSinstallSchemacreateOMADMTables_derby.log
-rwxr-xr-x 1 root root   183 May 17 20:48 createShortcutForProfile.log
-rwxr-xr-x 1 root root   167 May 17 20:48 createVirtualHost.log
-rwxr-xr-x 1 root root   230 May 17 20:47 generateProfileKey.log
-rwxr-xr-x 1 root root   167 May 17 20:47 hamanager_config.log
-rwxr-xr-x 1 root root   168 May 17 20:46 importWasmanagementprofile.log
-rwxr-xr-x 1 root root   242 May 17 20:47 keyGeneration.log
-rwxr-xr-x 1 root root  5923 May 17 20:48 wsadminListener.log

Options for specifying ports

During profile creation using the manageprofiles.sh command, you can accept the default port values, or you can specify your port settings. If you want to specify ports, you can do so in any of the following ways:

Specify the use of a port file that contains the port values.
-portsFile: Specifies a path to a file that defines port settings for the profile.
Specify the use of a starting port value.
-startingPort: Specifies the starting port number for generating and assigning all ports for the profile.
Specify the use of the default port values.
-defaultPorts: Assigns default or base port values to the profile.

Deleting profiles

To delete a profile, complete the following steps (according to your situation):

If you are removing a custom profile or application server profile that has been federated to a cell:
- Stop the application servers on the node.
- Remove the node from the cell using the administrative console or the removeNode.sh command. Removing a node does not delete it, but restores it to its pre-federated configuration that was saved as part of the federation process
- Delete the profile using:
```
manageprofiles.sh -delete -profileName profile_name
											
```
- Use the manageprofiles.sh -validateAndUpdateRegistry command to clean the profile registry.
- Delete the profile_root directory.
If you are removing an application server profile that has not been federated to a cell:
- Stop the application server
- Delete the profile using:
```
manageprofiles.sh -delete -profileName profile_name
											
```
- Use the manageprofiles.sh -validateAndUpdateRegistry command to clean the profile registry.
- Delete the profile_root directory.
If you are removing a deployment manager profile:
- Remove any nodes federated to the cell using the administrative console or the removeNode.sh command. Removing a node does not delete it, but restores it to its pre-federated configuration that was saved as part of the federation process.
- Stop the deployment manager.
- Delete the profile using:
```
manageprofiles.sh -delete -profileName profile_name
											
```
- Use the manageprofiles.sh -validateAndUpdateRegistry command to clean the profile registry.
- Delete the profile_root directory.

Prev	Up	Next
2.3. Create and manage nodes in a WebSphere topology (e.g., flexible management, network deployment cell).	Home	2.5. Perform pre-installation verification and troubleshoot the installation (e.g., identify and analyze log files, Installation Verification Tool (IVT)).