Previous Topic: Configuring EPAgent Plug-insNext Topic: Change the Value of the EnableWebAgent Parameter


Configuring the EPAgent for Network Data Sources

You can configure the EPAgent to accept data from network sources.

Modify the server.conf File

After the Introscope owner configures the EPAgent, the next step is modifying the server.conf file of the server on which the Agent for SharePoint runs.

Follow these steps:

  1. Log in to the server hosting your Agent for SharePoint.
  2. Open the following file with a text editor:
    Agent-for-SharePoint_Home/proxy-engine/conf/server.conf
    
    Agent-for-SharePoint_Home

    Indicates the directory where the CA SiteMinder Agent for SharePoint is installed.

    Default: (Windows) [32-bit] C:\Program Files\CA\Agent-for-SharePoint

    Default: (Windows) [64-bit] C:\CA\Agent-for-SharePoint
    Default: (UNIX/Linux) /opt/CA/Agent-for-SharePoint

  3. Locate the following section:
    <metric-reporter name="WilyMetricReporter">
    
  4. Change the value on the enabled line (in the previous section) to "yes", as shown in the following example:
    enabled="yes"
    
  5. Save the file and close the text editor.

    The server.conf file is modified. Continue with the next steps of having your policy administrator open the Administrative UI and update your Agent Configuration object (ACO).

Open the Administrative UI to Change Policy Server Objects

Change the objects on your Policy Server by opening the Administrative UI.

Follow these steps:

  1. Open the following URL in a browser.
    https://host_name:8443/iam/siteminder/adminui
    
    host_name

    Specifies the fully qualified Administrative UI host system name.

  2. Enter your CA SiteMinder superuser name in the User Name field.
  3. Enter the CA SiteMinder superuser account password in the Password field.

    Note: If your superuser account password contains one or more dollar‑sign ($) characters, replace each instance of the dollar-sign character with $DOLLAR$ in the Password field. For example, if the CA SiteMinder superuser account password is $password, enter $DOLLAR$password in the Password field.

  4. Verify that the proper server name or IP address appears in the Server drop-down list.
  5. Select Log In.

Update Your Agent Configuration Object (ACO)

The next step in monitoring data with CA Introscope® involves updating a configuration parameter in your Agent Configuration Object (ACO).

Follow these steps:

  1. Click Infrastructure, Agent, Agent Configuration Objects.
  2. Click the edit icon in the line Agent Configuration Object you want.
  3. Locate the following parameter:
    EnableIntroscopeApiSupport

    Collects information about the agent and sends it to CA Introscope® using a plug-in. This parameter uses the following settings:

    • When set to yes, the plug-in calls an API to collect the data.
    • When set to no, the plug-in creates an HTTP header with the data.
    • When set to both, the plug-in calls the API to collect the data and creates an HTTP header with the data.
    • When set to none, data not collected.

    Default: No.

    Limits: Yes, Both, No, None.

    Example: (HTTP header) sm-wa-perf-counters = server_name.example.com:6180,86117203,86118343,1,0,0,1,0,0,1,0,0,0,0,0,1,0,0,0,0,0,0,0,1125,0,15,1,1,750,750,

  4. Click the edit icon next to the previous parameter, and then add the settings that you want.
  5. (Optional) To disable automatic monitoring of the agent instance metrics that are configured with the Agent for SharePoint, change the value of the following parameter to no:
    EnableMonitoring

    Specifies whether the agent sends monitoring information to the Policy Server.

    Default: Yes.

  6. Click OK.
  7. Click Submit.

    Your Agent Configuration object is updated. Continue with the next step of having your Introscope administrator start the EPAgent.

Start Your EPAgent on Windows Operating Environments

You can run the EPAgent as either a standalone .jar file, or a Java application.

To run the EPAgent as a standalone .jar file

To run the EPAgent as a Java application

Start Your EPAgent on UNIX Operating Environments

You can use a control script (shell script) to run the Introscope EPAgent on a UNIX operating system.

Follow these steps:

  1. Open a command prompt.
  2. Navigate to the directory that has the control script. For example:
    cd Introscope<version_number>/bin
    
  3. Run the command that corresponds to the action you want:
    EPACtrl.sh start

    Starts the EPAgent.

    EPACtrl.sh status

    Shows the status of EPAgent process whether it is running or stopped.

    EPACtrl.sh stop

    Stops the EPAgent process

    EPACtrl.sh help

    Displays the help menu.

Restart the Agent for SharePoint

Starting or stopping the Agent for SharePoint involves the following separate procedures:

  1. Changing the value of EnableWebAgent in the WebAgent.conf file.
  2. Changing the state of the related services on the computer running the Agent for SharePoint.