catocli 3.0.18__tar.gz → 3.0.24__tar.gz

catocli-3.0.24/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: catocli
+Version: 3.0.24
+Summary: Cato Networks cli wrapper for the GraphQL API.
+Home-page: https://github.com/Cato-Networks/cato-cli
+Author: Cato Networks
+Author-email: [email protected]
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3
+Requires-Dist: certifi
+Requires-Dist: six
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Cato Networks GraphQL API CLI
+
+The package provides a simple to use CLI that reflects industry standards (such as the AWS cli), and enables customers to manage Cato Networks configurations and processes via the [Cato Networks GraphQL API](https://api.catonetworks.com/api/v1/graphql2) easily integrating into configurations management, orchestration or automation frameworks to support the DevOps model.
+
+## Overview
+
+CatoCLI is a command-line interface that provides access to the Cato Networks GraphQL API, enabling you to:
+- Generate detailed network and security reports
+- Analyze user and application activity
+- Monitor network performance and events
+- Export data in multiple formats (JSON, CSV)
+- Automate reporting and monitoring tasks
+
+## Prerequisites
+
+- Python 3.6 or higher
+- CatoCLI installed (`pip3 install catocli`)
+- Valid Cato Networks API token and Account ID
+- Proper authentication configuration (see [Authentication Setup](#authentication-setup))
+
+## Installation  
+
+`pip3 install catocli`
+
+## Authentication Setup
+
+Configure your CatoCLI profile before using any query operations:
+
+```bash
+# Interactive configuration
+catocli configure set
+
+# Non-interactive configuration
+catocli configure set --cato-token "your-api-token" --account-id "12345"
+
+# List configured profiles
+catocli configure list
+
+# Show current profile
+catocli configure show
+```
+
+### Documentation
+
+For detailed information about profile management, see [PROFILES.md](PROFILES.md).
+
+[CLICK HERE](https://support.catonetworks.com/hc/en-us/articles/4413280536081-Generating-API-Keys-for-the-Cato-API) to see how create an API key to authenticate.
+
+## Running the CLI
+	catocli -h
+	catocli query -h
+	catocli query entityLookup -h
+	catocli query entityLookup '{"type":"country"}`
+    
+    // Override the accountID value as a cli argument
+	catocli query entityLookup -accountID=12345 '{"type":"country"}`
+
+## Check out run locally not as pip package
+	git clone git@github.com:Cato-Networks/cato-cli.git
+	cd cato-cli
+	python3 -m catocli -h
+
+## Query Operations
+
+### Core Analytics Queries
+
+| Operation | Description | Guide |
+|-----------|-------------|--------|
+| [Account Metrics](./catocli_user_guide/account-metrics.md) | Network performance metrics by site, user, or interface | 📊 |
+| [Application Statistics](./catocli_user_guide/app-stats.md) | User activity and application usage analysis | 📱 |
+| [Application Time Series](./catocli_user_guide/app-stats-timeseries.md) | Traffic analysis over time with hourly/daily breakdowns | 📈 |
+| [Events Time Series](./catocli_user_guide/events-timeseries.md) | Security events, connectivity, and threat analysis | 🔒 |
+| [Socket Port Metrics](./catocli_user_guide/socket-port-metrics.md) | Socket interface performance and traffic analysis | 🔌 |
+| [Socket Port Time Series](./catocli_user_guide/socket-port-timeseries.md) | Socket performance metrics over time | ⏱️ |
+
+### Advanced Topics
+
+- [Common Patterns & Best Practices](./catocli_user_guide/common-patterns.md) - Output formats, time frames, filtering patterns
+- [Python Integration - Windows](./catocli_user_guide/python-integration-windows.md) - Windows-specific Python automation examples
+- [Python Integration - Unix/Linux/macOS](./catocli_user_guide/python-integration-unix.md) - Unix-based Python integration guide
+- [SIEM Integration Guide](./catocli_user_guide/siem-integration.md) - Real-time security event streaming to SIEM platforms
+
+## Quick Start Examples
+
+### Basic Network Health Check
+```bash
+# Get last hour account metrics
+catocli query accountMetrics '{"timeFrame":"last.PT1H"}'
+```
+
+### User Activity Report (csv format)
+```bash
+# Export user activity for the last month to CSV
+catocli query appStats '{
+    "dimension": [{"fieldName": "user_name"}],
+    "measure": [{"aggType": "sum", "fieldName": "flows_created"}],
+    "timeFrame": "last.P1M"
+}' -f csv --csv-filename user_activity_report.csv
+```
+
+### Security Events Analysis
+```bash
+# Weekly security events breakdown
+catocli query eventsTimeSeries '{
+    "buckets": 7,
+    "eventsFilter": [{"fieldName": "event_type", "operator": "is", "values": ["Security"]}],
+    "eventsMeasure": [{"aggType": "sum", "fieldName": "event_count"}],
+    "timeFrame": "last.P7D"
+}'
+```
+
+## Output Formats
+
+CatoCLI supports multiple output formats:
+
+- **Enhanced JSON** (default): Formatted with granularity adjustments
+- **Raw JSON**: Original API response with `-raw` flag
+- **CSV**: Structured data export with `-f csv`
+- **Custom CSV**: Named files with `--csv-filename` and `--append-timestamp`
+
+## Time Frame Options
+
+Common time frame patterns:
+- `last.PT1H` - Last hour
+- `last.P1D` - Last day  
+- `last.P7D` - Last week
+- `last.P1M` - Last month
+- `utc.2023-02-{28/00:00:00--28/23:59:59}` - Custom UTC range
+
+## Getting Help
+
+- Use `-h` or `--help` with any command for detailed usage
+- Check the [Cato API Documentation](https://api.catonetworks.com/documentation/)
+- Review individual operation guides linked above
+
+
+This CLI is a Python 3 application and has been tested with Python 3.6 -> 3.8
+
+## Requirements:
+    python 3.6 or higher
+    
+## Confirm your version of python if installed:
+    Open a terminal
+    Enter: python -V or python3 -V
+
+## Installing the correct version for environment:
+https://www.python.org/downloads/
+
+
+

catocli-3.0.24/README.md

@@ -0,0 +1,150 @@
+# Cato Networks GraphQL API CLI
+
+The package provides a simple to use CLI that reflects industry standards (such as the AWS cli), and enables customers to manage Cato Networks configurations and processes via the [Cato Networks GraphQL API](https://api.catonetworks.com/api/v1/graphql2) easily integrating into configurations management, orchestration or automation frameworks to support the DevOps model.
+
+## Overview
+
+CatoCLI is a command-line interface that provides access to the Cato Networks GraphQL API, enabling you to:
+- Generate detailed network and security reports
+- Analyze user and application activity
+- Monitor network performance and events
+- Export data in multiple formats (JSON, CSV)
+- Automate reporting and monitoring tasks
+
+## Prerequisites
+
+- Python 3.6 or higher
+- CatoCLI installed (`pip3 install catocli`)
+- Valid Cato Networks API token and Account ID
+- Proper authentication configuration (see [Authentication Setup](#authentication-setup))
+
+## Installation  
+
+`pip3 install catocli`
+
+## Authentication Setup
+
+Configure your CatoCLI profile before using any query operations:
+
+```bash
+# Interactive configuration
+catocli configure set
+
+# Non-interactive configuration
+catocli configure set --cato-token "your-api-token" --account-id "12345"
+
+# List configured profiles
+catocli configure list
+
+# Show current profile
+catocli configure show
+```
+
+### Documentation
+
+For detailed information about profile management, see [PROFILES.md](PROFILES.md).
+
+[CLICK HERE](https://support.catonetworks.com/hc/en-us/articles/4413280536081-Generating-API-Keys-for-the-Cato-API) to see how create an API key to authenticate.
+
+## Running the CLI
+	catocli -h
+	catocli query -h
+	catocli query entityLookup -h
+	catocli query entityLookup '{"type":"country"}`
+    
+    // Override the accountID value as a cli argument
+	catocli query entityLookup -accountID=12345 '{"type":"country"}`
+
+## Check out run locally not as pip package
+	git clone git@github.com:Cato-Networks/cato-cli.git
+	cd cato-cli
+	python3 -m catocli -h
+
+## Query Operations
+
+### Core Analytics Queries
+
+| Operation | Description | Guide |
+|-----------|-------------|--------|
+| [Account Metrics](./catocli_user_guide/account-metrics.md) | Network performance metrics by site, user, or interface | 📊 |
+| [Application Statistics](./catocli_user_guide/app-stats.md) | User activity and application usage analysis | 📱 |
+| [Application Time Series](./catocli_user_guide/app-stats-timeseries.md) | Traffic analysis over time with hourly/daily breakdowns | 📈 |
+| [Events Time Series](./catocli_user_guide/events-timeseries.md) | Security events, connectivity, and threat analysis | 🔒 |
+| [Socket Port Metrics](./catocli_user_guide/socket-port-metrics.md) | Socket interface performance and traffic analysis | 🔌 |
+| [Socket Port Time Series](./catocli_user_guide/socket-port-timeseries.md) | Socket performance metrics over time | ⏱️ |
+
+### Advanced Topics
+
+- [Common Patterns & Best Practices](./catocli_user_guide/common-patterns.md) - Output formats, time frames, filtering patterns
+- [Python Integration - Windows](./catocli_user_guide/python-integration-windows.md) - Windows-specific Python automation examples
+- [Python Integration - Unix/Linux/macOS](./catocli_user_guide/python-integration-unix.md) - Unix-based Python integration guide
+- [SIEM Integration Guide](./catocli_user_guide/siem-integration.md) - Real-time security event streaming to SIEM platforms
+
+## Quick Start Examples
+
+### Basic Network Health Check
+```bash
+# Get last hour account metrics
+catocli query accountMetrics '{"timeFrame":"last.PT1H"}'
+```
+
+### User Activity Report (csv format)
+```bash
+# Export user activity for the last month to CSV
+catocli query appStats '{
+    "dimension": [{"fieldName": "user_name"}],
+    "measure": [{"aggType": "sum", "fieldName": "flows_created"}],
+    "timeFrame": "last.P1M"
+}' -f csv --csv-filename user_activity_report.csv
+```
+
+### Security Events Analysis
+```bash
+# Weekly security events breakdown
+catocli query eventsTimeSeries '{
+    "buckets": 7,
+    "eventsFilter": [{"fieldName": "event_type", "operator": "is", "values": ["Security"]}],
+    "eventsMeasure": [{"aggType": "sum", "fieldName": "event_count"}],
+    "timeFrame": "last.P7D"
+}'
+```
+
+## Output Formats
+
+CatoCLI supports multiple output formats:
+
+- **Enhanced JSON** (default): Formatted with granularity adjustments
+- **Raw JSON**: Original API response with `-raw` flag
+- **CSV**: Structured data export with `-f csv`
+- **Custom CSV**: Named files with `--csv-filename` and `--append-timestamp`
+
+## Time Frame Options
+
+Common time frame patterns:
+- `last.PT1H` - Last hour
+- `last.P1D` - Last day  
+- `last.P7D` - Last week
+- `last.P1M` - Last month
+- `utc.2023-02-{28/00:00:00--28/23:59:59}` - Custom UTC range
+
+## Getting Help
+
+- Use `-h` or `--help` with any command for detailed usage
+- Check the [Cato API Documentation](https://api.catonetworks.com/documentation/)
+- Review individual operation guides linked above
+
+
+This CLI is a Python 3 application and has been tested with Python 3.6 -> 3.8
+
+## Requirements:
+    python 3.6 or higher
+    
+## Confirm your version of python if installed:
+    Open a terminal
+    Enter: python -V or python3 -V
+
+## Installing the correct version for environment:
+https://www.python.org/downloads/
+
+
+

{catocli-3.0.18 → catocli-3.0.24}/catocli/Utils/clidriver.py

@@ -48,22 +48,22 @@ from ..parsers.query_enterpriseDirectory import query_enterpriseDirectory_parse
 from ..parsers.query_devices import query_devices_parse
 from ..parsers.query_accountSnapshot import query_accountSnapshot_parse
 from ..parsers.query_catalogs import query_catalogs_parse
-from ..parsers.query_xdr import query_xdr_parse
 from ..parsers.query_site import query_site_parse
+from ..parsers.query_xdr import query_xdr_parse
 from ..parsers.query_groups import query_groups_parse
 from ..parsers.query_policy import query_policy_parse
 from ..parsers.mutation_xdr import mutation_xdr_parse
 from ..parsers.mutation_policy import mutation_policy_parse
 from ..parsers.mutation_site import mutation_site_parse
-from ..parsers.mutation_sites import mutation_sites_parse
 from ..parsers.mutation_container import mutation_container_parse
+from ..parsers.mutation_sites import mutation_sites_parse
+from ..parsers.mutation_admin import mutation_admin_parse
 from ..parsers.mutation_accountManagement import mutation_accountManagement_parse
 from ..parsers.mutation_sandbox import mutation_sandbox_parse
 from ..parsers.mutation_licensing import mutation_licensing_parse
 from ..parsers.mutation_hardware import mutation_hardware_parse
 from ..parsers.mutation_groups import mutation_groups_parse
 from ..parsers.mutation_enterpriseDirectory import mutation_enterpriseDirectory_parse
-from ..parsers.mutation_admin import mutation_admin_parse
 
 def show_version_info(args, configuration=None):
     print(f"catocli version {catocli.__version__}")
@@ -183,22 +183,22 @@ query_enterpriseDirectory_parser = query_enterpriseDirectory_parse(query_subpars
 query_devices_parser = query_devices_parse(query_subparsers)
 query_accountSnapshot_parser = query_accountSnapshot_parse(query_subparsers)
 query_catalogs_parser = query_catalogs_parse(query_subparsers)
-query_xdr_parser = query_xdr_parse(query_subparsers)
 query_site_parser = query_site_parse(query_subparsers)
+query_xdr_parser = query_xdr_parse(query_subparsers)
 query_groups_parser = query_groups_parse(query_subparsers)
 query_policy_parser = query_policy_parse(query_subparsers)
 mutation_xdr_parser = mutation_xdr_parse(mutation_subparsers)
 mutation_policy_parser = mutation_policy_parse(mutation_subparsers)
 mutation_site_parser = mutation_site_parse(mutation_subparsers)
-mutation_sites_parser = mutation_sites_parse(mutation_subparsers)
 mutation_container_parser = mutation_container_parse(mutation_subparsers)
+mutation_sites_parser = mutation_sites_parse(mutation_subparsers)
+mutation_admin_parser = mutation_admin_parse(mutation_subparsers)
 mutation_accountManagement_parser = mutation_accountManagement_parse(mutation_subparsers)
 mutation_sandbox_parser = mutation_sandbox_parse(mutation_subparsers)
 mutation_licensing_parser = mutation_licensing_parse(mutation_subparsers)
 mutation_hardware_parser = mutation_hardware_parse(mutation_subparsers)
 mutation_groups_parser = mutation_groups_parse(mutation_subparsers)
 mutation_enterpriseDirectory_parser = mutation_enterpriseDirectory_parse(mutation_subparsers)
-mutation_admin_parser = mutation_admin_parse(mutation_subparsers)
 
 
 def parse_headers(header_strings):
@@ -287,8 +287,16 @@ def main(args=None):
                     # Print CSV output directly without JSON formatting
                     print(response[0]["__csv_output__"], end='')
                 else:
-                    # Standard JSON output
-                    print(json.dumps(response[0], sort_keys=True, indent=4))
+                    # Handle different response formats more robustly
+                    if isinstance(response, list) and len(response) > 0:
+                        # Standard format: [data, status, headers]
+                        print(json.dumps(response[0], sort_keys=True, indent=4))
+                    elif isinstance(response, dict):
+                        # Direct dict response
+                        print(json.dumps(response, sort_keys=True, indent=4))
+                    else:
+                        # Fallback: print as-is
+                        print(json.dumps(response, sort_keys=True, indent=4))
     except KeyboardInterrupt:
         print('Operation cancelled by user (Ctrl+C).')
         exit(130)  # Standard exit code for SIGINT