What's New
Product Documentation

Docker Agent Configuration Options

You can configure the Enterprise Agent by setting environment variables, such as run-opts 1, on your Cisco Catalyst switch as follows:

Device(config)# app-hosting appid thousandeyes_enterprise_agent
Device(config-app-hosting)# app-resource docker
Device(config-app-hosting-docker)# prepend-pkg-opts
Device(config-app-hosting-docker)# run-opts 1 "-e TEAGENT_ACCOUNT_TOKEN"
Device(config-app-hosting-docker)# run-opts 2 "--hostname DESIRED_AGENT_HOSTNAME"
Device(config-app-hosting-docker)# run-opts 3 "-e TEAGENT_PROXY_TYPE=STATIC
Device(config-app-hosting-docker)# run-opts 4 "-e TEAGENT_PROXY_LOCATION=proxy.something.other:80"
Device(config-app-hosting-docker)# exit
Device(config-app-hosting)# exit
Device(config)# exit

This article lists the available configuration options for these run-opts variables.

  • APT_PROXY_LOCATION

    When PROXY_APT is set, the hostname or hostname:port to use for the apt proxy. Default: Not set.

  • APT_PROXY_PASS

    When PROXY_APT is set, the password to use for the apt proxy. Default: Not set.

  • APT_PROXY_USER

    When PROXY_APT is set, the username to use for the apt proxy. Default: Not set.

  • HOSTNAME

    The agent hostname you would like to assign. Default: the hostname of the switch.

  • PROXY_APT

    Specifies whether a proxy is necessary to reach apt repositories when PROXY_TYPE is PAC. Setting this to anything enables proxying for apt. Default: not set.

    Note: When PROXY_TYPE is STATIC, apt will be configured to use the proxy defined at TEAGENT_PROXY_LOCATION with the authentication defined by TEAGENT_PROXY_USER and TEAGENT_PROXY_PASS. Also note that apt supports basic proxy authentication only.

  • TEAGENT_ACCOUNT_TOKEN

    The account group token for registration. This option must be set.

  • TEAGENT_AUTO_UPDATES

    Specifies whether the agent will perform automatic self-updates of ThousandEyes packages. Valid values are 0 and 1. Default: 1.

    Note: This setting does not affect base OS-level packages; only ThousandEyes software.

  • TEAGENT_KERBEROS_RDNS

    Specifies whether reverse DNS lookups should be performed and checked for Kerberos hostnames. Valid values are 0 and 1. Default: 1.

  • TEAGENT_KERBEROS_WHITELIST

    Not needed for IOS XE 17.3.3.

  • TEAGENT_KDC_HOST

    When using KERBEROS proxy authentication, the hostname where the KDC can be reached. Default: Not set.

  • TEAGENT_KDC_PASS

    When using KERBEROS proxy authentication, the password to use for communication with the KDC. Default: Not set.

  • TEAGENT_KDC_PORT

    When using KERBEROS proxy authentication, the port to use for communication with the KDC. Default: 88

  • TEAGENT_KDC_REALM

    When using KERBEROS proxy authentication, the realm to use for communication with the KDC. Default: Not set.

  • TEAGENT_KDC_USER

    When using KERBEROS proxy authentication, the username to use for communication with the KDC. Default: Not set.

  • TEAGENT_PROXY_AUTH_TYPE

    The type of authentication to use when connecting to the configured proxy. Default: Not set.

    • Not set: Do not use authentication.

    • BASIC: Use HTTP BASIC authentication. TEAGENT_PROXY_USER and TEAGENT_PROXY_PASS must be set.

    • NTLM: Use HTTP NTLM authentication. TEAGENT_PROXY_USER and TEAGENT_PROXY_PASS must be set.

    • KERBEROS: Use Kerberos authentication. TEAGENT_KDC_USER, TEAGENT_KDC_PASS, TEAGENT_KDC_REALM, TEAGENT_KDC_HOST, and TEAGENT_KDC_PORT must be set.

  • TEAGENT_PROXY_BYPASS_LIST

    When using a STATIC proxy, a list representing the endpoints that should not require proxy use. Default: Not set.

    The list should be separated by semicolons and each entry should be one of the following:

    • A specific hostname or IP address. eg, foo.somedomain.com or 128.1.10.24. In the case of an IP address, the proxy will be bypassed only if the IP is present in the URL itself. This will not apply to an IP address used as a result of DNS resolution on a hostname.

    • A wildcard hostname starting with a *. eg, *.somedomain.com. A proxy will not be used for any request targeting subdomains of somedomain.com. Note that requests to somedomain.com itself will still use the proxy.

    • A network prefix. eg, 128.1.0.0/24. If the requested URL is for a literal IP address, bypass the proxy if the IP lies within this network prefix.

  • TEAGENT_PROXY_LOCATION

    Proxy location. Default: Not set.

    • For STATIC proxies, the hostname:port where the proxy is located (eg, proxy.thousandeyes.com:3128).

    • For PAC proxies, a URL where the PAC file can be downloaded (eg, https://somewhere.com/pac).

    • Should not be set if TEAGENT_PROXY_TYPE is DIRECT.

  • TEAGENT_PROXY_PASS

    The password for proxy authentication. Default: Not set.

  • TEAGENT_PROXY_TYPE

    The type of proxy to use for communication with the ThousandEyes platform. Default: DIRECT.

    • DIRECT: Do not use a proxy, go directly to the destination.

    • STATIC: Use a statically configured proxy location.

    • PAC: Use a PAC file to determine the proxy’s location

  • TEAGENT_PROXY_USER

    The username for proxy authentication. Default: Not set.