Configure a network proxy

Some network architectures may need a network proxy between the AVEVA adapter and the egress endpoint. The process for configuring the adapter to egress data through a network proxy varies depending on the proxy type.

HTTPS forward proxy

For the adapter to use an HTTPS forward proxy while egressing, configure the https_proxy environment variable. For information on how to configure system environment variables, refer to your platform specific documentation:

• Windows: setx (https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/setx)

• Ubuntu: EnvironmentVariables (https://help.ubuntu.com/community/EnvironmentVariables)

• Debian: EnvironmentVariables (https://help.ubuntu.com/community/EnvironmentVariables)

• Docker: Environment variables in Compose (https://docs.docker.com/compose/environment-variables/)

The value of this environment variable must contain the URL of the proxy server, beginning with https. The format of the string is [user[:password]@]https://hostname[:port].

HTTPS proxy environment variable

Note: Usage of the https_proxy environment variable may affect other .NET or .NET Core applications. If you set this environment variable, it will affect the adapter egress endpoints and the adapter health endpoints.

Examples:

myUser@http://192.168.2.2

myUser:myPassword@http://proxymachine.domain:3128

http://proxymachine.domain

In Windows, this may look something like:

Example of an architecture with an https forward proxy:

Reverse proxy

For the adapter to use a reverse proxy while egressing, you must configure the reverse proxy as an egress endpoint. For information on how to configure an egress endpoint, see Prepare egress endpoints.

Example:

[{

"id": "PI Web API Through Proxy",

"endpoint": "https://<reverseProxy>:<port>/piwebapi/omf/",

"username": "<piWebApiUser>",

"password": "<piWebApiPassword>"

}]

Example of an architecture with a reverse proxy:

No proxy

For the adapter to exclude a specific endpoint from using the proxy (i.e., do not use the proxy in `https_proxy` or `http_proxy`), then configure the `no_proxy` environment variable. `no_proxy` can contain a comma-separated list of hostnames.

Note: Usage of the no_proxy environment variable may affect other .NET or .NET Core applications.

Example:

192.168.2.1

example.com

somehostname

In Windows, this may look something like: