catocli 3.0.18__py3-none-any.whl → 3.0.22__py3-none-any.whl

catocli/parsers/query_socketPortMetrics/README.md

@@ -40,6 +40,50 @@ catocli query socketPortMetrics '{
 }'
 ```
 
+## Advanced Usage
+### Additional Examples
+- 1 Day sum of traffic by site, socket_interface, device_id
+
+# 1 Day sum of traffic by site, socket_interface, device_id
+
+```bash
+# 1 Day sum of traffic by site, socket_interface, device_id
+catocli query socketPortMetrics '{
+    "socketPortMetricsDimension": [
+        {
+            "fieldName": "socket_interface"
+        },
+        {
+            "fieldName": "device_id"
+        },
+        {
+            "fieldName": "site_id"
+        },
+        {
+            "fieldName": "site_name"
+        }
+    ],
+    "socketPortMetricsFilter": [],
+    "socketPortMetricsMeasure": [
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_upstream"
+        },
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_downstream"
+        },
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_total"
+        }
+    ],
+    "socketPortMetricsSort": [],
+    "timeFrame": "last.P1D"
+}'
+```
+
+
 
 #### TimeFrame Parameter Examples
 

catocli/parsers/query_socketPortMetrics/__init__.py

@@ -16,4 +16,10 @@ def query_socketPortMetrics_parse(query_subparsers):
     query_socketPortMetrics_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
     query_socketPortMetrics_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
     query_socketPortMetrics_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+
+
+    query_socketPortMetrics_parser.add_argument('-f', '--format', choices=['json', 'csv'], help='Output format (default: formatted json, use -raw for original json)')
+    query_socketPortMetrics_parser.add_argument('-raw', '--raw', dest='raw_output', action='store_true', help='Return raw/original JSON format (bypasses default formatting)')
+    query_socketPortMetrics_parser.add_argument('--csv-filename', dest='csv_filename', help='Override CSV file name (default: socketportmetrics.csv)')
+    query_socketPortMetrics_parser.add_argument('--append-timestamp', dest='append_timestamp', action='store_true', help='Append timestamp to the CSV file name')
     query_socketPortMetrics_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetrics')

catocli/parsers/query_socketPortMetricsTimeSeries/README.md

@@ -38,6 +38,89 @@ catocli query socketPortMetricsTimeSeries '{
 }'
 ```
 
+## Advanced Usage
+### Additional Examples
+- 1 Day sum of traffic by site, socket_interface, device_id
+- 1 Day sum of traffic by site, socket_interface, device_id as csv
+
+# 1 Day sum of traffic by site, socket_interface, device_id
+
+```bash
+# 1 Day sum of traffic by site, socket_interface, device_id as csv
+catocli query socketPortMetricsTimeSeries
+    "buckets": 24,
+    "socketPortMetricsDimension": [
+        {
+            "fieldName": "socket_interface"
+        },
+        {
+            "fieldName": "device_id"
+        },
+        {
+            "fieldName": "site_id"
+        },
+        {
+            "fieldName": "site_name"
+        }
+    ],
+    "socketPortMetricsFilter": [],
+    "socketPortMetricsMeasure": [
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_downstream"
+        },
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_upstream"
+        },
+        {
+            "aggType": "sum",
+            "fieldName": "bytes_total"
+        }
+    ],
+    "timeFrame": "last.P1D"
+}' -f csv
+```
+
+# 1 Day sum of traffic by site, socket_interface, device_id
+
+```bash
+# 1 Day sum of traffic by site, socket_interface, device_id
+catocli query socketPortMetricsTimeSeries '{
+    "buckets": 120,
+    "socketPortMetricsDimension": [
+        {
+            "fieldName": "socket_interface"
+        },
+        {
+            "fieldName": "device_id"
+        },
+        {
+            "fieldName": "site_id"
+        },
+        {
+            "fieldName": "site_name"
+        }
+    ],
+    "socketPortMetricsFilter": [],
+    "socketPortMetricsMeasure": [
+        {
+            "aggType": "sum",
+            "fieldName": "throughput_downstream"
+        },
+        {
+            "aggType": "sum",
+            "fieldName": "throughput_upstream"
+        }
+    ],
+    "timeFrame": "last.P2M"
+}'
+```
+
+
+
+
+
 
 #### TimeFrame Parameter Examples
 

catocli/parsers/query_socketPortMetricsTimeSeries/__init__.py

@@ -17,7 +17,9 @@ def query_socketPortMetricsTimeSeries_parse(query_subparsers):
     query_socketPortMetricsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
     query_socketPortMetricsTimeSeries_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
 
-    query_socketPortMetricsTimeSeries_parser.add_argument('-f', '--format', choices=['json', 'csv'], default='json', help='Output format (default: json)')
-    query_socketPortMetricsTimeSeries_parser.add_argument('--csv-filename', dest='csv_filename', help='Override CSV file name (default: accountmetrics.csv)')
+
+    query_socketPortMetricsTimeSeries_parser.add_argument('-f', '--format', choices=['json', 'csv'], help='Output format (default: formatted json, use -raw for original json)')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-raw', '--raw', dest='raw_output', action='store_true', help='Return raw/original JSON format (bypasses default formatting)')
+    query_socketPortMetricsTimeSeries_parser.add_argument('--csv-filename', dest='csv_filename', help='Override CSV file name (default: socketportmetricstimeseries.csv)')
     query_socketPortMetricsTimeSeries_parser.add_argument('--append-timestamp', dest='append_timestamp', action='store_true', help='Append timestamp to the CSV file name')
     query_socketPortMetricsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetricsTimeSeries')

{catocli-3.0.18.dist-info → catocli-3.0.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: catocli
-Version: 3.0.18
+Version: 3.0.22
 Summary: Cato Networks cli wrapper for the GraphQL API.
 Home-page: https://github.com/Cato-Networks/cato-cli
 Author: Cato Networks