Configuring the DataPower agent

The Monitoring Agent for DataPower provides a central point of monitoring for the DataPower appliances in your enterprise environment. You can identify and receive notifications about common problems with the appliances. The agent also provides information about performance, resource, and workload for the appliances.

About this task

The DataPower agent is a multiple instance agent; you must create the first instance and start the agent manually. The Managed System Name includes the instance name that you specify, for example, instance_name:host_name:pc, where pc is your two character product code. The Managed System Name is limited to 32 characters. The instance name that you specify is limited to 28 characters, minus the length of your host name. For example, if you specify DataPower as your instance name, your managed system name is DataPower:hostname:BN. Important: If you specify a long instance name, the Managed System name is truncated and the agent code does not display correctly.

For each production DataPower appliance, configure one instance. If your DataPower appliances are non-production or small ones, you can configure only one agent instance to monitor them all. Multiple instances can run on the same machine. You can run the configuration script to create an instance and change any configuration settings. You can edit the agent silent response file before you run the script to bypass the prompts and responses that are required.

Procedure

To configure the DataPower agent, complete one of the following procedures:

To configure the agent by responding to prompts, complete the following steps:
1. Go to the install_dir/bin directory, where install_dir is the installation directory for the DataPower agent.
2. Run the ./datapower-agent.sh config instance_name command.
  
  Choose an instance_name that is unique on the server.
3. When prompted to edit the DataPower agent settings, enter 1 to proceed.
4. When prompted to edit the Managed System Details, enter one of the following options:
  - 1=Add
  - 2=Edit
  - 3=Del
  - 4=Next
  - 5=Exit
  If it is the first time that you configure a DataPower agent instance on your system, the No 'DataPower Appliances' settings available message is displayed. Enter 1 to add a DataPower appliance setting. The default is option 5=Exit.
5. Enter the properties for the DataPower appliance:
  
  Managed System Name
  For Managed System Name, enter the managed system name of the agent.
  
  Choose a Managed System Name that is unique among all instances of the agent and that can be used to easily identify an appliance. The name should contain only alphanumeric characters, for example, the host name of the DataPower appliance.
  
  Device Host
  For Device Host, enter the IP address of the monitored DataPower appliance.
  
  XML Management Interface Port
  For XML Management Interface Port, enter the port number for the XML Management Interface. The default number is 5550.
  
  User ID
  For User ID, enter the User ID to log in to the monitored DataPower appliance. The default value is admin.
  
  Password
  For Password, enter the password to log in to the monitored DataPower appliance and then confirm the password.
  
  SSL Proxy Profile
  For SSL Proxy Profile, enter the absolute path of the public certificate for your SSL proxy profile, if the XML management interface of the device is configured to use the profile. For example,
```
the location of the .pem file exported from datapower appliances/mycert.pem
```
  where the location of the .pem file exported from datapower appliances is the absolute path of the public certificate. To export the public certificate, see Exporting public certificate.
  
  SL Proxy Option
  For SSL Proxy Option, set to Yes if the XML management interface of the monitored device is configured to use a custom SSL proxy profile. Otherwise, set it to No.
6. To monitor multiple DataPower appliances, repeat 4 and 5 to configure one agent instance for each DataPower appliance. Otherwise, type 5 and press Enter to complete the configuration.
7. Run the following command to start the agent:
```
./datapower-agent.sh start instance_name
```
Silent configuration
1. To configure the agent by editing the silent response file and running the script with no interaction, complete the following steps:
  - Open install_dir/samples/datapower_silent_config.txt in a text editor.
  - Open install_dir/samples/datapower_silent_config.txt in a text editor.
2. To configure the DataPower agent to monitor an appliance, enter the following properties:
  
  Device Host
  Enter the host name or IP address of the device. For example, SOAP_HOST.ManageSystemName= datapower01.
  
  XML Management Interface Port
  Enter the port number for the XML Management Interface. The default value is 5550. For example, DP_PORT.ManageSystemName= 5550.
  
  User ID
  Enter the User ID that is used to connect to the device. The default value is admin. For example, DP_UID.ManageSystemName= admin.
  
  Password
  Enter the password of the User ID. For example, DP_PASSWORD.ManageSystemName= password.
  
  SSL Proxy Profile
  Enter the absolute path of the public certificate for your SSL proxy profile, if the XML management interface of the device is configured to use the profile. For example,
```
the location of the .pem file exported from datapower appliances/mycert.pem
```
  where the location of the .pem file exported from datapower appliances is the absolute path of the public certificate. To export the public certificate, see Exporting public certificate.
  
  SSL Proxy Option
  For SSL Proxy Option, set to Yes if the XML management interface of the monitored device is configured to use a custom SSL proxy profile. Otherwise, set it to No. For example, DP_SSL_OPTION.ManageSystemName1= Yes.
  
  Important: ManageSystemName is unique. You must replace it with your own system name in all entries. If you want to monitor multiple appliances, copy and repeat the steps that are shown to monitor an appliance. Remember to set the appropriate ManageSystemName and DataPower appliance parameters.
3. Go to the installation directory for the agent and run the following command to start the agent:
```
./datapower-agent.sh start instance_name
```

What to do next

To check the names and settings of the configured agent instances, run the ./cinfo -s bn command.
To display resource monitoring, configure the DataPower appliance accordingly. For instructions, see Resource monitoring of DataPower appliances.
You can verify that the DataPower agent data is displayed in the UI.