Merge pull request #977 from netenglabs/feature/device-filter-address

New feature device filter address

Author: ddutt

suzieq/cli/sqcmds/AddressCmd.py

@@ -13,7 +13,7 @@
           description="type of address, v4, v6 or l2",
           choices=["v4", "v6", "l2"])
 @argument("address",
-          description="Address(es), in quotes, space separated")
+          description="IP Address(es), in quotes, space separated")
 @argument("prefix",
           description=("Show all the addresses in this "
                        "subnet prefix (in quotes)"))

suzieq/cli/sqcmds/DeviceCmd.py

@@ -12,6 +12,7 @@
 @argument("version", description="NOS version(s), space separated")
 @argument("vendor", description="Vendor(s), space separated")
 @argument("model", description="Model(s), space separated")
+@argument("address", description="IP Address(es), in quotes, space separated")
 class DeviceCmd(SqTableCommand):
     """Basic device information such as OS, version, model etc."""
 
@@ -31,6 +32,7 @@ def __init__(
             status: str = '',
             vendor: str = '',
             model: str = '',
+            address: str = '',
     ) -> None:
         super().__init__(
             engine=engine,
@@ -60,5 +62,6 @@ def __init__(
             'version': version.split(),
             'status': status.split(),
             'model': model,
-            'vendor': vendor.split()
+            'vendor': vendor.split(),
+            'address': address.split()
         }

suzieq/restServer/query.py

@@ -365,6 +365,7 @@ def query_device(verb: CommonVerbs, request: Request,
                  status: List[DeviceStatus] = Query(None),
                  ignore_neverpoll: bool = None,
                  count: str = None, reverse: str = None,
+                 address: List[str] = Query(None)
                  ):
     function_name = inspect.currentframe().f_code.co_name
     if status:

suzieq/sqobjects/device.py

@@ -12,7 +12,7 @@ def __init__(self, **kwargs):
         super().__init__(table='device', **kwargs)
         self._valid_get_args = ['namespace', 'hostname', 'columns', 'os',
                                 'vendor', 'model', 'status', 'version',
-                                'query_str', 'ignore_neverpoll']
+                                'query_str', 'ignore_neverpoll', 'address']
         self._valid_arg_vals = {
             'status': ['alive', 'dead', 'neverpoll',
                        '!alive', '!dead', '!neverpoll']

tests/integration/sqcmds/common-samples/help.yml

@@ -279,10 +279,11 @@ tests:
   format: text
   marks: device help command
   output: "device show: \e[36mShow address info\e[0m\n\e[33m\nUse quotes when providing\
-    \ more than one value\e[0m\n\e[33m\nArguments:\e[0m\n - columns: \e[36m\e[1mSpace\
-    \ separated list of columns, * for all\e[0m\n - end_time: \e[36m\e[1mEnd of time\
-    \ window, try natural language spec \e[0m\n - format: \e[36m\e[1mSelect the pformat\
-    \ of the output\e[0m\n - hostname: \e[36m\e[1mHostname(s), space separated\e[0m\n\
+    \ more than one value\e[0m\n\e[33m\nArguments:\e[0m\n - address: \e[36m\e[1mIP\
+    \ Address(es), in quotes, space separated\e[0m\n - columns: \e[36m\e[1mSpace separated\
+    \ list of columns, * for all\e[0m\n - end_time: \e[36m\e[1mEnd of time window,\
+    \ try natural language spec \e[0m\n - format: \e[36m\e[1mSelect the pformat of\
+    \ the output\e[0m\n - hostname: \e[36m\e[1mHostname(s), space separated\e[0m\n\
     \ - model: \e[36m\e[1mFilter by model\e[0m\n - namespace: \e[36m\e[1mNamespace(s),\
     \ space separated\e[0m\n - os: \e[36m\e[1mNOS(s), space separated\e[0m\n - query_str:\
     \ \e[36m\e[1mTrailing blank terminated pandas query format to further filter the\
@@ -297,46 +298,49 @@ tests:
   marks: device help command
   output: "device summarize: \e[36mSummarize relevant information about the table\e\
     [0m\n\e[33m\nUse quotes when providing more than one value\e[0m\n\e[33m\nArguments:\e\
-    [0m\n - columns: \e[36m\e[1mSpace separated list of columns, * for all\e[0m\n\
-    \ - end_time: \e[36m\e[1mEnd of time window, try natural language spec \e[0m\n\
-    \ - format: \e[36m\e[1mSelect the pformat of the output\e[0m\n - hostname: \e\
-    [36m\e[1mHostname(s), space separated\e[0m\n - model: \e[36m\e[1mFilter by model\e\
-    [0m\n - namespace: \e[36m\e[1mNamespace(s), space separated\e[0m\n - os: \e[36m\e\
-    [1mNOS(s), space separated\e[0m\n - query_str: \e[36m\e[1mTrailing blank terminated\
-    \ pandas query format to further filter the output\e[0m\n - start_time: \e[36m\e\
-    [1mStart of time window, try natural language spec\e[0m\n - status: \e[36m\e[1mstatus\
-    \ of service to match\e[0m\n - vendor: \e[36m\e[1mVendor(s), space separated\e\
-    [0m\n - version: \e[36m\e[1mNOS version(s), space separated\e[0m\n - view: \e\
-    [36m\e[1mView all records or just the latest\e[0m\n"
+    [0m\n - address: \e[36m\e[1mIP Address(es), in quotes, space separated\e[0m\n\
+    \ - columns: \e[36m\e[1mSpace separated list of columns, * for all\e[0m\n - end_time:\
+    \ \e[36m\e[1mEnd of time window, try natural language spec \e[0m\n - format: \e\
+    [36m\e[1mSelect the pformat of the output\e[0m\n - hostname: \e[36m\e[1mHostname(s),\
+    \ space separated\e[0m\n - model: \e[36m\e[1mFilter by model\e[0m\n - namespace:\
+    \ \e[36m\e[1mNamespace(s), space separated\e[0m\n - os: \e[36m\e[1mNOS(s), space\
+    \ separated\e[0m\n - query_str: \e[36m\e[1mTrailing blank terminated pandas query\
+    \ format to further filter the output\e[0m\n - start_time: \e[36m\e[1mStart of\
+    \ time window, try natural language spec\e[0m\n - status: \e[36m\e[1mstatus of\
+    \ service to match\e[0m\n - vendor: \e[36m\e[1mVendor(s), space separated\e[0m\n\
+    \ - version: \e[36m\e[1mNOS version(s), space separated\e[0m\n - view: \e[36m\e\
+    [1mView all records or just the latest\e[0m\n"
 - command: device help --command=unique
   data-directory: tests/data/parquet
   format: text
   marks: device help command
   output: "device unique: \e[36mGet unique values (and counts) associated with requested\
     \ field\e[0m\n\e[33m\nUse quotes when providing more than one value\e[0m\n\e[33m\n\
-    Arguments:\e[0m\n - columns: \e[36m\e[1mSpace separated list of columns, * for\
-    \ all\e[0m\n - count: \e[36m\e[1minclude count of times a value is seen\e[0m\n\
-    \ - end_time: \e[36m\e[1mEnd of time window, try natural language spec \e[0m\n\
-    \ - format: \e[36m\e[1mSelect the pformat of the output\e[0m\n - hostname: \e\
-    [36m\e[1mHostname(s), space separated\e[0m\n - model: \e[36m\e[1mFilter by model\e\
-    [0m\n - namespace: \e[36m\e[1mNamespace(s), space separated\e[0m\n - os: \e[36m\e\
-    [1mNOS(s), space separated\e[0m\n - query_str: \e[36m\e[1mTrailing blank terminated\
-    \ pandas query format to further filter the output\e[0m\n - start_time: \e[36m\e\
-    [1mStart of time window, try natural language spec\e[0m\n - status: \e[36m\e[1mstatus\
-    \ of service to match\e[0m\n - vendor: \e[36m\e[1mVendor(s), space separated\e\
-    [0m\n - version: \e[36m\e[1mNOS version(s), space separated\e[0m\n - view: \e\
-    [36m\e[1mView all records or just the latest\e[0m\n"
+    Arguments:\e[0m\n - address: \e[36m\e[1mIP Address(es), in quotes, space separated\e\
+    [0m\n - columns: \e[36m\e[1mSpace separated list of columns, * for all\e[0m\n\
+    \ - count: \e[36m\e[1minclude count of times a value is seen\e[0m\n - end_time:\
+    \ \e[36m\e[1mEnd of time window, try natural language spec \e[0m\n - format: \e\
+    [36m\e[1mSelect the pformat of the output\e[0m\n - hostname: \e[36m\e[1mHostname(s),\
+    \ space separated\e[0m\n - model: \e[36m\e[1mFilter by model\e[0m\n - namespace:\
+    \ \e[36m\e[1mNamespace(s), space separated\e[0m\n - os: \e[36m\e[1mNOS(s), space\
+    \ separated\e[0m\n - query_str: \e[36m\e[1mTrailing blank terminated pandas query\
+    \ format to further filter the output\e[0m\n - start_time: \e[36m\e[1mStart of\
+    \ time window, try natural language spec\e[0m\n - status: \e[36m\e[1mstatus of\
+    \ service to match\e[0m\n - vendor: \e[36m\e[1mVendor(s), space separated\e[0m\n\
+    \ - version: \e[36m\e[1mNOS version(s), space separated\e[0m\n - view: \e[36m\e\
+    [1mView all records or just the latest\e[0m\n"
 - command: device help --command=top
   data-directory: tests/data/parquet
   format: text
   marks: device help command
   output: "device top: \e[36mReturn the top n values for a field in a table\e[0m\n\
     \e[33m\nUse quotes when providing more than one value\e[0m\n\e[33m\nArguments:\e\
-    [0m\n - columns: \e[36m\e[1mSpace separated list of columns, * for all\e[0m\n\
-    \ - count: \e[36m\e[1mnumber of rows to return\e[0m\n - end_time: \e[36m\e[1mEnd\
-    \ of time window, try natural language spec \e[0m\n - format: \e[36m\e[1mSelect\
-    \ the pformat of the output\e[0m\n - hostname: \e[36m\e[1mHostname(s), space separated\e\
-    [0m\n - model: \e[36m\e[1mFilter by model\e[0m\n - namespace: \e[36m\e[1mNamespace(s),\
+    [0m\n - address: \e[36m\e[1mIP Address(es), in quotes, space separated\e[0m\n\
+    \ - columns: \e[36m\e[1mSpace separated list of columns, * for all\e[0m\n - count:\
+    \ \e[36m\e[1mnumber of rows to return\e[0m\n - end_time: \e[36m\e[1mEnd of time\
+    \ window, try natural language spec \e[0m\n - format: \e[36m\e[1mSelect the pformat\
+    \ of the output\e[0m\n - hostname: \e[36m\e[1mHostname(s), space separated\e[0m\n\
+    \ - model: \e[36m\e[1mFilter by model\e[0m\n - namespace: \e[36m\e[1mNamespace(s),\
     \ space separated\e[0m\n - os: \e[36m\e[1mNOS(s), space separated\e[0m\n - query_str:\
     \ \e[36m\e[1mTrailing blank terminated pandas query format to further filter the\
     \ output\e[0m\n - reverse: \e[36m\e[1mreturn bottom n values\e[0m\n - start_time:\

tests/integration/sqcmds/cumulus-samples/device.yml

@@ -189,3 +189,13 @@ tests:
   error:
     error: '[{"error": "ERROR: Invalid columns specified: [''badcolumn'']"}]'
   marks: device unique
+- command: device show --format=json --namespace='ospf-single dual-evpn ospf-ibgp'
+    --address='192.168.121.13 192.168.121.38'
+  data-directory: tests/data/parquet/
+  marks: device show
+  output: '[{"namespace": "dual-evpn", "hostname": "leaf03", "model": "VX", "version":
+    "3.7.9", "vendor": "Cumulus", "serialNumber": "None", "status": "alive", "address":
+    "192.168.121.13", "bootupTimestamp": 1616644598.0, "timestamp": 1616644822331},
+    {"namespace": "dual-evpn", "hostname": "leaf04", "model": "VX", "version": "3.7.9",
+    "vendor": "Cumulus", "serialNumber": "None", "status": "alive", "address": "192.168.121.38",
+    "bootupTimestamp": 1616644597.0, "timestamp": 1616644822465}]'

tests/integration/sqcmds/eos-samples/device.yml

@@ -171,3 +171,12 @@ tests:
   data-directory: tests/data/parquet/
   marks: device show filter eos
   output: '[{"version": "4.23.5M"}]'
+- command: device show --format=json --namespace=eos --address='10.255.2.118 10.255.2.117'
+  data-directory: tests/data/parquet/
+  marks: device show eos
+  output: '[{"namespace": "eos", "hostname": "spine01", "model": "vEOS", "version":
+    "4.23.5M", "vendor": "Arista", "serialNumber": "", "status": "alive", "address":
+    "10.255.2.117", "bootupTimestamp": 1620676825.0, "timestamp": 1623025176945},
+    {"namespace": "eos", "hostname": "spine02", "model": "vEOS", "version": "4.23.5M",
+    "vendor": "Arista", "serialNumber": "", "status": "alive", "address": "10.255.2.118",
+    "bootupTimestamp": 1620676826.0, "timestamp": 1623025177075}]'

tests/integration/sqcmds/junos-samples/device.yml

@@ -168,3 +168,12 @@ tests:
   data-directory: tests/data/parquet/
   marks: device show filter junos
   output: '[{"version": "19.4R1.10"}]'
+- command: device show --format=json --namespace=junos --address='10.255.5.118 10.255.5.117'
+  data-directory: tests/data/parquet/
+  marks: device show junos
+  output: '[{"namespace": "junos", "hostname": "spine01", "model": "vqfx-10000", "version":
+    "19.4R1.10", "vendor": "Juniper", "serialNumber": "38645725387", "status": "alive",
+    "address": "10.255.5.117", "bootupTimestamp": 1622997977.081, "timestamp": 1623025799081},
+    {"namespace": "junos", "hostname": "spine02", "model": "vqfx-10000", "version":
+    "19.4R1.10", "vendor": "Juniper", "serialNumber": "05518142768", "status": "alive",
+    "address": "10.255.5.118", "bootupTimestamp": 1622998003.357, "timestamp": 1623025799357}]'

tests/integration/sqcmds/nxos-samples/device.yml

@@ -403,3 +403,13 @@ tests:
     "model": "Nexus9000 C9300v Chassis", "version": "9.3(4)", "vendor": "Cisco", "serialNumber":
     "9AC2MF0S5QO", "status": "alive", "address": "10.255.2.188", "bootupTimestamp":
     1619043783.0, "timestamp": 1619275265679}]'
+- command: device show --format=json --namespace=nxos --address='10.255.2.119 10.255.2.120'
+  data-directory: tests/data/parquet/
+  marks: device show nxos
+  output: '[{"namespace": "nxos", "hostname": "spine02", "model": "Nexus9000 C9300v
+    Chassis", "version": "9.3(4)", "vendor": "Cisco", "serialNumber": "9SM7CHR8WEF",
+    "status": "alive", "address": "10.255.2.120", "bootupTimestamp": 1619013194.0,
+    "timestamp": 1619275263055}, {"namespace": "nxos", "hostname": "spine01", "model":
+    "Nexus9000 C9300v Chassis", "version": "9.3(4)", "vendor": "Cisco", "serialNumber":
+    "9U1GLRQOXD7", "status": "alive", "address": "10.255.2.119", "bootupTimestamp":
+    1619013190.0, "timestamp": 1619275263589}]'

tests/integration/sqcmds/panos-samples/device.yml

@@ -99,3 +99,12 @@ tests:
   error:
     error: '[{"error": "ERROR: Invalid columns specified: [''badcolumn'']"}]'
   marks: device unique panos
+- command: device show --format=json --namespace=panos --address='10.255.2.118 10.255.2.117'
+  data-directory: tests/data/parquet/
+  marks: device show panos
+  output: '[{"namespace": "panos", "hostname": "spine01", "model": "VX", "version":
+    "4.1.1", "vendor": "Cumulus", "serialNumber": "None", "status": "alive", "address":
+    "10.255.2.117", "bootupTimestamp": 1639470234.0, "timestamp": 1639476254852},
+    {"namespace": "panos", "hostname": "spine02", "model": "VX", "version": "4.1.1",
+    "vendor": "Cumulus", "serialNumber": "None", "status": "alive", "address": "10.255.2.118",
+    "bootupTimestamp": 1639470234.0, "timestamp": 1639476254852}]'