Welcome to IpSurv

Welcome to IpSurv’s documentation! This document explains the basic usage and system information.

IpSurv

Github

The latest version and documentation may be found on GitHub. The Github URL is the following.

Overview

IpSurv Command

$ cat ips.txt|ipsurv 192.168.1.10
$ ipsurv 192.168.1.10 192.168.1.11
$ ipsurv wikipedia.org

# Use GeoIP2: Dependency "geoip2" module.
$ ipsurv wikipedia.org --geoip_only

# Survey self IP
$ ipsurv self

Command options

IpSurv have many Command options. For details on Command options, please refer here.

[-h] [--verbose {0,1,2,3}] [--debug] [--log LOG]
[--disable_env] [--resolve RESOLVE] [--identify_int]
[--autodetect AUTODETECT] [--begin BEGIN] [--end END]
[--collect COLLECT] [--all_collect] [--timeout TIMEOUT]
[--group GROUP] [--skip_duplicate {0,1,2}] [--range RANGE]
[--format FORMAT] [--no_original] [--sequence] [--add_ip]
[--ident] [--enclose ENCLOSE] [--delimiter DELIMITER]
[--alt_delimiter ALT_DELIMITER] [--headers {0,1,2,3}]
[--json {0,1,2}] [--json_list] [--exhaustive] [--icmp ICMP]
[--tcp TCP] [--udp UDP] [--http {0,1,2}] [--json_all]
[--geoip_only] [--version]
[target [target ...]]

Output Format

You can customize “Output Format” by `--format` option as follows. There are `parameter - {}` and `profile - <>` in `--format`. For more information, please read –format description.

$ ipsurv github.io --format=heavy            # Profile
$ ipsurv github.io --format=simple           # Profile

$ ipsurv 8.8.8.8 --format="{status},{ip},{country},{address}"   # Paramaters
$ ipsurv 8.8.8.8 --format="{status}\t{ip}\t{hostname}"         # Paramaters, TAB char

$ ipsurv cloudflare.com --format="{ip},<address>,<system>"      # Paramaters + Profile
$ ipsurv wikipedia.org --format="<address>,{hostname},{ip_type}"     # Profile + Paramaters

Modules and Classes reference

The following is the documentation for the module and class. Github source