catocli 1.0.12__py3-none-any.whl → 1.0.13__py3-none-any.whl

build/lib/catocli/Utils/clidriver.py

@@ -0,0 +1,117 @@
+
+import os
+import argparse
+import json
+import catocli
+from graphql_client import Configuration
+from graphql_client.api_client import ApiException
+from ..parsers.parserApiClient import get_help
+import sys
+sys.path.insert(0, 'vendor')
+import urllib3
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+if "CATO_TOKEN" not in os.environ:
+	print("Missing authentication, please set the CATO_TOKEN environment variable with your api key.")
+	exit()
+CATO_TOKEN = os.getenv("CATO_TOKEN")
+CATO_DEBUG = bool(os.getenv("CATO_DEBUG", False))
+from ..parsers.raw import raw_parse
+from ..parsers.custom import custom_parse
+from ..parsers.query_siteLocation import query_siteLocation_parse
+from ..parsers.mutation_admin import mutation_admin_parse
+from ..parsers.mutation_container import mutation_container_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.query_accountBySubdomain import query_accountBySubdomain_parse
+from ..parsers.query_accountMetrics import query_accountMetrics_parse
+from ..parsers.query_accountRoles import query_accountRoles_parse
+from ..parsers.query_accountSnapshot import query_accountSnapshot_parse
+from ..parsers.query_admin import query_admin_parse
+from ..parsers.query_admins import query_admins_parse
+from ..parsers.query_appStats import query_appStats_parse
+from ..parsers.query_appStatsTimeSeries import query_appStatsTimeSeries_parse
+from ..parsers.query_auditFeed import query_auditFeed_parse
+from ..parsers.query_container import query_container_parse
+from ..parsers.query_entityLookup import query_entityLookup_parse
+from ..parsers.query_events import query_events_parse
+from ..parsers.query_eventsFeed import query_eventsFeed_parse
+from ..parsers.query_eventsTimeSeries import query_eventsTimeSeries_parse
+from ..parsers.query_hardwareManagement import query_hardwareManagement_parse
+from ..parsers.query_licensing import query_licensing_parse
+from ..parsers.query_policy import query_policy_parse
+from ..parsers.query_subDomains import query_subDomains_parse
+from ..parsers.query_xdr import query_xdr_parse
+
+configuration = Configuration()
+configuration.verify_ssl = False
+configuration.api_key["x-api-key"] = CATO_TOKEN
+configuration.host = "{}".format(catocli.__cato_host__)
+configuration.debug = CATO_DEBUG
+configuration.version = "{}".format(catocli.__version__)
+
+parser = argparse.ArgumentParser(prog='catocli', usage='%(prog)s <operationType> <operationName> [options]', description="CLI for query on CATO via API.")
+parser.add_argument('--version', action='version', version=catocli.__version__)
+subparsers = parser.add_subparsers()
+custom_parsers = custom_parse(subparsers)
+raw_parsers = subparsers.add_parser('raw', help='Raw GraphQL', usage=get_help("raw"))
+raw_parser = raw_parse(raw_parsers)
+query_parser = subparsers.add_parser('query', help='Query', usage='catocli query <operationName> [options]')
+query_subparsers = query_parser.add_subparsers(description='valid subcommands', help='additional help')
+query_siteLocation_parser = query_siteLocation_parse(query_subparsers)
+mutation_parser = subparsers.add_parser('mutation', help='Mutation', usage='catocli mutation <operationName> [options]')
+mutation_subparsers = mutation_parser.add_subparsers(description='valid subcommands', help='additional help')
+
+mutation_admin_parser = mutation_admin_parse(mutation_subparsers)
+mutation_container_parser = mutation_container_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)
+query_accountBySubdomain_parser = query_accountBySubdomain_parse(query_subparsers)
+query_accountMetrics_parser = query_accountMetrics_parse(query_subparsers)
+query_accountRoles_parser = query_accountRoles_parse(query_subparsers)
+query_accountSnapshot_parser = query_accountSnapshot_parse(query_subparsers)
+query_admin_parser = query_admin_parse(query_subparsers)
+query_admins_parser = query_admins_parse(query_subparsers)
+query_appStats_parser = query_appStats_parse(query_subparsers)
+query_appStatsTimeSeries_parser = query_appStatsTimeSeries_parse(query_subparsers)
+query_auditFeed_parser = query_auditFeed_parse(query_subparsers)
+query_container_parser = query_container_parse(query_subparsers)
+query_entityLookup_parser = query_entityLookup_parse(query_subparsers)
+query_events_parser = query_events_parse(query_subparsers)
+query_eventsFeed_parser = query_eventsFeed_parse(query_subparsers)
+query_eventsTimeSeries_parser = query_eventsTimeSeries_parse(query_subparsers)
+query_hardwareManagement_parser = query_hardwareManagement_parse(query_subparsers)
+query_licensing_parser = query_licensing_parse(query_subparsers)
+query_policy_parser = query_policy_parse(query_subparsers)
+query_subDomains_parser = query_subDomains_parse(query_subparsers)
+query_xdr_parser = query_xdr_parse(query_subparsers)
+
+
+def main(args=None):
+	args = parser.parse_args(args=args)
+	try:
+		CATO_ACCOUNT_ID = os.getenv("CATO_ACCOUNT_ID")
+		if args.func.__name__!="createRawRequest":
+			if CATO_ACCOUNT_ID==None and args.accountID==None:
+				print("Missing accountID, please specify an accountID:\n")
+				print('Option 1: Set the CATO_ACCOUNT_ID environment variable with the value of your account ID.')
+				print('export CATO_ACCOUNT_ID="12345"\n')
+				print("Option 2: Override the accountID value as a cli argument, example:")
+				print('catocli <operationType> <operationName> -accountID=12345 <json>')
+				print("catocli query entityLookup -accountID=12345 '{\"type\":\"country\"}'\n")
+				exit()
+			elif args.accountID!=None:
+				configuration.accountID = args.accountID
+			else:
+				configuration.accountID = CATO_ACCOUNT_ID
+		response = args.func(args, configuration)
+
+		if type(response) == ApiException:
+			print("ERROR! Status code: {}".format(response.status))
+			print(response)
+		else:
+			if response!=None:
+				print(json.dumps(response[0], sort_keys=True, indent=4))
+	except AttributeError:
+		print('Missing arguments. Usage: catocli <operation> -h')

build/lib/catocli/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.13"
+__cato_host__ = "https://api.catonetworks.com/api/v1/graphql2"

build/lib/catocli/__main__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+import sys
+from .Utils import clidriver
+
+def main():
+	if sys.argv.__len__() == 1:
+		print('Usage: catocli -h')
+	else:
+		sys.exit(clidriver.main(sys.argv[1:]))
+
+if __name__ == '__main__':
+	main()

build/lib/catocli/parsers/custom/__init__.py

@@ -0,0 +1,47 @@
+
+import catocli.parsers.custom.customLib as customLib
+
+def custom_parse(subparsers):
+	entityTypes = ["account","admin","allocatedIP","any","availablePooledUsage","availableSiteUsage","dhcpRelayGroup","groupSubscription","host","lanFirewall","localRouting","location","mailingListSubscription","networkInterface","portProtocol","simpleService","site","siteRange","timezone","vpnUser","webhookSubscription"]
+	entity_parser = subparsers.add_parser('entity', help='Entity Lookup', usage='catocli entity <operationName> [options]')
+	entity_subparsers = entity_parser.add_subparsers(description='valid subcommands', help='additional help')
+
+	for entity in entityTypes:
+		item_parser = entity_subparsers.add_parser(entity, help="entityLookup() for type: "+entity, usage='catocli entity '+entity+' <operationName> [options]')
+		item_subparsers = item_parser.add_subparsers(description='valid subcommands', help='additional help')
+
+		item_list_parser = item_subparsers.add_parser('list', 
+				help='entity '+entity+' list', 
+				usage=get_help_custom("entity_"+entity+"_list"))
+
+		item_list_parser.add_argument('-accountID', help='The Account ID.')
+		item_list_parser.add_argument('-s', help='Search string', default='', nargs='?')
+		item_list_parser.add_argument('-f', default="csv", choices=["json","csv"], nargs='?', 
+			help='Specify format for output')
+		item_list_parser.add_argument('-t', const=True, default=False, nargs='?', 
+			help='Print test request preview without sending api call')
+		item_list_parser.add_argument('-v', const=True, default=False, nargs='?', 
+			help='Verbose output')
+		item_list_parser.add_argument('-p', const=True, default=False, nargs='?', 
+			help='Pretty print')
+		
+		item_list_parser.set_defaults(func=customLib.entityTypeList,operation_name=entity)
+
+def get_help_custom(path):
+	matchCmd = "catocli "+path.replace("_"," ")
+	import os
+	pwd = os.path.dirname(__file__)
+	# doc = path+"/README.md"
+	abs_path = os.path.join(pwd, "README.md")
+	new_line = "\nEXAMPLES:\n"
+	lines = open(abs_path, "r").readlines()
+	for line in lines:
+		if f"{matchCmd}" in line:
+			clean_line = line.replace("<br /><br />", "").replace("`","")
+			new_line += f"{clean_line}\n"
+	# matchArg = path.replace("_",".")
+	# for line in lines:
+	# 	if f"`{matchArg}" in line:
+	# 		clean_line = line.replace("<br /><br />", "").replace("`","")
+	# 		new_line += f"{clean_line}\n"
+	return new_line

build/lib/catocli/parsers/custom/customLib.py

@@ -0,0 +1,70 @@
+import json
+from graphql_client.api.call_api import ApiClient, CallApi
+from graphql_client.api_client import ApiException
+import logging
+from ..parserApiClient import validateArgs
+
+def entityTypeList(args, configuration):
+    params = vars(args)
+    operation = { 
+        "operationArgs": {
+            "accountID": {
+                "name": "accountID",
+                "required": True,
+            }
+        }
+    }
+    variablesObj = { "accountID": (params.get("accountID") if params.get("accountID") else params.get("accountId"))}
+
+    instance = CallApi(ApiClient(configuration))
+    operationName = params["operation_name"]
+    query = '''query entityLookup ( $type:EntityType! $accountID:ID! $search:String ) {
+        entityLookup ( accountID:$accountID type:$type search:$search ) {
+            '''+params["operation_name"]+'''s: items {
+                description
+                '''+params["operation_name"]+''': entity {
+                    id
+                    name
+                    type
+                }
+            }
+        }
+    }'''
+    body = {
+        "query": query,
+        "operationName": "entityLookup",
+        "variables": {
+            "accountID": configuration.accountID,
+            "type": params["operation_name"],
+            "search": (params.get("s") if params.get("s")!=None else "")
+        }
+    }
+    
+    isOk, invalidVars, message = validateArgs(variablesObj,operation)
+    if isOk==True:        
+        if params["t"]==True:
+            if params["p"]==True:
+                print(json.dumps(body,indent=2,sort_keys=True).replace("\\n", "\n").replace("\\t", "  "))
+            else:
+                print(json.dumps(body).replace("\\n", " ").replace("\\t", " ").replace("    "," ").replace("  "," "))
+            return None
+        else:
+            try:
+                response = instance.call_api(body,params)
+                if params["f"]=="json":
+                    if params["p"]==True:
+                        print(json.dumps(response[0].get("data").get("entityLookup").get(params["operation_name"]+"s"),indent=2,sort_keys=True).replace("\\n", "\n").replace("\\t", "  "))
+                    else:
+                        print(json.dumps(response[0].get("data").get("entityLookup").get(params["operation_name"]+"s")))
+                else:
+                    if len(response[0].get("data").get("entityLookup").get(params["operation_name"]+"s"))==0:
+                        print("No results found")
+                    else:
+                        print("id,name,type,description")
+                        for site in response[0].get("data").get("entityLookup").get(params["operation_name"]+"s"):
+                            print(site.get(params["operation_name"]).get('id')+","+site.get(params["operation_name"]).get('name')+","+site.get(params["operation_name"]).get('type')+","+site.get('description'))
+            except ApiException as e:
+                return e
+    else:
+        print("ERROR: "+message,", ".join(invalidVars))
+

build/lib/catocli/parsers/mutation_admin/__init__.py

@@ -0,0 +1,51 @@
+
+from ..parserApiClient import createRequest, get_help
+
+def mutation_admin_parse(mutation_subparsers):
+	mutation_admin_parser = mutation_subparsers.add_parser('admin', 
+			help='admin() mutation operation', 
+			usage=get_help("mutation_admin"))
+
+	mutation_admin_subparsers = mutation_admin_parser.add_subparsers()
+
+	mutation_admin_addAdmin_parser = mutation_admin_subparsers.add_parser('addAdmin', 
+			help='addAdmin() admin operation', 
+			usage=get_help("mutation_admin_addAdmin"))
+
+	mutation_admin_addAdmin_parser.add_argument('json', help='Variables in JSON format.')
+	mutation_admin_addAdmin_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
+	mutation_admin_addAdmin_parser.add_argument('-t', const=True, default=False, nargs='?', 
+		help='Print test request preview without sending api call')
+	mutation_admin_addAdmin_parser.add_argument('-v', const=True, default=False, nargs='?', 
+		help='Verbose output')
+	mutation_admin_addAdmin_parser.add_argument('-p', const=True, default=False, nargs='?', 
+		help='Pretty print')
+	mutation_admin_addAdmin_parser.set_defaults(func=createRequest,operation_name='mutation.admin.addAdmin')
+
+	mutation_admin_removeAdmin_parser = mutation_admin_subparsers.add_parser('removeAdmin', 
+			help='removeAdmin() admin operation', 
+			usage=get_help("mutation_admin_removeAdmin"))
+
+	mutation_admin_removeAdmin_parser.add_argument('json', help='Variables in JSON format.')
+	mutation_admin_removeAdmin_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
+	mutation_admin_removeAdmin_parser.add_argument('-t', const=True, default=False, nargs='?', 
+		help='Print test request preview without sending api call')
+	mutation_admin_removeAdmin_parser.add_argument('-v', const=True, default=False, nargs='?', 
+		help='Verbose output')
+	mutation_admin_removeAdmin_parser.add_argument('-p', const=True, default=False, nargs='?', 
+		help='Pretty print')
+	mutation_admin_removeAdmin_parser.set_defaults(func=createRequest,operation_name='mutation.admin.removeAdmin')
+
+	mutation_admin_updateAdmin_parser = mutation_admin_subparsers.add_parser('updateAdmin', 
+			help='updateAdmin() admin operation', 
+			usage=get_help("mutation_admin_updateAdmin"))
+
+	mutation_admin_updateAdmin_parser.add_argument('json', help='Variables in JSON format.')
+	mutation_admin_updateAdmin_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
+	mutation_admin_updateAdmin_parser.add_argument('-t', const=True, default=False, nargs='?', 
+		help='Print test request preview without sending api call')
+	mutation_admin_updateAdmin_parser.add_argument('-v', const=True, default=False, nargs='?', 
+		help='Verbose output')
+	mutation_admin_updateAdmin_parser.add_argument('-p', const=True, default=False, nargs='?', 
+		help='Pretty print')
+	mutation_admin_updateAdmin_parser.set_defaults(func=createRequest,operation_name='mutation.admin.updateAdmin')

build/lib/catocli/parsers/mutation_container/__init__.py

@@ -0,0 +1,23 @@
+
+from ..parserApiClient import createRequest, get_help
+
+def mutation_container_parse(mutation_subparsers):
+	mutation_container_parser = mutation_subparsers.add_parser('container', 
+			help='container() mutation operation', 
+			usage=get_help("mutation_container"))
+
+	mutation_container_subparsers = mutation_container_parser.add_subparsers()
+
+	mutation_container_delete_parser = mutation_container_subparsers.add_parser('delete', 
+			help='delete() container operation', 
+			usage=get_help("mutation_container_delete"))
+
+	mutation_container_delete_parser.add_argument('json', help='Variables in JSON format.')
+	mutation_container_delete_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
+	mutation_container_delete_parser.add_argument('-t', const=True, default=False, nargs='?', 
+		help='Print test request preview without sending api call')
+	mutation_container_delete_parser.add_argument('-v', const=True, default=False, nargs='?', 
+		help='Verbose output')
+	mutation_container_delete_parser.add_argument('-p', const=True, default=False, nargs='?', 
+		help='Pretty print')
+	mutation_container_delete_parser.set_defaults(func=createRequest,operation_name='mutation.container.delete')