Create management profiles with administrative agents

(Dist) Create management profiles with administrative agents

Create a management profile for the administrative agent to administer multiple application servers that run customer applications only. The administrative agent provides a single administrative console to administer the application servers.

The Profile Management Tool is the graphical user interface for the manageprofiles command and is supported only on AIX, Linux, and Windows. On HP-UX, IBM i, and Solaris, use the manageprofiles command instead.
To create a profile, provide enough system temporary space.
When launching the Profile Management Tool, the tool could lock up in the following situation for a non-root user: Log into a machine as root, use the SetPermissions utility to change the user from x to y. Assume that we are user x and log back into the machine. Launch the Profile Management Tool, click Profile Management Tool, and click Create. The next click after the click on Create could lock up the tool.
After installing the core product files for the product, create a profile. This procedure describes creating a management profile with an administrative agent server using the graphical user interface provided by the Profile Management Tool. We can also use the manageprofiles command to create an administrative agent.
Create profiles with the Profile Management Tool using the typical profile creation process or the advanced profile creation process. The typical profile creation process uses default settings and assigns unique port values. We can optionally set values as allowed. For the advanced profile creation process we can accept the default values, or specify our own values.

Create management profiles with administrative agents

Start the Profile Management Tool using one of the following methods...

At the end of installation, select the check box to launch the Profile Management Tool.
Open the WebSphere Customization Toolbox directly from a command prompt; then, open the Profile Management Tool.
Select the WebSphere Customization Toolbox option from the First steps console; then, open the Profile Management Tool.
(Windows) Use the Start menu to access the WebSphere Customization Toolbox; then, open the Profile Management Tool.
(Linux) Use the Linux operating system menus used to start programs to start the WebSphere Customization Toolbox; then, open the Profile Management Tool.

To create a new profile, click Create on the Profiles tab
The Profiles tab contains a list of profiles created on the machine. No action can be done on a selected profile unless the profile can be augmented. The Augment button is greyed out unless a profile that we select can be augmented.

The tool displays the Environment selection panel.

Select Management, and click Next.
The Server type selection panel is displayed.

Select Administrative agent. Click Next.
The Profile creation options panel is displayed.

Select either Typical profile creation or Advanced profile creation, and click Next.
The Typical profile creation option creates a profile that uses default configuration settings. With the Advanced profile creation option, we can specify our own configuration values for a profile.

If we selected Typical profile creation, go to the step on administrative security.
If we selected Advanced profile creation, optionally select to deploy the administrative console and then click Next.
If we chose not to deploy the administrative console, then the administrative console ports are disabled on the Ports panel.

The tool displays the Profile name and location panel.

Specify a name for the profile and the directory path for the profile directory, or accept the default values. Then, click Next.
Profile naming guidelines: Double-byte characters are supported. The profile name can be any unique name with the following restrictions. Do not use any of the following characters when naming the profile:

Spaces
Special characters that are not supported within the name of a directory on the operating system, such as *&?
Slashes (/) or (\)

The default profile

The first profile created 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 only one profile exists on a machine, every command works on the single server process in the configuration. We can make another profile the default profile when we create that profile by checking Make this profile the default on the Profile name and location panel of the Advanced profile creation path. We can also make another profile the default profile using the manageprofiles command after creating the profile.

Addressing a profile in a multiprofile environment

When multiple profiles exist on a machine, certain commands require specified the profile to which the command applies if the profile is not the default profile. These commands use the -profileName parameter to identify which profile to address. We might find it easier to use the commands in the bin directory of each profile.

Use these commands to query the command shell to determine the calling profile and to address these commands to the calling profile.

The default profile name is...
<profile_type><profile_number>

...where <profile_type> is a value of AppSrv, Dmgr, Custom, AdminAgent, JobMgr, or SecureProxySrv.
<profile_number> is a sequential number used to create a unique profile name
(AIX) (Linux) The default profile directory is app_server_root/profiles, where app_server_root is the installation root.

(Windows) The default profile directory is app_server_root\profiles, where app_server_root is the installation root.

On the Node, host, and cell names panel, specify a unique node name, the actual host name of the machine, and a unique cell name. Click Next.

Field name Default value Constraints Description
Node name shortHostName
AANode
NodeNumber
where:

shortHostName is the short host name.
NodeNumber is a sequential number starting at 01.

Use a unique name for the administrative agent. The name is used for administration within the administrative agent cell.
Host name
The long form of the DNS name.
The host name must be addressable through the network. Use the actual DNS name or IP address of our machine to enable communication with the machine. See additional information about the host name that follows this table.
Cell name shortHostName
Cell
CellNumber
where:

shortHostName is the short host name.
CellNumber is a sequential number starting at 01.

Use a unique name for the cell. If we plan to migrate a cell to v9.0, use the same cell name as the previous version cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names must also be unique if their namespaces are federated. Otherwise, we might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells. All federated nodes become members of the cell, which you name in this panel.

Reserved names: Avoid using reserved folder names as field values. The use of reserved folder names can cause unpredictable results. The following terms are reserved folder names:

cells
nodes
servers
clusters
applications
deployments

Directory path length:

(Windows) The number of characters in the profiles_directory_path\profile directory must be less than or equal to 80 characters.

Host name considerations:

The host name is the network name for the physical machine on which the node is installed. The host name must resolve to a physical network node on the server. When multiple network cards exist in the server, the host name or IP address must resolve to one of the network cards. Remote nodes use the host name to connect to and communicate with this node. Selecting a host name that other machines can reach within the network is important. Do not use the generic identifier, localhost, for this value. Also, do not attempt to install WAS products on a machine with a host name that uses characters from a double-byte character set (DBCS). DBCS characters are not supported when used in the host name.

If we define coexisting nodes on the same computer with unique IP addresses, then define each IP address in a DNS look-up table. Configuration files for standalone application servers do not provide domain name resolution for multiple IP addresses on a machine with a single network address.

The value specified for the host name is used as the value of the hostName property in configuration documents for the standalone application server. Specify the host name value in one of the following formats:

Fully qualified DNS host name string, such as xmachine.manhattan.ibm.com
The default short DNS host name string, such as xmachine
Numeric IP address, such as 127.1.255.3

The fully qualified DNS host name has the advantages of being unambiguous and flexible. We have the flexibility of changing the actual IP address for the host system without having to change the application server configuration. This value for the host name is particularly useful if we plan to change the IP address frequently when using Dynamic Host Configuration Protocol (DHCP) to assign IP addresses. A disadvantage of this format is dependency on DNS. If DNS is not available, then connectivity is compromised.

The short host name is also dynamically resolvable. A short name format has the added function of being redefined in the local hosts file so the system can run the application server, even when disconnected from the network. To run disconnected, define the short name as the loopback address, 127.0.0.1, in the hosts file to run disconnected. A disadvantage of this format is a dependency on DNS for remote access. If DNS is not available, then connectivity is compromised.

A numeric IP address has the advantage of not requiring name resolution through DNS. A remote node can connect to the node that you name with a numeric IP address without DNS being available. A disadvantage of this format is that the numeric IP address is fixed.

After displaying characteristics, the tool displays the Administrative security panel.

Optionally enable administrative security, and click Next.
We can enable administrative security now during profile creation, or later from the console. If we enable administrative security now, then enter a user name and password to log onto the administrative console.

After specifying security characteristics, the tool displays the Security certificate panel if we previously selected Advanced profile creation.

If we selected Typical profile creation at the beginning of these steps, then go to the step that displays the Profile summary panel.
Create a default personal certificate and a root signing certificate, or import a personal certificate and a root signing certificate from keystore files, and click Next.
Create both certificates, import both certificates, or create one certificate, and import the other certificate. When importing a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, the Profile Management Tool adds the signer of the personal certificate to the trust.p12 file. If we import the default personal certificate or the root signing certificate, specify the path and the password, and select the keystore type and the keystore alias for each certificate that we import.

Verify that the certificate information is correct, and click Next.
If we create the certificates, we can use the default values or modify them to create new certificates. The default personal certificate is valid for one year by default and is signed by the root signing certificate. The root signing certificate is a self-signed certificate that is valid for 15 years by default. The default keystore password for the root signing certificate is WebAS. We should change the password. The password cannot contain any double-byte character set (DBCS) characters because certain keystore types, including PKCS12, do not support these characters. The keystore types supported depend on the providers in the java.security file.

When we create either or both certificates, or import either or both certificates, the keystore files created are key.p12, trust.p12, root-key.p12, default-signers.p12, deleted.p12, and ltpa.jceks. These files all have the same password when we create or import the certificates, which is either the default password, or a password specified. The key.p12 file contains the default personal certificate. The trust.p12 file contains the signer certificate from the default root certificate. The root-key.p12 file contains the root signing certificate. The default-signer.p12 file contains signer certificates that are added to any new keystore file that we create after the server is installed and running. By default, the default root certificate signer and a DataPower signer certificate is in the default-signer.p12 keystore file. The deleted.p12 keystore file is used to hold certificates deleted with the deleteKeyStore task so that they can be recovered if needed. The ltpa.jceks file contains server default Lightweight Third-Party Authentication (LTPA) keys that the servers in the environment use to communicate with each other.

An imported certificate is added to the key.p12 file or the root-key.p12 file. If we import any certificates and the certificates do not contain the information that we want, click Back to import another certificate. After displaying the Security certificate panels, the tool displays the Ports panel if we previously selected Advanced profile creation.

Verify that the ports within the administrative agent profile are unique, or intentionally conflicting, and click Next.
If we chose not to deploy the administrative console, then the administrative console ports are disabled on the Ports panel.

Port conflict resolution
Ports are recognized as being in use if one of the following conditions exists:

The ports are assigned to a profile created from an installation performed by the current user.
The port is currently in use.

Validation of ports occurs when we access the Port value assignment panel. Conflicts can still occur between the Port value assignment panel and the Profile creation complete panel because ports are not assigned until profile creation completes.
If we suspect a port conflict, then we can investigate the port conflict after the profile is created. Determine the ports used during profile creation by examining the following files.

(AIX) (Linux) profile_root/properties/portdef.props file
(Windows) profile_root\properties\portdef.props file
Included in this file are the keys and values used in setting the ports. If we discover ports conflicts, then we can reassign ports manually. To reassign ports, run the updatePorts.ant file using the ws_ant script.
(Windows) (Linux) The tool displays the Windows service definition panel if we are installing on a Windows operating system and the installation ID has the administrative group privilege. The tool displays the Linux service definition panel if we are installing on a supported Linux operating system and the ID that runs the Profile Management Tool is the root user.

(Windows) (Linux) Choose whether to run the administrative agent process as a Windows service on a Windows operating system or as a Linux service on a Linux operating system, and click Next.
The Windows service definition panel is displayed for the Windows operating system only if the ID that installs the Windows service has the administrator group privilege. However, we can run the WASService.exe command to create the Windows service as long as the installer ID belongs to the administrator group. Read about automatically restarting server processes for more information.

(Windows) The product attempts to start Windows services for administrative agent processes that are started by a startServer command. For example, if we configure an administrative agent as a Windows service and issue the startServer command, then the wasservice command attempts to start the defined service.

If we chose to install a local system service, then we do not have to specify a user ID or password. If we create a specified user type of service, then specify the user ID and the password for the user who runs the service. The user must have Log on as a service authority for the service to run correctly. If the user does not have Log on as a service authority, then the Profile Management tool automatically adds the authority.

To perform this profile creation task, the user ID must not contain spaces. In addition to belonging to the administrator group, the ID must also have the advanced user privilege of Log on as a service. The Installation program grants the user ID the advanced user access if the user ID does not already have the advanced user privileges and if the user ID belongs to the administrator group.

We can also create other Windows services after the installation is complete to start other server processes. Read about automatically restarting server processes for more information.

We can remove the Windows service that is added during profile creation during profile deletion. We can also remove the Windows service with the wasservice command.

IPv6 considerations

Profiles created to run as a Windows service fail to start when using Internet Protocol version 6 (IPv6) if the service is configured to run as local system. Create a user-specific environment variable to enable IPv6. Since this environment variable is a user variable instead of a local system variable, only a Windows service that runs as that specific user can access this environment variable. By default, when a new profile is created and configured to run as a Windows service, the service is set to run as local system. When the Windows service for the administrative agent process attempts to run, the service is unable to access the user environment variable that specifies IPv6, and thus, attempts to start as IPv4. The server does not start correctly in this case. To resolve the problem, when creating the profile, specify that the Windows service for the administrative agent process runs as the same user ID from which the environment variable that specifies IPv6 is defined, instead of as local system.

(Windows) The following default values for the Windows service definition panel exist:

The default is to run as a Windows service.
The service process is selected to run as a system account.
The user account is the current user name. User name requirements are the requirements that the Windows operating system imposes for a user ID.
The startup type is automatic. The values for the startup type are those values that the Windows operating system imposes. To have a startup type other than automatic, we can either select another available option from the menu or change the startup type after creating the profile. We can also remove the created service after profile creation, and add it later with the desired startup type. We can choose not to create a service at profile creation time and optionally create the service later with the desired startup type.

(Linux) The Linux service definition panel is displayed if the current operating system is a supported version of Linux operating systems, and the current user has the appropriate permissions.

The product attempts to start Linux services for application server processes that are started by a startServer command. For example, if we configure an application server as a Linux service and issue the startServer command, then the wasservice command attempts to start the defined service.

By default, the product is not selected to run as a Linux service.

To create the service, the user that runs the Profile Management Tool must be the root user. If we run the Profile Management Tool with a non-root user ID, then the Linux service definition panel is not displayed, and no service is created.

When we create a Linux service, specify a user name from which the service runs.

To delete a Linux service, the user must be the root user or have appropriate privileges for deleting the service. Otherwise, a removal script is created that the root user can run to delete the service for the user.

The tool displays the Profile creation summary panel.

Click Create to create the management profile for the administrative agent, or click Back to change the characteristics of the profile.
The Profile creation progress panel, which shows the configuration commands running, is displayed.

When the profile creation completes, the tool displays the Profile creation complete panel.

Optionally, select Launch the First steps console. Click Finish to exit.
With the First steps console, we can create additional profiles and start the application server.

Created a management profile for the administrative agent.

Refer to the description of the manageprofiles command to learn about creating a profile using a command instead of the Profile Management Tool.

What to do next

Register application servers with the administrative agent using the registerNode command. Then, access the administrative agent console to administer the application servers.

Related:

Profile concepts
Profiles: File-system requirements