Use the proxy server settings to set up a HTTPS proxy server that allows endpoints on your network to access the Endpoint Security (HX) server or Internet.
Setting Key | Default | Supported Edit Methods | ||
|---|---|---|---|---|
Web UI | CLI | API | ||
| Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
| Yes | Yes | Yes | |
| Yes | Yes | Yes | |
| Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
failed_retry_delay | Yes | Yes | Yes | |
The proxy server settings must be enclosed in braces and listed within quotation marks ("). See the example below.
{
"proxy": {
"type": "manual",
"host": "proxy.fireeye.com",
"port": 80,
"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],
"exclude_local_hosts": true,
"username": "<proxy-user>",
"password": "<proxy-user-password>"
}
proxy type Key
The proxy type key controls the type of proxy server your endpoint uses. Options include none, system, and manual. The default value is none.
The table below defines each proxy type.
Type Value | Description |
|---|---|
| No proxy server. Proxy switch is disabled. |
| Configure your local system as a proxy server. See Configuring a Proxy Server Policy for the Default Policy. Host containment works only at the IP protocol layer. If your host endpointsuse a proxy server that has been added to the containment whitelist, a contained host will still be able to send and receive Web traffic and other traffic. If you are using an agent proxy and you want to be able to contain compromised hosts, you must set up the proxy server with a separate IP address that can only be used to reach the Endpoint Security (HX) server. Use the Endpoint Security (HX) xAgent Web UI to add the proxy server IP address to the Allowed IP Addresses on the Containment Settings page. See the Endpoint Security User Guide for more information. |
| Manually configure a remote system as your proxy server. See Configuring a Proxy Server Policy for the Default Policy. NoteWhen the proxy |
Change this setting using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, the proxy
typekey should be listed within quotation marks ("). Enclose the full list of proxy server settings in bracket ({}). For example, you can set the host value to"type": "manual",.{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],"exclude_local_hosts": true,"username": "<proxy-user>","password": "<proxy-user-password>"}
proxy host Key
The proxy host key defines the hostname for your HTTPS proxy server. There is no default host.
Important
If the proxy type is set to manual, you are required to set the proxy host key or your proxy server connection will fail.
If you define the proxy host, you must also define the following:
proxy host Key
Change this setting using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, the proxy
hostkey should be listed within quotation marks ("). Enclose the full list of proxy server settings in bracket ({}). For example, you can set the host value to"host": "proxy.fireeye.com",.{"proxy": {"type": "manual","host": "proxy.fireeye.com",}
proxy port Key
The proxy port key defines your HTTPS proxy server TCP port number. The default port number is 80.
If you define the proxy port key, you must also define the following:
proxy port Key
Change this setting using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, enclose the full list of proxy server settings in braces ({}). For example, you can set the
portvalue to"port": 80,.{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,}
proxy exclude_hosts Key
The proxy exclude_hosts key defines a list of hosts that should be excluded from proxy support. There is no default.
If you define an exclude_hosts list for your proxy server, you must also define the following:
proxy exclude_hosts Key
Change the exclude_hosts key using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, The proxy
exclude_hostssetting should be listed within quotation marks ("). Enclose the full list of proxy server settings in braces ({}). For example, you can add"exclude_hosts": "eng.fireeye.com", "host.fireeye.com"to theexclude_hostslist.{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],}
exclude_local_hosts Key
The proxy exclude_local_hosts key indicates whether or not Trellix Endpoint Security (HX) xAgents should use the HTTPS proxy server when contacting host machines with local or simple hostnames. Valid values include true (enabled) and false (disabled). The default value is false.
When you enable the exclude_local_hosts key, your HTTPS proxy server is not used to contact hosts with local or simple hostnames. When you disable the exclude_local_hosts key, your HTTPS proxy server is used to contact hosts with local or simple hostnames.
If you disable the exclude_local_hosts key, you must also define the following:
exclude_local_hosts Key
Change this key using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, the proxy
passwordsetting should be listed within quotation marks ("). Enclose the full list of proxy server settings in braces ({}).{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],"exclude_local_hosts": true,}
proxy username Key
The proxy username key allows you to authenticate access to your HTTPS proxy server. There is no default value.
Note
If you do not set a proxy username and password, proxy authentication is ignored.
If you define a username for your proxy server, you must also define the following:
Change this setting using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, the proxy
usernamesetting should be listed within quotation marks ("). Enclose the full list of proxy server settings in braces ({}).{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],"exclude_local_hosts": true,"username": "<proxy-user>","password": "<proxy-user-password>"}
proxy password Key
The proxy password allows you to authenticate access to the proxy server. There is no default value.
Note
If you do not set a proxy username and password, proxy authentication is ignored.
If you define a password for your proxy server, you must also define the following:
Change this setting using one of the following methods:
Web UI (See Configuring an HTTPS Proxy Server Using the Web UI).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints by changing the agent configuration file (see Modifying the Configuration File for a Single Endpoint).
For manual changes, the proxy
passwordsetting should be listed within quotation marks ("). Enclose the full list of proxy server settings in braces ({}).{"proxy": {"type": "manual","host": "proxy.fireeye.com","port": 80,"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],"exclude_local_hosts": true,"username": "<proxy-user>","password": "<proxy-user-password>"}
proxy failed_relay_delay Key
The proxy failed_relay_delay setting defines how long the agent will wait (in seconds) before attempting to reconnect with the proxy server if the initial proxy server connection fails. The default value is 1200 seconds.
If you define a failed_relay_delay interval for your proxy server, you must also define the following:
The proxy failed_relay_delay setting should be listed within quotation marks ("). Enclose the full list of proxy server settings in braces ({}). For example, you can add "exclude_hosts": "eng.fireeye.com", "host.fireeye.com"to the exclude_hosts list.
{
"proxy": {
"type": "manual",
"host": "<hostname>",
"port": 80,
"exclude_hosts": ["eng.fireeye.com", "host.fireeye.com"],
"failed_relay_delay": 1200
}
Change this setting using one of the following methods:
Web UI (see Enabling and Disabling the Agent Logging Policy).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).