--- title: Agent field descriptions description: The following table describes the fields available for managing applications in the Agents window. component: pingaccess version: 9.0 page_id: pingaccess:pingaccess_user_interface_reference_guide:pa_agent_field_descriptions canonical_url: https://docs.pingidentity.com/pingaccess/9.0/pingaccess_user_interface_reference_guide/pa_agent_field_descriptions.html revdate: April 18, 2025 --- # Agent field descriptions The following table describes the fields available for managing applications in the **Agents** window. > **Collapse: Standard fields** > > | Field | Required | Description | > | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | **Name** | Yes | Enter a unique alphanumeric name for the agent, up to 64 characters. | > | **Description** | No | Enter a unique description to identify the agent's purpose. | > | **PingAccess Host** | Yes | In the **PingAccess Host** fields, enter the **Hostname** and **Port** of the PingAccess server where the agent should send requests. The PingAccess Hostname and Port might not be the actual host and port that policy server is listening to, depending on the network routing configuration and network elements, such as reverse proxies and load balancers. The PingAccess Host and Port are where the agent sends its requests. For example, if you have a cluster of engines behind a load balancer, the PingAccess Host and Port values might point to the load balancer rather than directly to an engine host. This configuration provides fault tolerance for the agent connectivity. | > | **Failover Host** | No | In the **Failover Host** fields, enter the **Hostname** and **Port** of the PingAccess server where the agent should send requests in the event of a failover from the **PingAccess Host**. Additional failover hosts can be added using the application programming interface (API). | > | **Agent Trusted Certificate** | Yes | Select a certificate to export in the `_agent.properties` file. The agent uses this certificate to communicate with the PingAccess engine using Secure Sockets Layer (SSL) *(tooltip: \
\

A protocol for authenticated and encrypted links between networked machines, typically over HTTPS. SSL was deprecated in 1999 in favor of Transport Layer Security (TLS).\

\
)*/TLS.PingAccess determines the certificates that are available to select in this list based on the certificates that have been imported into PingAccess. If the certificate you want to use isn't available, you must import it into the system. Learn more in [Importing certificates](pa_importing_certificates.html). You must specify the certificate authority (CA) root certificate if the agent listener presents a CA-signed certificate chain.The default value is `C=US, O=Ping Identity, CN=localhost (Generated: AGENT)`. | To configure advanced settings, click **Show Advanced**. > **Collapse: Advanced fields** > > | Field | Required | Description | > | -------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | **Override Request IP Source Configuration** | No | When enabled, the configuration you provide in the following fields overrides the default IP source settings (defined in **Settings > HTTP Requests > IP Source**) for this agent instance.![Screen capture of the Override Request IP Source Configuration field.](_images/override_request_ip_source_config.png)To configure the agent to use different Internet Protocol (IP) *(tooltip: \
\

The method by which data is sent across the internet from the source host to the destination host.\

\
)* source information:1) In the **Override Request IP Source Configuration** section, select **Yes**. > > 2) In the **Header Names** section, click **+ Add Header Name** and enter a header name which identifies the source IP address. > > To enter multiple header names, click **+ Add Header Name** for each header. > > 3) If you include more than one value in the **Header Names** section, in the **List Value Location** section, select whether the first or last value in the list is the source address. > > The default value is **Last**. > > 4) Select the **Fall Back to Last Hop IP** checkbox to use the last hop IP address as the source address if none of the configured header names are found. > > If you don't select this option and none of the listed header names are found, access is denied and a Forbidden result is returned. | > | **Override Unknown Resource Configuration** | No | When enabled, the configuration you provide in the following fields overrides the default unknown resource settings (defined in **Settings > Access > Unknown Resources**) for this agent instance.![Screen capture of the Override Unknown Resource Configuration field.](_images/override_unknown_resource_config.png)To configure the agent to handle unknown resource requests differently:1) In the **Override Unknown Resource Configuration** section, select **Yes**. > > 2) In the **Mode** field, select one of the following options to specify how requests for unknown resources should be handled: > > * Deny > > Agent requests for unknown resources generate an error response. > > * Passthrough > > Agent requests for unknown resources are allowed to pass through unfiltered. | > | **Require Token Authentication** | No | Select this checkbox to require the PingAccess agent to use bearer token authentication when making requests to the PingAccess engine nodes. By default, agents send both the shared secret and the bearer token if you select this checkbox. To prevent an agent from sending the shared secret, remove the agent.engine.configuration.shared.secret property from the agent.properties file you download.You can find more information about setting up bearer token authentication in [Configuring PingAccess agents to use bearer token authentication](pa_configuring_pa_agents_to_use_bearer_token_authn.html). The PingAccess agent for Apache (Windows) hasn't been updated to support bearer token authentication yet. Keep this checkbox cleared until compatibility is added for the type of agent you're using and you've updated all agents to the supported version. Learn more in Agent SDK for C 3.0 (April 2025). | > | **Max Retries** | Yes | Enter a number specifying how many times an agent should try contacting a PingAccess server before considering it unavailable.The default value is `2`. | > | **Failed Retry Timeout** | Yes | Enter a number, in seconds, specifying how long an agent should wait before trying to establish a connection to a failed PingAccess server again.The default value is `60`. |