man.rst/ifquery.8.rst

   1 =======
   2 ifquery
   3 =======
   4
   5 -------------------------------------
   6 query network interface configuration
   7 -------------------------------------
   8
   9 :Author: Roopa Prabhu <roopa@cumulusnetworks.com>
  10 :Date:   2014-02-05
  11 :Copyright: Copyright 2014 Cumulus Networks, Inc.  All rights reserved.
  12 :Version: 0.1
  13 :Manual section: 8
  14
  15 SYNOPSIS
  16 ========
  17
  18     **ifquery [-v] [--allow CLASS] [--with-depends] -a|IFACE...**
  19
  20     **ifquery [-v] [-r|--running] [--allow CLASS] [--with-depends] -a|IFACE...**
  21
  22     **ifquery [-v] [-c|--check] [--allow CLASS] [--with-depends] -a|IFACE...**
  23
  24     **ifquery [-v] [-p|--print-dependency {list,dot}] [--allow CLASS] [--with-depends] -a|IFACE...**
  25
  26     **ifquery [-v] -s|--syntax-help**
  27
  28 DESCRIPTION
  29 ===========
  30     **ifquery** can be used to parse interface configuration file, query
  31     running state or check running state of the interface with configuration
  32     in **/etc/network/interfaces** file.
  33
  34     **ifquery** always works on the current **interfaces(5)** file
  35     **/etc/network/interfaces** unless an alternate interfaces file is
  36     provided with the **-i** option.
  37
  38 OPTIONS
  39 =======
  40     positional arguments:
  41
  42     **IFACE**   interface list separated by spaces. **IFACE** list and **'-a'** argument are mutually exclusive.
  43
  44     optional arguments:
  45
  46     -h, --help            show this help message and exit
  47
  48     -a, --all             process all interfaces marked "auto"
  49
  50     -v, --verbose         verbose
  51
  52     -d, --debug           output debug info
  53
  54     -l, --allow CLASS     ignore non-"allow-CLASS" interfaces
  55
  56     -w, --with-depends    run with all dependent interfaces. This option
  57                           is redundant when -a is specified. When '-a' is
  58                           specified, interfaces are always executed in
  59                           dependency order.
  60
  61     -X EXCLUDEPATS, --exclude EXCLUDEPATS
  62                           Exclude interfaces from the list of interfaces to
  63                           operate on. Can be specified multiple times
  64
  65     -i INTERFACESFILE, --interfaces INTERFACESFILE
  66                           Use interfaces file instead of default
  67                           /etc/network/interfaces
  68
  69     -r, --running         print raw interfaces file entries
  70
  71     -c, --check           check interface file contents against running state
  72                           of an interface. Returns exit code 0 on success and
  73                           1 on error
  74
  75     -x, --raw             print raw config file entries
  76
  77
  78     -o {native,json}, --format {native,json}
  79                           interface display format
  80
  81     -p, --print-dependency {list,dot}
  82                           print iface dependency in list or dot format
  83
  84     -s, --syntax-help     print supported interface config syntax. Scans all
  85                           addon modules and dumps supported syntax from them
  86                           if provided by the module.
  87
  88 EXAMPLES
  89 ========
  90     # dump all or some interfaces config file entries
  91     # (pretty prints user provided entries)
  92
  93         **ifquery -a**
  94
  95         **ifquery br0**
  96
  97     # Same as above but dump with dependencies
  98
  99         **ifquery br0 --with-depends**
 100
 101     # Check running state with the config in /etc/network/interfaces
 102
 103         **ifquery --check br0**
 104
 105         **ifquery --check --with-depends br0**
 106
 107         **ifquery --check -a**
 108
 109     # dump running state of all interfaces in /etc/network/interfaces format
 110
 111         **ifquery --running br0**
 112
 113         **ifquery --running --with-depends br0**
 114
 115         **ifquery --running -a**
 116
 117     # print dependency info in list format
 118
 119         **ifquery --print-dependency=list -a**
 120
 121         **ifquery --print-dependency=list  br2000**
 122
 123     # print dependency info in dot format
 124
 125         **ifquery --print-dependency=dot -a**
 126
 127         **ifquery --print-dependency=dot br2000**
 128
 129     # Create an image (png) from the dot format
 130
 131         **ifquery --print-dependency=dot -a > interfaces.dot**
 132
 133         **dot -Tpng interfaces.dot > interfaces.png**
 134
 135         (The above command only works on a system with dot installed)
 136
 137
 138 SEE ALSO
 139 ========
 140     ifup(8),
 141     ifdown(8),
 142     ifreload(8),
 143     interfaces(5),
 144     ifupdown-addons-interfaces(5)