Session environment variables

The following environment variables are present in client- and server-initiated sessions. Unless indicated otherwise, each predefined variable is supported by all SecureTransport protocol servers (AS2D, FTPD, HTTPD, PESITD, and SSHD).

The following topics describe the session environment variables:

Related topics:

Generic session variables

These variables are present in all types of sessions whether client- or server-initiated.

Variable Name Description
DXAGENT_CLIENT

The type of client connecting to the Transaction Manager to trigger this agent. The value of this variable is set to as2d, ftpd, httpd, pesit, or sshd.

For server sessions, the variable is set to server.

DXAGENT_SESSIONID The ID of the session. This variable is set to a unique value that is constant for all agent calls within the session. For more information, see Sessions.

Client session variables

Variables applicable to client-initiated sessions.

Variable Name Description
DXAGENT_AUTHCOOKIE Cookie output by auth agent. The variable that is set by the auth event.
DXAGENT_CERTCOOKIE Cookie output by cert agent. The variable that is set by the cert event.
DXAGENT_CHANNELID The channel ID for the current SSH event. This variable is only supported in SSH.
DXAGENT_CLIENTADDR Contains the hostname or IP Address of the Edge in use.
DXAGENT_CLIENTPID The process ID (PID) of the SecureTransport process calling the agent. This is inserted in the agentlog to help associate an Transaction Manager connection with a specific calling process. This variable is not available for AS2, SSH, or server sessions.
DXAGENT_COOKIE A persistent cookie that can be set in response to the cert, auth, or login events. The last cookie that is set as the result of one of these three events. If no cookie is supplied, the value of this variable is null. For best results, use DXAGENT_SESSIONID as a session identifier instead of DXAGENT_COOKIE.
DXAGENT_EDGEID

Contains the ID of the current SecureTransport Edge server. The variable is only set by protocol servers HTTP(S), FTP(S), SSH and AS2.

The identification string is set in the SecureTransport Edge EdgeId server configuration variable and is stored in ConfigurationOption database table. The DXAGENT_EDGEID variable is set during creation or setup of AgentSession for each FTP IO command object. It is reused by all other protocols for transfers. DXAGENT_EDGEID is set to each event object initialized from an AgentSession.

DXAGENT_LDAP_DN LDAP Domain Name (DN) if this is an LDAP session.
DXAGENT_LOGINNAME Login name of the user.
DXAGENT_PWD The current working directory.
DXAGENT_PWD_RESOLVED
Current resolved working directory.
DXAGENT_USERCLASS The user class of the user calling the agent.
DXAGENT_USERCOOKIE The variable that is set by the user event.
DXAGENT_USERGID The GID of the user.
DXAGENT_USERLOGINTYPE The type of the user login for the user calling the agent. Possible values are Real, Virtual, LDAP, and SiteMinder.
DXAGENT_USERTYPE The user type – real or virtual.
DXAGENT_USERUID The UID of the user.

Client and account session variables

Variables applicable to client- and server-initiated sessions created for an account.

Variable Name Description
DXAGENT_HOMEDIR

The user or account home directory.

In the case of virtual users, this is the directory SecureTransport performs a virtual chroot into, and always appears as / to the virtual user.

DXAGENT_ROOTDIR

The filesystem root in effect for a user.

For real and virtual users, this is always /.

DXAGENT_USERGID The GID of the user calling the agent. This variable is used by the Transaction Manager server.
DXAGENT_USERUID The UID of the user calling the agent. This variable is used by the Transaction Manager server.

Connection variables

These environment variables describe connection to or from a remote server. They are present in user sessions and for server-initiated transfers.

Variable Name Description
DXAGENT_PROTOCOL Protocol used to communicate with a remote machine either as a client or a server.
DXAGENT_REMOTEADDR

The IP address of the host from which the client is connecting to SecureTransport.

In a proxy environment, this can be the address of the proxy server host.

DXAGENT_REMOTEHOST

The DNS name of the host from which the client is connecting to SecureTransport.

In a proxy environment, this can be the name of the proxy server host.

DXAGENT_SECURE_COMMAND Contains a flag indicating whether the connection to a remote server is secure.
DXAGENT_SECURE_DATA Contains a flag indicating whether the data channel is secured.

Related Links