Skip to main content

IPv4 and IPv6 prefix list compressor

Project description

[![Build Status](https://travis-ci.org/job/aggregate6.svg?branch=master)](https://travis-ci.org/job/aggregate6)
[![Requirements Status](https://requires.io/github/job/aggregate6/requirements.svg?branch=master)](https://requires.io/github/job/aggregate6/requirements/?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/job/aggregate6/badge.svg?branch=master)](https://coveralls.io/github/job/aggregate6?branch=master)

aggregate6
==========

aggregate6 will compress an unsorted list of IP prefixes (both IPv4 and IPv6).

DESCRIPTION
-----------

Takes a list of IPv6 prefixes in conventional format on stdin, and performs two
optimisations to attempt to reduce the length of the prefix list. The first
optimisation is to remove any supplied prefixes which are superfluous because
they are already included in another supplied prefix. For example,
`2001:67c:208c:10::/64` would be removed if `2001:67c:208c::/48` was
also supplied.

The second optimisation identifies adjacent prefixes that can be combined under
a single, shorter-length prefix. For example, `2001:67c:208c::/48` and
`2001:67c:208d::/48` can be combined into the single prefix
`2001:67c:208c::/47`.

INSTALLATION
------------

```
$ pip install aggregate6
```

CLI USAGE
---------

Either provide the list of IPv4 and IPv prefixes on STDIN, or give filenames
containing lists of IPv6 prefixes as arguments.

```
$ # via STDIN
$ cat file_with_list_of_prefixes | aggregate6
... output ...

$ # with a filename as argument
$ aggregate6 file_with_list_of_prefixes [ ... optional_other_prefix_lists ]
... output ...

$ # Whitespace separated works too
$ echo 2001:67c:208c::/48 2000::/3 | aggregate6
2000::/3

$ # You can combine IPv4 and IPv6
$ echo 10.0.0.0/16 10.0.0.0/24 2000::/3 | aggregate6
10.0.0.0/16
2000::/3

$ # Or display only a specific AFI
$ echo 10.0.0.0/16 10.0.0.0/24 2000::/3 | aggregate6 -4
10.0.0.0/16
```

LIBRARY USAGE
-------------

```
>>> import from aggregate6 import aggregate
>>> aggregate(["10.0.0.0/8", "10.0.0.0/24"])
['10.0.0.0/8']
>>>
```

See `aggregate6 -h` for a full list of options.

BUGS
----

Please report bugs at: https://github.com/job/aggregate6/issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aggregate6-1.0.6.tar.gz (5.4 kB view details)

Uploaded Source

File details

Details for the file aggregate6-1.0.6.tar.gz.

File metadata

  • Download URL: aggregate6-1.0.6.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aggregate6-1.0.6.tar.gz
Algorithm Hash digest
SHA256 2a741781b678dfe961afbd85b3dc39279e492c9b6b2c3259955bad7160c1bf68
MD5 483a94ad3a4cba4c5eeda5cc2f1db3de
BLAKE2b-256 24dac5c7ad7650fd0e6058b8de833ae4baa0b1e794f7ca469064dcf6802575b5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page