aggregate6


Nameaggregate6 JSON
Version 1.0.12 PyPI version JSON
download
home_pagehttps://github.com/job/aggregate6
SummaryIPv4 and IPv6 prefix list compressor
upload_time2017-12-04 16:22:40
maintainer
docs_urlNone
authorJob Snijders
requires_python
licenseBSD 2-Clause
keywords ipv4 and ipv6 prefix routing networking
VCS
bugtrack_url
requirements py-radix
Travis-CI No Travis.
coveralls test coverage
            [![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`.

The above optimalisation steps are often useful in context of compressing firewall
rules or BGP prefix-list filters.

The following command line options are available:

```
	-4          Only output IPv4 prefixes
	-6          Only output IPv6 prefixes
	-h, --help  show help message and exit
	-m N        Sets the maximum prefix length for entries read, longer prefixes will be discarded prior to processing
	-t          truncate IP/mask to network/mask
	-v          Display verbose information about the optimisations
	-V          Display aggregate6 version
```

Installation
------------

OpenBSD 6.3:

`$ doas pkg_add aggregate6`

Other platforms:

`$ pip3 install aggregate6`

CLI Usage
---------

Either provide the list of IPv4 and IPv6 prefixes on STDIN, or give filenames
containing lists of IPv4 and 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
```

Library Usage
-------------

Aggregate6 can be used in your own pyp/python2/python3 project as python module.
Currently there is just one simple public function: `aggregate()` which takes a
list as parameter.

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

Bugs
----

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

Author
------

Job Snijders <job@instituut.net>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/job/aggregate6",
    "name": "aggregate6",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "ipv4 and ipv6 prefix routing networking",
    "author": "Job Snijders",
    "author_email": "job@instituut.net",
    "download_url": "https://files.pythonhosted.org/packages/07/d9/abe64b9ca4dd28f427d6b56e22edce3b4a65d05a45a78f748ca5f5af06c2/aggregate6-1.0.12.tar.gz",
    "platform": "",
    "description": "[![Build Status](https://travis-ci.org/job/aggregate6.svg?branch=master)](https://travis-ci.org/job/aggregate6)\n[![Requirements Status](https://requires.io/github/job/aggregate6/requirements.svg?branch=master)](https://requires.io/github/job/aggregate6/requirements/?branch=master)\n[![Coverage Status](https://coveralls.io/repos/github/job/aggregate6/badge.svg?branch=master)](https://coveralls.io/github/job/aggregate6?branch=master)\n\naggregate6\n==========\n\naggregate6 will compress an unsorted list of IP prefixes (both IPv4 and IPv6).\n\nDescription\n-----------\n\nTakes a list of IPv6 prefixes in conventional format on stdin, and performs two\noptimisations to attempt to reduce the length of the prefix list. The first\noptimisation is to remove any supplied prefixes which are superfluous because\nthey are already included in another supplied prefix. For example,\n`2001:67c:208c:10::/64` would be removed if `2001:67c:208c::/48` was\nalso supplied.\n\nThe second optimisation identifies adjacent prefixes that can be combined under\na single, shorter-length prefix. For example, `2001:67c:208c::/48` and\n`2001:67c:208d::/48` can be combined into the single prefix\n`2001:67c:208c::/47`.\n\nThe above optimalisation steps are often useful in context of compressing firewall\nrules or BGP prefix-list filters.\n\nThe following command line options are available:\n\n```\n\t-4          Only output IPv4 prefixes\n\t-6          Only output IPv6 prefixes\n\t-h, --help  show help message and exit\n\t-m N        Sets the maximum prefix length for entries read, longer prefixes will be discarded prior to processing\n\t-t          truncate IP/mask to network/mask\n\t-v          Display verbose information about the optimisations\n\t-V          Display aggregate6 version\n```\n\nInstallation\n------------\n\nOpenBSD 6.3:\n\n`$ doas pkg_add aggregate6`\n\nOther platforms:\n\n`$ pip3 install aggregate6`\n\nCLI Usage\n---------\n\nEither provide the list of IPv4 and IPv6 prefixes on STDIN, or give filenames\ncontaining lists of IPv4 and IPv6 prefixes as arguments.\n\n```\n$ # via STDIN\n$ cat file_with_list_of_prefixes | aggregate6\n   ... output ...\n\n$ # with a filename as argument\n$ aggregate6 file_with_list_of_prefixes [ ... optional_other_prefix_lists ]\n   ... output ...\n\n$ # Whitespace separated works too\n$ echo 2001:67c:208c::/48 2000::/3 | aggregate6\n2000::/3\n\n$ # You can combine IPv4 and IPv6\n$ echo 10.0.0.0/16 10.0.0.0/24 2000::/3 | aggregate6\n10.0.0.0/16\n2000::/3\n```\n\nLibrary Usage\n-------------\n\nAggregate6 can be used in your own pyp/python2/python3 project as python module.\nCurrently there is just one simple public function: `aggregate()` which takes a\nlist as parameter.\n\n```\n>>> import from aggregate6 import aggregate\n>>> aggregate([\"10.0.0.0/8\", \"10.0.0.0/24\"])\n['10.0.0.0/8']\n>>>\n```\n\nBugs\n----\n\nPlease report bugs at https://github.com/job/aggregate6/issues\n\nAuthor\n------\n\nJob Snijders <job@instituut.net>\n",
    "bugtrack_url": null,
    "license": "BSD 2-Clause",
    "summary": "IPv4 and IPv6 prefix list compressor",
    "version": "1.0.12",
    "split_keywords": [
        "ipv4",
        "and",
        "ipv6",
        "prefix",
        "routing",
        "networking"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9a3bda8fffa40425f6b7d4c8e16a86b4",
                "sha256": "be0d78b8e84f96db2fc67d17955d16f60cbd76adfebd9a62fe1dc7cad9b273d9"
            },
            "downloads": -1,
            "filename": "aggregate6-1.0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "9a3bda8fffa40425f6b7d4c8e16a86b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6026,
            "upload_time": "2017-12-04T16:22:40",
            "upload_time_iso_8601": "2017-12-04T16:22:40.069453Z",
            "url": "https://files.pythonhosted.org/packages/07/d9/abe64b9ca4dd28f427d6b56e22edce3b4a65d05a45a78f748ca5f5af06c2/aggregate6-1.0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2017-12-04 16:22:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "job",
    "github_project": "aggregate6",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "py-radix",
            "specs": [
                [
                    "==",
                    "0.10.0"
                ]
            ]
        }
    ],
    "lcname": "aggregate6"
}
        
Elapsed time: 0.01317s