Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Sun Java System Web Server 7.0

Installing the Web Server 7.0 Agent Using the agentadmin Program

Procedure To Install the Web Server 7.0 Agent Using the agentadmin Program

  1. Login into the server where you want to install the agent.

    Important: To install the agent, you must have write permission to the files and directories for the Web Server 7.0 instance.

  2. Stop the Web Server 7.0 instance.

  3. Change to the following directory:

    PolicyAgent-base/bin

  4. Start the agent installation. For example:

    # ./agentadmin --custom-install

    On Windows systems, run the agentadmin.bat program.

  5. Enter information as requested by the agentadmin program, or accept the default values displayed by the program.

    After you have made your choices, the agentadmin program displays a summary of your responses. For example:

    -----------------------------------------------
    SUMMARY OF YOUR RESPONSES
    -----------------------------------------------
    Sun Java System Web Server Config Directory :
    /opt/SUNWwbsvr7/https-agenthost/config 
    OpenSSO server URL : http://openssohost.example.com:8080/opensso
    Agent URL : http://agenthost.example.com:8090
    Agent Profile name : WS7Agent
    Agent Profile Password file name : /tmp/ws7agentpw
    Agent Profile will be created right now by agent installer : true
    Agent Administrator : amadmin
    Agent Administrator's password file name : /tmp/amadminpw 
    
    Verify your settings above and decide from the choices below.
    1. Continue with Installation
    2. Back to the last interaction
    3. Start Over
    4. Exit
    Please make your selection [1]:
  6. Verify your choices and either continue with the installation (selection 1, the default) , or make any necessary changes.

    If you continue, the program installs the agent and displays a summary of the installation. For example:

    SUMMARY OF AGENT INSTALLATION
    -----------------------------
    Agent instance name: Agent_001
    Agent Bootstrap file location:
    /opt/web_agents/sjsws_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
    Agent Configuration Tag file location
    /opt/web_agents/sjsws_agent/Agent_001/config/OpenSSOAgentConfiguration.properties
    Agent Audit directory location:
    /opt/web_agents/sjsws_agent/Agent_001/logs/audit
    Agent Debug directory location:
    /opt/web_agents/sjsws_agent/Agent_001/logs/debug
    
    Install log file location:
    /opt/web_agents/sjsws_agent/installer-logs/audit/custom.log
    
    Thank you for using Sun OpenSSO Enterprise Policy Agent. INSTALL NOTE:
    Installer modifies obj.conf file in the config directory you specified. To
    make agent changes effective do Pull and deploy configuration using Web
    Server Admin Console or CLI. If there are multiple obj.conf files already
    present, then manually add agent settings to the required obj.conf files.
    UNINSTALL NOTE: Uninstall removes agent settings from obj.conf file in the
    config directory you specified. If there are multiple obj.conf files
    configured manually in the same config directory, then please remove them
    manually. For more information, please refer agent documentation.

    All files are under the PolicyAgent-base directory.

  7. After the installation finishes successfully, if you wish, check the installation log file in the following directory:

    PolicyAgent-base/logs/audit

  8. Restart the Web Server 7.0 instance that is being protected by the policy agent.


Example 1 Sample agentadmin --custom-install for the Web Server 7.0 Agent

************************************************************************
Welcome to the Sun OpenSSO Enterprise Policy Agent for Sun Java System
Web Server.
************************************************************************

Enter the complete path to the directory which is used by Sun Java System Web
Server to store its configuration Files. This directory uniquely
identifies the Sun Java System Web Server instance that is secured by this
Agent.
[ ? : Help, ! : Exit ]
Enter the Sun Java System Web Server Config Directory Path
[/var/opt/SUNWwbsvr7/https-agenthost.example.com/config]: 
/opt/SUNWwbsvr7/https-agenthost/config

Enter the URL where the OpenSSO server is running. Please include the
deployment URI also as shown below:
(http://opensso.sample.com:58080/opensso)
[ ? : Help, < : Back, ! : Exit ]
OpenSSO server URL: http://openssohost.example.com:8080/opensso

Enter the Agent URL as shown below: (http://agent1.sample.com:1234)
[ ? : Help, < : Back, ! : Exit ]
Agent URL: http://agenthost.example.com:8090
Enter the Agent profile name
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Profile name: WS7Agent

Enter the path to a file that contains the password to be used for identifying
the Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the path to the password file: /tmp/ws7agentpw
Enter true if the Agent Profile is being created into OpenSSO
by the installer. Enter false if it will be not be created by
installer.
[ ? : Help, < : Back, ! : Exit ]
This Agent Profile does not exist in OpenSSO server, will it be
created by the installer? (Agent Administrator's name and password are
required) [true]:

Agent Administrator is the Administrator user that can create, delete or
update agent profile.
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Administrator's name: amadmin

Enter the path to a file that contains the password of Agent Administrator
[ ? : Help, < : Back, ! : Exit ]
Enter the path to the password file that contains the password of Agent
Administrator: /tmp/amadminpw

-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
Sun Java System Web Server Config Directory :
/opt/SUNWwbsvr7/https-agenthost/config 
OpenSSO server URL : http://openssohost.example.com:8080/opensso
Agent URL : http://agenthost.example.com:8090
Agent Profile name : WS7Agent
Agent Profile Password file name : /tmp/ws7agentpw
Agent Profile will be created right now by agent installer : true
Agent Administrator : amadmin
Agent Administrator's password file name : /tmp/amadminpw 

Verify your settings above and decide from the choices below.
1. Continue with Installation
2. Back to the last interaction
3. Start Over
4. Exit
Please make your selection [1]:

Creating directory layout and configuring Agent file for Agent_001
instance ...DONE.

Reading data from file /tmp/ws7agentpw and encrypting it ...DONE.

Generating audit log file name ...DONE.

Creating tag swapped OpenSSOAgentBootstrap.properties file for instance
Agent_001 ...DONE.

Creating the Agent Profile WS7Agent ...DONE.

Creating a backup for file
/opt/SUNWwbsvr7/https-agenthost/config/obj.conf ...DONE.

Creating a backup for file
/opt/SUNWwbsvr7/https-agenthost/config/magnus.conf ...DONE.

Adding Agent parameters to
/opt/SUNWwbsvr7/https-agenthost/config/magnus.conf file ...DONE.

Adding Agent parameters to
/opt/SUNWwbsvr7/https-agenthost/config/obj.conf file ...DONE.

SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: Agent_001
Agent Bootstrap file location:
/opt/web_agents/sjsws_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
Agent Configuration Tag file location
/opt/web_agents/sjsws_agent/Agent_001/config/OpenSSOAgentConfiguration.properties
Agent Audit directory location:
/opt/web_agents/sjsws_agent/Agent_001/logs/audit
Agent Debug directory location:
/opt/web_agents/sjsws_agent/Agent_001/logs/debug

Install log file location:
/opt/web_agents/sjsws_agent/installer-logs/audit/custom.log

Thank you for using Sun OpenSSO Enterprise Policy Agent. INSTALL NOTE:
Installer modifies obj.conf file in the config directory you specified. To
make agent changes effective do Pull and deploy configuration using Web
Server Admin Console or CLI. If there are multiple obj.conf files already
present, then manually add agent settings to the required obj.conf files.
UNINSTALL NOTE: Uninstall removes agent settings from obj.conf file in the
config directory you specified. If there are multiple obj.conf files
configured manually in the same config directory, then please remove them
manually. For more information, please refer agent documentation.

After You Finish the Install

Agent Instance Directory: The installation program creates the following directory for each Web Server 7.0 agent instance:

PolicyAgent-base/Agent_nnn

where nnn identifies the agent instance as Agent_001, Agent_002, and so on for each additional agent instance.

Each agent instance directory contains the following subdirectories: