Run the setupadm command for the administration server

Run the setupadm command if you need to configure the administration server manually or you need to modify its configuration.


Before you begin

The plugin configuration tool (PCT) is the supported way to configure the IBM HTTP Server administration server. If we cannot run PCT, manual instructions are provided in this topic.Avoid trouble: Prior to running setupadm, you must first run:
cd /path/to/IHS
bin/postinst -t setupadm -i $PWD 


Procedure

  1. Optional: Change the user ID and password that WebSphere Application Server uses to authenticate to the administration server. If you need to change the user ID and password, use the htpasswd utility. For more information, see the documentation about enabling access to the administration server using the htpasswd utility.

  2. Use the IHS_HOME/bin/setupadm command to set up the administration server. We can set up the administration server to run in the following scenarios:

    • A non-root user and group, which the IBM HTTP Server Administration Server will run as when started by root

    • A non-root group

    • The path to the IBM HTTP Server configuration file

    • The path to the IBM HTTP Server administration server configuration file

    • The plug-in configuration file for WebSphere Application Server

    Command syntax
     setupadm [-silent] [-create] -usr user_name 
    -grp group_name -cfg IBM_HTTP_Server_configuration_file 
    [-plg plug-in_configuration_file] 
    -adm administration_server_configuration_file

    -silent
    This parameter enables the setupadm command to run without message text.
    -create
    This parameter specifies that you want to create a user and group. If you do not specify this parameter, the values for the -usr and -grp parameters must exist.
    -usr
    This parameter specifies the user ID that will run the administration server. This user ID value is updated in the <User> directive within the administration sever configuration file, which is called admin.conf.
    -grp
    This parameter specifies the group name that will run the administration server. When you specify a value, it is used to change the file permissions for the configuration files and the user or group authentication files. This group name value is updated in the <Group> directive within the administration server configuration file, which is called admin.conf.

    Ensure that you specify a unique group name for the administration server.

    -cfg
    This parameter defines the fully qualified path to the IBM HTTP Server web server configuration file. Within this file, the permission and group information is updated. Avoid trouble: The administration server requires both read and write access to IBM HTTP Server configuration files.
    -plg
    This parameter specifies the fully qualified path to the plugin-cfg.xml configuration file. Within this file, permissions are changed.
    -adm
    This parameter specifies the fully qualified path to the administration server configuration file. If you do not specify this parameter, a default administration configuration file is used that is based on the install_root/conf/admin.conf file.


Results

When you run the setupadm command, the following actions occur:

  • Creates a new user and group is created on the system if you specify the -create parameter

  • Changes the group owner of the configuration files to the group name that you specify and grants group write permissions to those files. This process allows the administration server to modify those configuration files.

  • Updates the administration server configuration file with the user name and group name.

  • Creates a backup file each time that you run the command.


What to do next

Complete the steps to start the IBM HTTP Server administration server. For more information, see the documentation about starting and stopping the IBM HTTP Server administration server.

The IBM HTTP Server administration server has to be started under the same user ID as the IBM HTTP Server to be able to restart it with apachectl restart.


Related tasks