{
    "info": {
        "author": "Brian Stajkowski",
        "author_email": "stajkowski100@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Topic :: Software Development :: Build Tools"
        ],
        "description": "Net-Survey\n==========\n\nNet-Survey allows you to deploy agents throughout your infrastructure to\ngather network, interface, and ip configuration with the end goal of running\na direct scan of basic reachability and ports.  Server and agents deployed\nwill progress through a series of steps once started:\n\n* Gathering of interface and network information.\n* Updating the central server.\n* Processing of topology information.\n* Distribution of all topology data to clients.\n* Clients then proceed to scanning of known neighboring hosts.\n* Retrieval of test results.\n\nThe benefit of Net-Survey is providing tests in situations where networks\nare isolated, i.e. a backend storage network.  It is also very fast as\nthe targeted scan will only scan known neighboring IPs with the interest\nof learning where setup issues exist on a new or existing infrastructure.\n\nInstallation\n============\n\nSimple install via pypi:\n\nNote: Please ensure python-dev is installed prior to installing net-survey.\n\n```\npip install net-survey\n```\n\nCommand Line Usage\n==================\n\nServer start:\n\n```\nnet-survey --mode server --inventory_file /home/user/myinventory\n```\n\nAPI start:\n\n```\nnet-survey --mode api --inventory_file /home/user/myinventory\n```\n\nClient start:\n\n```\nnet-survey --server_ip <server_ip>\n```\n\nUsage\n=====\n\nEnsure config file is installed during setup.  You might need sudo privileges\nto install net-survey as it creates /etc/net-survey.  The configuration file\ncan be manually stated via the --config-file param as well.\n\nServer start:\n\n```\nnet-survey --config-file /etc/net-survey/netsurvey.config\n```\n\nUse the configuration file provided to set the mode to `server`. Optionally,\nadjust the API, Redis, and Server ports to best fit your needs.\n\n\nAPI start:\n\n```\nnet-survey --config-file /etc/net-survey/netsurvey.config\n```\n\nUse the configuration file provided to set the mode to `api`. Optionally,\nadjust the API and Redis ports to best fit your needs.\n\n\nClient start:\n\n```\nnet-survey --config-file /etc/net-survey/netsurvey.config\n```\n\nUse the configuration file provided to set the mode to `client`. Set the IP\nAddress of the server via `server_ip`, and optionally, adjust the options\nto best suite your needs.\n\n\nAPI Usage\n=========\n\nThe API server can be started on one node with the main Net-Survey server with\nthe mode `mixed`.  Otherwise, the API node can be separated from the server\nnode by setting the mode to `api`.\n\nRedis is required to be installed and reachable, where the API node is in\ncontrol of the server and clients.  The Redis instance can be located on any\nof the server or api nodes.\n\nThe API Server will respond to GET requests on / and return a JSON dump\ncontaining the results of a scan or the current status of a scan:\n\n```json\n\n{\n\"_host_detail\":\n    {\n    \"compute02\":\n        {\"192.168.140.0/24\":\n            {\"ips\": [\"192.168.140.118\"],\n            \"results\": {\"192.168.140.117\":\n                {\"host\": \"compute01\",\n                \"result\": \"success\",\n                \"open_ports\": [22]\n                }\n            }\n        }, \"192.168.100.0/24\":\n            {\"ips\": [\"192.168.100.118\"],\n            \"results\": {\"192.168.100.117\":\n                {\"host\": \"compute01\",\n                \"result\": \"success\",\n                \"open_ports\": [22]\n                }\n            }\n        }\n    },\n    \"compute01\":\n        {\"192.168.140.0/24\":\n            {\"ips\": [\"192.168.140.117\"],\n            \"results\": {\"192.168.140.118\":\n                {\"host\": \"compute02\",\n                \"result\": \"success\",\n                \"open_ports\": [22]\n                }\n            }\n        }, \"192.168.100.0/24\":\n            {\"ips\": [\"192.168.100.117\"],\n            \"results\":\n                {\"192.168.100.118\":\n                    {\"host\": \"compute02\",\n                    \"result\": \"success\",\n                    \"open_ports\": [22]\n                    }\n                }\n            }\n        }\n    },\n    \"_state\": \"sleeping\",\n    \"_clients\": {\"compute02\": \"192.168.100.118\", \"compute01\": \"192.168.100.117\"},\n    \"_networks\":\n        {\n            \"192.168.140.0/24\": [\"compute02\", \"compute01\"],\n            \"192.168.100.0/24\": [\"compute02\", \"compute01\"]\n        }\n}\n\n```\n\nThe API Server can also control when a scan will take place, by issuing a\nPOST to /start.  By default, the server service will not immediately start a\nscan, but this can be enabled by setting `scan_on_start` to `True`.\n\nBy setting `scan_on_start` the server instance will bypass all API control,\nand disables the need for the API and Redis instances.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/stajkowski/net-survey",
        "keywords": "network survey",
        "license": "Apache",
        "maintainer": null,
        "maintainer_email": null,
        "name": "net-survey",
        "package_url": "https://pypi.org/project/net-survey/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/net-survey/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/stajkowski/net-survey"
        },
        "release_url": "https://pypi.org/project/net-survey/0.0.4/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Network Installation Survey",
        "version": "0.0.4"
    },
    "last_serial": 2436430,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d146495824c58a3597e38aa19f7226a2",
                    "sha256": "f4e6b0f5b860ee50a865e8247b0cb88a419657c40c25810f29d3f5ac978696ba"
                },
                "downloads": -1,
                "filename": "net-survey-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d146495824c58a3597e38aa19f7226a2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21316,
                "upload_time": "2016-10-27T05:53:58",
                "url": "https://files.pythonhosted.org/packages/98/85/fc6879003815668282506fbb560991833376cc06e93abe643e5b706d9b91/net-survey-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f2c91dec5971ada9500c9d6ee85f3d40",
                    "sha256": "84b978c330d8f4a3c4aa12b74f73c311ac87c463e46f750fac337ca4c939ebe1"
                },
                "downloads": -1,
                "filename": "net-survey-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "f2c91dec5971ada9500c9d6ee85f3d40",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27973,
                "upload_time": "2016-10-31T23:29:22",
                "url": "https://files.pythonhosted.org/packages/50/52/b8b6552925b223cf7e146e97baf42f161290154a09a6b0730b36ee6124f6/net-survey-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b2ea09b1874ccfe1893077072960fb50",
                    "sha256": "c055fa75cc58b69e50fa440b4db1be97fe8db2cf6213d33f07f1e0b3772d0206"
                },
                "downloads": -1,
                "filename": "net-survey-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "b2ea09b1874ccfe1893077072960fb50",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 29503,
                "upload_time": "2016-11-01T22:46:58",
                "url": "https://files.pythonhosted.org/packages/4a/cb/a6b701532d1e24a3b69afebbbb2741d3ce9077593fbb8c680c02634ef548/net-survey-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "174478c212195593785e79dc6bf8f592",
                    "sha256": "dd370ec482f34cb07848e1e97cfbf3d6b1ee69ae04c12d046c7e52e50f5be351"
                },
                "downloads": -1,
                "filename": "net-survey-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "174478c212195593785e79dc6bf8f592",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 29533,
                "upload_time": "2016-11-01T23:17:54",
                "url": "https://files.pythonhosted.org/packages/bb/89/517b3131e7bc34dad32e7b87ef209b57253dbdccccd0d628c8378688fd1e/net-survey-0.0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "174478c212195593785e79dc6bf8f592",
                "sha256": "dd370ec482f34cb07848e1e97cfbf3d6b1ee69ae04c12d046c7e52e50f5be351"
            },
            "downloads": -1,
            "filename": "net-survey-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "174478c212195593785e79dc6bf8f592",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 29533,
            "upload_time": "2016-11-01T23:17:54",
            "url": "https://files.pythonhosted.org/packages/bb/89/517b3131e7bc34dad32e7b87ef209b57253dbdccccd0d628c8378688fd1e/net-survey-0.0.4.tar.gz"
        }
    ]
}