ThousandEyes Documentation
Search…
What's New
Product Documentation
Obtaining a list of ThousandEyes Agent IP Addresses with te-iplist
You may need the IP addresses of ThousandEyes agents in order to construct firewall rules or similar filters. ThousandEyes does not publish a list of IP addresses, but customers can use the ThousandEyes application program interface (API) to obtain the IP addresses of both Cloud Agents assigned to your organization and Enterprise Agents assigned to your account group. You can query the API with a web browser, a custom script, or a RESTful API tool to obtain the latest list of IP addresses, or you can use our command-line tool: te-iplist.
Note that for Cloud Agents, the IP address assignment is relatively constant, but subject to change without notice. For more information, see Obtaining a List of ThousandEyes Agent IP Addresses.
te-iplist
te-iplist is a command-line interface (CLI) utility that queries the ThousandEyes API for the agents available for your account and outputs agents' IPs in different forms (IP list, subnet list, IP range list, IP block list) and formats (plain text, CSV, JSON, XML).
Download
On Linux and macOS, ensure that the utility is executable before you use it:
1
chmod +x te-iplist
Copied!
On macOS Catalina, disable the developer verification warning for this utility:
1
xattr -d com.apple.quarantine te-iplist
Copied!
Usage
See the te-iplist documentation for all available parameters or issue the command with the
-h switch:1
./te-iplist -h
Copied!
User and API Token
In the te-iplist commands illustrated in the sections below, the authentication fields need to be filled in this way:
<user> - the user's email address
<user-api-token> - the basic authentication token for the APIThese values can be retrieved from the ThousandEyes application at Account Settings > Users and Roles > Profile tab.
Usage Examples
Display a list of all Cloud and Enterprise Agent IP addresses (
-o ip):1
$ ./te-iplist -u <user> -t <user-api-token> -o ip
2
5.45.179.194
3
5.45.179.195
4
5.45.179.196
5
5.148.182.136
6
5.148.182.137
7
...
8
2400:8900::f03c:91ff:fec8:c7b2
9
2400:8900::f03c:91ff:fec8:c7d3
10
2400:8900::f03c:91ff:fedf:65c4
11
2403:7000:8000:400::20
12
2600:3c03::f03c:91ff:feae:cd41
13
...
Copied!
Display a minimal list of subnets (
-o subnet-loose) that cover Enterprise Agent IP addresses (-e). The list should include agent names as comments (-n):1
$ ./te-iplist -u <user> -t <user-api-token> -o subnet-loose -e -n
2
10.0.0.3 # kubernetes te-agent-pod
3
10.0.1.0/26 # ip-10-0-1-48.localdomain; csc-internal; office-12
4
1.2.3.4 # kubernetes te-agent-pod; ip-10-0-1-48.localdomain; csc-internal; office-12
Copied!
Display a list of IP blocks (
-o block-strict) of Cloud Agents' (-c) IPv6 (-6) addresses:1
$ ./te-iplist -u <user> -t <user-api-token> -o block-strict -c -6
2
2400:8900::f03c:91ff:fec8:c7b2
3
2400:8900::f03c:91ff:fedf:65c4
4
2403:7000:8000:400::[18-20]
5
...
Copied!
Display a list of IP ranges (
-o range-strict) of Enterprise Agents' private (-e-private) IPv4 (-4) addresses:1
$ ./te-iplist -u <user> -t <user-api-token> -o range-strict -e-private -4 -n
2
10.10.10.202 - 10.10.10.203 # primoz-centos-te; centos6
3
192.168.0.2 - 192.168.0.4 # thousandeyes-va-14244; thousandeyes-va-14403; thousandeyes-va66
Copied!
Create a comma-separated values (CSV) file that includes all agents and all output formats:
1
$ ./te-iplist -u <user> -t <user-api-token> -o csv > all-agents.csv
Copied!
You can open the CSV file as a spreadsheet in your favorite spreadsheet editor, such as LibreOffice Calc, Numbers, or Google Sheets. Unfortunately, Microsoft Excel does not support CSV files with newlines inside cells, and will not import the generated CSV.
Loose Versus Strict
IP subnets, IP ranges and IP blocks can be displayed in loose or strict notation. Strict notation covers only the IP addresses that are used by the agents. Loose notation covers all IP addresses that are used by the agents, but may also cover some of the addresses that are not used by the agents. Loose notation typically covers all the agent IP addresses with fewer entries. For example, IP addresses:
1
10.0.0.2
2
10.0.0.3
3
10.0.0.5
Copied!
can be covered by multiple strict subnet notations:
1
10.0.0.2/31
2
10.0.0.5
Copied!
or by a single loose subnet notation:
1
10.0.0.0/29
Copied!
You should select the notation that is acceptable by your security standards.
Account Groups
Users assigned to multiple account groups can list the agents available in a specific account group with the
-a <accountGroupId> argument. You can list available account group IDs with the following:1
te-iplist -u <user> -t <user-api-token> -account-groups
Copied!
If you don't specify
-a, te-iplist uses the user's login account group. For users in multiple organizations, te-iplist assumes only one login account group; to specify multiple account groups, use the -a argument to list them.