Agent inventory logging

To log details about your PingAccess agents, you can add custom configuration to the agents and to the PingAccess system.

Agent information isn’t included in agent responses by default, except for the agent’s name. To include additional information in the logs, customize your PingAccess agents to include the agent header.

You must edit the /conf/log4j2.xml file to log the information included in the agent header. For more information, see Security audit logging.

For information about agent headers, see PAAP agent request.

Agent Header

The optional header vnd-pi-agent allows the agent to communicate information about itself and its deployment environment to PingAccess.

The value of this header is a map of comma-separated key-value pairs. An agent can either use the custom keys that are specific to its deployment, or use one or more of the following well-known keys:

Well-known keys

v: The version of the agent making the request.
t: The type of agent and/or the type of platform where the agent resides.
h: The hostname of the server where the agent resides.

The syntax for the vnd-pi-agent value conforms to a dictionary in this specification, https://datatracker.ietf.org/doc/rfc8941/, where member-values are constrained to be an sh-string item.

The following header examples are all considered semantically equivalent:

Example

vnd-pi-agent: v="1.0.0", h="apache.example.com", t="Apache 2.4.41"

Example

vnd-pi-agent: v="1.0.0", h="apache.example.com"
vnd-pi-agent: t="Apache 2.4.41"

Example

vnd-pi-agent: v="1.0.0"
vnd-pi-agent: h="apache.example.com"
vnd-pi-agent: t="Apache 2.4.41"