How to Use the RIPE Atlas Toolkit¶

Options¶

Examples¶

Create a standard configuration file. Note that this typically isn’t necessary:

$ ripe-atlas configure --init

Invoke your editor of choice to manually fiddle with the configuration file:

$ ripe-atlas configure --editor

Set an arbitrary value within the configuration file. You can use dot-separated notation to dictation the value you wish to change:

$ ripe-atlas configure --set authorisation.create=YOUR_API_KEY

Options¶

Examples¶

Get a list of measurements:

$ ripe-atlas measurements

Filter that list by status=ongoing:

$ ripe-atlas measurements --status ongoing

Further filter it by getting measurements that conform to IPv6:

$ ripe-atlas measurements --status ongoing --af 6

Get that same list, but strip out everything but the measurement ids:

$ ripe-atlas measurements --status ongoing --af 6 --ids-only

Limit that list to 200 entries:

$ ripe-atlas measurements --status ongoing --af 6 --limit 200

Get that list, but show only the id, url and target fields:

$ ripe-atlas measurements –status ongoing –af 6

–field id –field url –field target

Filter for measurements of type dns that started after January 1, 2015:

$ ripe-atlas measurements --type dns --started-after 2015-01-01

Options¶

Examples¶

Get a list of probes within ASN 3333:

$ ripe-atlas probes --asn 3333

Further filter that list to show only probes in ASN 3333 from the Netherlands:

$ ripe-atlas probes --asn 3333 --country nl

Change the limit from the default of 25 to 200:

$ ripe-atlas probes --asn 3333 --limit 200

Aggregate the probes by country, and then by ASN:

$ ripe-atlas probes --asn 3333 --aggregate-by country --aggregate-by asn

Show the id, url, target, description, and whether the probe is public or not:

$ ripe-atlas probes --asn 3333 --field id --field url --field description \
  --field is_public

Options¶

Examples¶

Get the latest results of measurement 1001:

$ ripe-atlas report 1001

The same, but specifically request the ping renderer:

$ ripe-atlas report 1001 --renderer ping

Aggregate those results by country:

$ ripe-atlas report 1001 --aggregate-by country

Get results from the same measurement, but show all results from the first week of 2015:

$ ripe-atlas report 1001 --start-time 2015-01-01 --stop-time 2015-01-07

Get results from the first day of 2015 until right now:

$ ripe-atlas report 1001 --start-time 2015-01-01

Options¶

Examples¶

Stream the results from measurement #1001:

$ ripe-atlas stream 1001

Limit those results to 500:

$ ripe-atlas stream 1001 --limit 500

Specify a renderer:

$ ripe-atlas stream 1001 --renderer ping

Combine for fun and profit:

$ ripe-atlas stream 1001 --renderer ping --limit 500

Options¶

Examples¶

Pipe the contents of an arbitrary file file into the renderer. The rendering engine will be guessed from the first line of input:

$ cat /path/to/file/full/of/results | ripe-atlas render

The same, but point Magellan to a file deliberately rather than using a pipe:

$ ripe-atlas render --from-file /path/to/file/full/of/results

Specify a particular renderer:

$ cat /path/to/file/full/of/results | ripe-atlas render --renderer ping

Aggregate the output by country:

$ cat /path/to/file/full/of/results | ripe-atlas render --aggregate-by country

Options¶

All measurements share a base set of options.

Examples¶

The simplest of measurements. Create a ping with 50 probes to example.com:

$ ripe-atlas measure ping --target example.com

The same, but don’t actually create it, just show what would be done:

$ ripe-atlas measure ping --target example.com --dry-run

Be more specific about which address family you want to target:

$ ripe-atlas measure ping --target example.com --af 6

Ask for 20 probes from Canada:

$ ripe-atlas measure ping --target example.com --probes 20 --from-country ca

Or ask for 20 Canadian probes that definitely support IPv6:

$ ripe-atlas measure ping --target example.com --probes 20 \
  --from-country ca --include-tag system-ipv6-works

Rather than creating a one-off create a recurring measurement:

$ ripe-atlas measure ping --target example.com --interval 3600

Moving onto DNS measurements, do a lookup for example.com. Since we’re not specifying --target here, this implies that we want to use the probe’s resolver:

$ ripe-atlas measure dns --query-argument example.com

Getting a little more complicated, let’s set a few special bits and make a more complex query:

$ ripe-atlas measure dns --query-type AAAA --query-argument example.com \
  --set-nsid-bit --set-rd-bit --set-do-bit --set-cd-bit

Shortcuts¶

If you’re creating a lot of measurements in a short time, typing out ripe-atlas measure traceroute a whole bunch of times can be tiresome, so we’ve added a few shortcut scripts for you:

So for example, these two commands are the same:

$ ripe-atlas measure ping --target example.com
$ aping --target example.com

If you want to streamline your typing process even more than this, we recommend the use of your shell’s alias feature, which is both powerful and customisable for your needs.