Creating a user agent

A user agent is a client that initiates a request for a local service to establish a connection to a remote server.

About this task

An XML manager uses a user agent, for example, to retrieve resources from elsewhere on the network. The settings for a user agent can affect messages that a DataPower® service sends out.

Tip: The equivalent entry point in the CLI is the global user-agent command.
Each application domain has the default user agent. By default, the configuration of this user agent is as follows.
  • Allow a maximum of eight HTTP redirect messages before the target is declared as unreachable.
  • Set the idle timeout to 300 seconds before the connection times out and is closed.

Each policy type uses URL matching patterns. When a policy defines multiple entries, the policy evaluates each candidate URL against the matching pattern in sequential order. The policy applied to the candidate URL is the first matching pattern. Therefore, order is important.

Procedure

  1. In the search field, enter user.
  2. From the search results, click User agent.
  3. Click Add.
  4. Define the basic properties - Name, administrative state, and comments.
  5. Optional: In the HTTP request-header field, specify the value the user agent transmits as the HTTP request-header field.
  6. Optional: In the Maximum redirects field, specify the maximum number of HTTP redirect messages to allow before the target is declared as unreachable.
  7. Optional: In the Timeout field, specify the idle timeout to allow before the connection times out and is closed.
  8. Click the Proxy policy tab to define HTTP proxy policies.
  9. Click the TLS profile policy tab to define secure connection policies for HTTP proxy servers.
  10. Click the Basic authentication policy tab to define basic authentication policies.
  11. Click the SOAPAction policy tab to define SOAP action policies.
  12. Click the Public key authentication policy tab to define public key authentication policies.
  13. Click the Allow compression policy tab to define policies that disable compression.
  14. Click the Header retention policy tab to define header retention policies.
  15. Click the Restrict to HTTP/1.0 policy (deprecated) tab to define HTTP/1.0 restriction policies.
  16. Click the HTTP version policy tab to define HTTP policies.
  17. Click the Header injection policy tab to define header injection policies.
  18. Click the Chunked upload policy tab to define policies that disable HTTP/1.1 chunked content encoding.
  19. Click the FTP client policy tab to define FTP client policies.
  20. Click the SMTP client policy tab to define SMTP client policies. These policies require the B2B feature.
  21. Click the SFTP client policy tab to define SFTP client policies.
  22. Click Apply to save changes to the running configuration.
  23. Click Save to save changes to the persisted configuration.