catocli 2.1.1__py3-none-any.whl → 2.1.3__py3-none-any.whl

catocli/parsers/query_accountBySubdomain/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_accountBySubdomain_parse(query_subparsers):
-	query_accountBySubdomain_parser = query_subparsers.add_parser('accountBySubdomain', 
-			help='accountBySubdomain() query operation', 
-			usage=get_help("query_accountBySubdomain"))
+    query_accountBySubdomain_parser = query_subparsers.add_parser('accountBySubdomain', 
+            help='accountBySubdomain() query operation', 
+            usage=get_help("query_accountBySubdomain"))
 
-	query_accountBySubdomain_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_accountBySubdomain_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_accountBySubdomain_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_accountBySubdomain_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_accountBySubdomain_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_accountBySubdomain_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_accountBySubdomain_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_accountBySubdomain_parser.set_defaults(func=createRequest,operation_name='query.accountBySubdomain')
+    query_accountBySubdomain_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_accountBySubdomain_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_accountBySubdomain_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_accountBySubdomain_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_accountBySubdomain_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_accountBySubdomain_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_accountBySubdomain_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_accountBySubdomain_parser.set_defaults(func=createRequest,operation_name='query.accountBySubdomain')

catocli/parsers/query_accountManagement/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.accountManagement:
-[Click here](https://api.catonetworks.com/documentation/#query-accountManagement) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.accountManagement) for documentation on this operation.
 
 ### Usage for query.accountManagement:
 
@@ -8,9 +8,8 @@
 
 `catocli query accountManagement <json>`
 
-`catocli query accountManagement "$(cat < accountManagement.json)"`
-
-`catocli query accountManagement '{}'`
+`catocli query accountManagement "$(cat < query.accountManagement.json)"`
 
 #### Operation Arguments for query.accountManagement ####
-`accountId` [ID] - (required) N/A 
+
+`accountId` [ID] - (required) N/A    

catocli/parsers/query_accountManagement/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_accountManagement_parse(query_subparsers):
-	query_accountManagement_parser = query_subparsers.add_parser('accountManagement', 
-			help='accountManagement() query operation', 
-			usage=get_help("query_accountManagement"))
+    query_accountManagement_parser = query_subparsers.add_parser('accountManagement', 
+            help='accountManagement() query operation', 
+            usage=get_help("query_accountManagement"))
 
-	query_accountManagement_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_accountManagement_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_accountManagement_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_accountManagement_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_accountManagement_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_accountManagement_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_accountManagement_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_accountManagement_parser.set_defaults(func=createRequest,operation_name='query.accountManagement')
+    query_accountManagement_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_accountManagement_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_accountManagement_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_accountManagement_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_accountManagement_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_accountManagement_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_accountManagement_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_accountManagement_parser.set_defaults(func=createRequest,operation_name='query.accountManagement')

catocli/parsers/query_accountMetrics/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.accountMetrics:
-[Click here](https://api.catonetworks.com/documentation/#query-accountMetrics) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.accountMetrics) for documentation on this operation.
 
 ### Usage for query.accountMetrics:
 
@@ -8,26 +8,28 @@
 
 `catocli query accountMetrics <json>`
 
-`catocli query accountMetrics "$(cat < accountMetrics.json)"`
+`catocli query accountMetrics "$(cat < query.accountMetrics.json)"`
+
+`catocli query accountMetrics '{"buckets":1,"groupDevices":true,"groupInterfaces":true,"labels":"bytesUpstream","perSecond":true,"siteIDs":["id1","id2"],"timeFrame":"example_value","toRate":true,"types":["string1","string2"],"useDefaultSizeBucket":true,"userIDs":["id1","id2"],"withMissingData":true}'`
 
-`catocli query accountMetrics '{"buckets": "Int", "groupDevices": "Boolean", "groupInterfaces": "Boolean", "labels": "enum(TimeseriesMetricType)", "perSecond": "Boolean", "siteIDs": ["ID"], "timeFrame": "TimeFrame", "toRate": "Boolean", "types": ["String"], "useDefaultSizeBucket": "Boolean", "userIDs": ["ID"], "withMissingData": "Boolean"}'`
 
 #### Operation Arguments for query.accountMetrics ####
-`accountID` [ID] - (optional) Unique Identifier of Account. 
-`buckets` [Int] - (optional) number of buckets, defaults to 10, max 1000 
-`groupDevices` [Boolean] - (optional) When the boolean argument groupDevices is set to __true__, then the analytics for all the
+
+`accountID` [ID] - (required) Unique Identifier of Account.    
+`buckets` [Int] - (required) number of buckets, defaults to 10, max 1000    
+`groupDevices` [Boolean] - (required) When the boolean argument groupDevices is set to __true__, then the analytics for all the
 Sockets (usually two in high availability) are aggregated as one result.
 
 For the best results for aggregated Sockets, we recommend that there is consistent
-names and functionality (for example Destination) for the links on both Sockets. 
-`groupInterfaces` [Boolean] - (optional) When the boolean argument groupInterfaces is set to __true__, then the data for all the
-interfaces are aggregated to a single interface. 
-`labels` [TimeseriesMetricType[]] - (optional) N/A Default Value: ['bytesUpstream', 'bytesDownstream', 'bytesUpstreamMax', 'bytesDownstreamMax', 'packetsUpstream', 'packetsDownstream', 'lostUpstream', 'lostDownstream', 'lostUpstreamPcnt', 'lostDownstreamPcnt', 'packetsDiscardedDownstream', 'packetsDiscardedUpstream', 'packetsDiscardedUpstreamPcnt', 'packetsDiscardedDownstreamPcnt', 'jitterUpstream', 'jitterDownstream', 'bytesTotal', 'rtt', 'health', 'tunnelAge', 'lastMilePacketLoss', 'lastMileLatency']
-`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
-`siteIDs` [ID[]] - (optional) A list of unique IDs for each site. If specified, only sites in this list are returned. Otherwise, all sites are returned. 
-`timeFrame` [TimeFrame] - (required) The time frame for the data that the query returns. The argument is in the format type.time value. This argument is mandatory. 
-`toRate` [Boolean] - (optional) Normalize collected metrics as per-second values 
-`types` [String[]] - (optional) N/A 
-`useDefaultSizeBucket` [Boolean] - (optional) In case we want to have the default size bucket (from properties) 
-`userIDs` [ID[]] - (optional) A list of unique IDs for each user. If specified, only users in this list are returned. Otherwise, no user metrics are returned. 
-`withMissingData` [Boolean] - (optional) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1 
+names and functionality (for example Destination) for the links on both Sockets.    
+`groupInterfaces` [Boolean] - (required) When the boolean argument groupInterfaces is set to __true__, then the data for all the
+interfaces are aggregated to a single interface.    
+`labels` [TimeseriesMetricType[]] - (required) N/A Default Value: ['bytesUpstream', 'bytesDownstream', 'bytesUpstreamMax', 'bytesDownstreamMax', 'packetsUpstream', 'packetsDownstream', 'lostUpstream', 'lostDownstream', 'lostUpstreamPcnt', 'lostDownstreamPcnt', 'packetsDiscardedDownstream', 'packetsDiscardedUpstream', 'packetsDiscardedUpstreamPcnt', 'packetsDiscardedDownstreamPcnt', 'jitterUpstream', 'jitterDownstream', 'bytesTotal', 'rtt', 'health', 'tunnelAge', 'lastMilePacketLoss', 'lastMileLatency']   
+`perSecond` [Boolean] - (required) whether to normalize the data into per second (i.e. divide by granularity)    
+`siteIDs` [ID[]] - (required) A list of unique IDs for each site. If specified, only sites in this list are returned. Otherwise, all sites are returned.    
+`timeFrame` [TimeFrame] - (required) The time frame for the data that the query returns. The argument is in the format type.time value. This argument is mandatory.    
+`toRate` [Boolean] - (required) Normalize collected metrics as per-second values    
+`types` [String[]] - (required) N/A    
+`useDefaultSizeBucket` [Boolean] - (required) In case we want to have the default size bucket (from properties)    
+`userIDs` [ID[]] - (required) A list of unique IDs for each user. If specified, only users in this list are returned. Otherwise, no user metrics are returned.    
+`withMissingData` [Boolean] - (required) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1    

catocli/parsers/query_accountMetrics/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_accountMetrics_parse(query_subparsers):
-	query_accountMetrics_parser = query_subparsers.add_parser('accountMetrics', 
-			help='accountMetrics() query operation', 
-			usage=get_help("query_accountMetrics"))
+    query_accountMetrics_parser = query_subparsers.add_parser('accountMetrics', 
+            help='accountMetrics() query operation', 
+            usage=get_help("query_accountMetrics"))
 
-	query_accountMetrics_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_accountMetrics_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_accountMetrics_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_accountMetrics_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_accountMetrics_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_accountMetrics_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_accountMetrics_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_accountMetrics_parser.set_defaults(func=createRequest,operation_name='query.accountMetrics')
+    query_accountMetrics_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_accountMetrics_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_accountMetrics_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_accountMetrics_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_accountMetrics_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_accountMetrics_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_accountMetrics_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_accountMetrics_parser.set_defaults(func=createRequest,operation_name='query.accountMetrics')

catocli/parsers/query_accountRoles/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.accountRoles:
-[Click here](https://api.catonetworks.com/documentation/#query-accountRoles) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.accountRoles) for documentation on this operation.
 
 ### Usage for query.accountRoles:
 
@@ -8,10 +8,12 @@
 
 `catocli query accountRoles <json>`
 
-`catocli query accountRoles "$(cat < accountRoles.json)"`
+`catocli query accountRoles "$(cat < query.accountRoles.json)"`
+
+`catocli query accountRoles '{"accountType":"SYSTEM"}'`
 
-`catocli query accountRoles '{"accountType": "enum(AccountType)"}'`
 
 #### Operation Arguments for query.accountRoles ####
-`accountID` [ID] - (required) N/A 
-`accountType` [AccountType] - (optional) N/A Default Value: ['SYSTEM', 'REGULAR', 'RESELLER', 'ALL']
+
+`accountID` [ID] - (required) N/A    
+`accountType` [AccountType] - (required) N/A Default Value: ['SYSTEM', 'REGULAR', 'RESELLER', 'ALL']   

catocli/parsers/query_accountRoles/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_accountRoles_parse(query_subparsers):
-	query_accountRoles_parser = query_subparsers.add_parser('accountRoles', 
-			help='accountRoles() query operation', 
-			usage=get_help("query_accountRoles"))
+    query_accountRoles_parser = query_subparsers.add_parser('accountRoles', 
+            help='accountRoles() query operation', 
+            usage=get_help("query_accountRoles"))
 
-	query_accountRoles_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_accountRoles_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_accountRoles_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_accountRoles_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_accountRoles_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_accountRoles_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_accountRoles_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_accountRoles_parser.set_defaults(func=createRequest,operation_name='query.accountRoles')
+    query_accountRoles_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_accountRoles_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_accountRoles_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_accountRoles_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_accountRoles_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_accountRoles_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_accountRoles_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_accountRoles_parser.set_defaults(func=createRequest,operation_name='query.accountRoles')

catocli/parsers/query_accountSnapshot/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.accountSnapshot:
-[Click here](https://api.catonetworks.com/documentation/#query-accountSnapshot) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.accountSnapshot) for documentation on this operation.
 
 ### Usage for query.accountSnapshot:
 
@@ -8,11 +8,13 @@
 
 `catocli query accountSnapshot <json>`
 
-`catocli query accountSnapshot "$(cat < accountSnapshot.json)"`
+`catocli query accountSnapshot "$(cat < query.accountSnapshot.json)"`
+
+`catocli query accountSnapshot '{"siteIDs":["id1","id2"],"userIDs":["id1","id2"]}'`
 
-`catocli query accountSnapshot '{"siteIDs": ["ID"], "userIDs": ["ID"]}'`
 
 #### Operation Arguments for query.accountSnapshot ####
-`accountID` [ID] - (optional) Unique Identifier of Account. 
-`siteIDs` [ID[]] - (optional) List of Unique Site Identifiers. If specified, only sites in list will be returned 
-`userIDs` [ID[]] - (optional) request specific IDs, regardless of if connected or not 
+
+`accountID` [ID] - (required) Unique Identifier of Account.    
+`siteIDs` [ID[]] - (required) List of Unique Site Identifiers. If specified, only sites in list will be returned    
+`userIDs` [ID[]] - (required) request specific IDs, regardless of if connected or not    

catocli/parsers/query_accountSnapshot/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_accountSnapshot_parse(query_subparsers):
-	query_accountSnapshot_parser = query_subparsers.add_parser('accountSnapshot', 
-			help='accountSnapshot() query operation', 
-			usage=get_help("query_accountSnapshot"))
+    query_accountSnapshot_parser = query_subparsers.add_parser('accountSnapshot', 
+            help='accountSnapshot() query operation', 
+            usage=get_help("query_accountSnapshot"))
 
-	query_accountSnapshot_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_accountSnapshot_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_accountSnapshot_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_accountSnapshot_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_accountSnapshot_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_accountSnapshot_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_accountSnapshot_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_accountSnapshot_parser.set_defaults(func=createRequest,operation_name='query.accountSnapshot')
+    query_accountSnapshot_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_accountSnapshot_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_accountSnapshot_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_accountSnapshot_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_accountSnapshot_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_accountSnapshot_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_accountSnapshot_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_accountSnapshot_parser.set_defaults(func=createRequest,operation_name='query.accountSnapshot')

catocli/parsers/query_admin/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.admin:
-[Click here](https://api.catonetworks.com/documentation/#query-admin) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.admin) for documentation on this operation.
 
 ### Usage for query.admin:
 
@@ -8,10 +8,12 @@
 
 `catocli query admin <json>`
 
-`catocli query admin "$(cat < admin.json)"`
+`catocli query admin "$(cat < query.admin.json)"`
+
+`catocli query admin '{"adminID":"id"}'`
 
-`catocli query admin '{"adminID": "ID"}'`
 
 #### Operation Arguments for query.admin ####
-`accountId` [ID] - (required) N/A 
-`adminID` [ID] - (required) N/A 
+
+`accountId` [ID] - (required) N/A    
+`adminID` [ID] - (required) N/A    

catocli/parsers/query_admin/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_admin_parse(query_subparsers):
-	query_admin_parser = query_subparsers.add_parser('admin', 
-			help='admin() query operation', 
-			usage=get_help("query_admin"))
+    query_admin_parser = query_subparsers.add_parser('admin', 
+            help='admin() query operation', 
+            usage=get_help("query_admin"))
 
-	query_admin_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_admin_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_admin_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_admin_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_admin_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_admin_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_admin_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_admin_parser.set_defaults(func=createRequest,operation_name='query.admin')
+    query_admin_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_admin_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_admin_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_admin_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_admin_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_admin_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_admin_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_admin_parser.set_defaults(func=createRequest,operation_name='query.admin')

catocli/parsers/query_admins/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.admins:
-[Click here](https://api.catonetworks.com/documentation/#query-admins) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.admins) for documentation on this operation.
 
 ### Usage for query.admins:
 
@@ -8,14 +8,16 @@
 
 `catocli query admins <json>`
 
-`catocli query admins "$(cat < admins.json)"`
+`catocli query admins "$(cat < query.admins.json)"`
+
+`catocli query admins '{"adminIDs":["id1","id2"],"from":1,"limit":1,"search":"string","sortInput":{"field":"string","order":"asc"}}'`
 
-`catocli query admins '{"adminIDs": ["ID"], "from": "Int", "limit": "Int", "search": "String", "sortInput": {"field": {"field": "String"}, "order": {"order": "enum(DirectionInput)"}}}'`
 
 #### Operation Arguments for query.admins ####
-`accountID` [ID] - (required) N/A 
-`adminIDs` [ID[]] - (optional) N/A 
-`from` [Int] - (optional) N/A 
-`limit` [Int] - (optional) N/A 
-`search` [String] - (optional) N/A 
-`sortInput` [SortInput[]] - (optional) N/A 
+
+`accountID` [ID] - (required) N/A    
+`adminIDs` [ID[]] - (required) N/A    
+`from` [Int] - (required) N/A    
+`limit` [Int] - (required) N/A    
+`search` [String] - (required) N/A    
+`sortInput` [SortInput[]] - (required) N/A    

catocli/parsers/query_admins/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_admins_parse(query_subparsers):
-	query_admins_parser = query_subparsers.add_parser('admins', 
-			help='admins() query operation', 
-			usage=get_help("query_admins"))
+    query_admins_parser = query_subparsers.add_parser('admins', 
+            help='admins() query operation', 
+            usage=get_help("query_admins"))
 
-	query_admins_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_admins_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_admins_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_admins_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_admins_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_admins_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_admins_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_admins_parser.set_defaults(func=createRequest,operation_name='query.admins')
+    query_admins_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_admins_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_admins_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_admins_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_admins_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_admins_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_admins_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_admins_parser.set_defaults(func=createRequest,operation_name='query.admins')

catocli/parsers/query_appStats/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.appStats:
-[Click here](https://api.catonetworks.com/documentation/#query-appStats) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.appStats) for documentation on this operation.
 
 ### Usage for query.appStats:
 
@@ -8,16 +8,25 @@
 
 `catocli query appStats <json>`
 
-`catocli query appStats "$(cat < appStats.json)"`
+`catocli query appStats "$(cat < query.appStats.json)"`
+
+`catocli query appStats '{"appStatsFilter":{"fieldName":"ad_name","operator":"is","values":["string1","string2"]},"appStatsSort":{"fieldName":"ad_name","order":"asc"},"dimension":{"fieldName":"ad_name"},"from":1,"limit":1,"measure":{"aggType":"sum","fieldName":"ad_name","trend":true},"timeFrame":"example_value"}'`
+
+
+## Advanced Usage
+# Query to export flows_created, and distinct users (user_name) for user_names for last day
+
+`catocli query appStats '{"appStatsFilter":[],"appStatsSort":[],"dimension":[{"fieldName":"user_name"}],"measure":[{"aggType":"sum","fieldName":"flows_created"},{"aggType":"count_distinct","fieldName":"user_name"}],"timeFrame":"last.P1M"}'`
+
 
-`catocli query appStats '{"appStatsFilter": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "appStatsSort": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "order": {"order": "enum(DirectionEnum)"}}, "dimension": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}}, "from": "Int", "limit": "Int", "measure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "trend": {"trend": "Boolean"}}, "timeFrame": "TimeFrame"}'`
 
 #### Operation Arguments for query.appStats ####
-`accountID` [ID] - (required) Account ID 
-`appStatsFilter` [AppStatsFilter[]] - (optional) N/A 
-`appStatsSort` [AppStatsSort[]] - (optional) N/A 
-`dimension` [Dimension[]] - (optional) N/A 
-`from` [Int] - (optional) N/A 
-`limit` [Int] - (optional) N/A 
-`measure` [Measure[]] - (optional) N/A 
-`timeFrame` [TimeFrame] - (required) N/A 
+
+`accountID` [ID] - (required) Account ID    
+`appStatsFilter` [AppStatsFilter[]] - (required) N/A    
+`appStatsSort` [AppStatsSort[]] - (required) N/A    
+`dimension` [Dimension[]] - (required) N/A    
+`from` [Int] - (required) N/A    
+`limit` [Int] - (required) N/A    
+`measure` [Measure[]] - (required) N/A    
+`timeFrame` [TimeFrame] - (required) N/A    

catocli/parsers/query_appStats/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_appStats_parse(query_subparsers):
-	query_appStats_parser = query_subparsers.add_parser('appStats', 
-			help='appStats() query operation', 
-			usage=get_help("query_appStats"))
+    query_appStats_parser = query_subparsers.add_parser('appStats', 
+            help='appStats() query operation', 
+            usage=get_help("query_appStats"))
 
-	query_appStats_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_appStats_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_appStats_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_appStats_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_appStats_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_appStats_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_appStats_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_appStats_parser.set_defaults(func=createRequest,operation_name='query.appStats')
+    query_appStats_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_appStats_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_appStats_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_appStats_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_appStats_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_appStats_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_appStats_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_appStats_parser.set_defaults(func=createRequest,operation_name='query.appStats')

catocli/parsers/query_appStatsTimeSeries/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.appStatsTimeSeries:
-[Click here](https://api.catonetworks.com/documentation/#query-appStatsTimeSeries) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.appStatsTimeSeries) for documentation on this operation.
 
 ### Usage for query.appStatsTimeSeries:
 
@@ -8,17 +8,26 @@
 
 `catocli query appStatsTimeSeries <json>`
 
-`catocli query appStatsTimeSeries "$(cat < appStatsTimeSeries.json)"`
+`catocli query appStatsTimeSeries "$(cat < query.appStatsTimeSeries.json)"`
+
+`catocli query appStatsTimeSeries '{"appStatsFilter":{"fieldName":"ad_name","operator":"is","values":["string1","string2"]},"buckets":1,"dimension":{"fieldName":"ad_name"},"measure":{"aggType":"sum","fieldName":"ad_name","trend":true},"perSecond":true,"timeFrame":"example_value","useDefaultSizeBucket":true,"withMissingData":true}'`
+
+
+## Advanced Usage
+# Query to export upstream, downstream and traffic for user_name and application_name for last day broken into 1 hour buckets
+
+`catocli query appStatsTimeSeries '{"appStatsFilter":[],"buckets":24,"dimension":[{"fieldName":"user_name"},{"fieldName":"application_name"}],"measure":[{"aggType":"sum","fieldName":"upstream"},{"aggType":"sum","fieldName":"downstream"},{"aggType":"sum","fieldName":"traffic"}],"timeFrame":"last.PT5M"}'`
+
 
-`catocli query appStatsTimeSeries '{"appStatsFilter": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "buckets": "Int", "dimension": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}}, "measure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "trend": {"trend": "Boolean"}}, "perSecond": "Boolean", "timeFrame": "TimeFrame", "useDefaultSizeBucket": "Boolean", "withMissingData": "Boolean"}'`
 
 #### Operation Arguments for query.appStatsTimeSeries ####
-`accountID` [ID] - (required) Account ID 
-`appStatsFilter` [AppStatsFilter[]] - (optional) N/A 
-`buckets` [Int] - (required) N/A 
-`dimension` [Dimension[]] - (optional) N/A 
-`measure` [Measure[]] - (optional) N/A 
-`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
-`timeFrame` [TimeFrame] - (required) N/A 
-`useDefaultSizeBucket` [Boolean] - (optional) In case we want to have the default size bucket (from properties) 
-`withMissingData` [Boolean] - (optional) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1 
+
+`accountID` [ID] - (required) Account ID    
+`appStatsFilter` [AppStatsFilter[]] - (required) N/A    
+`buckets` [Int] - (required) N/A    
+`dimension` [Dimension[]] - (required) N/A    
+`measure` [Measure[]] - (required) N/A    
+`perSecond` [Boolean] - (required) whether to normalize the data into per second (i.e. divide by granularity)    
+`timeFrame` [TimeFrame] - (required) N/A    
+`useDefaultSizeBucket` [Boolean] - (required) In case we want to have the default size bucket (from properties)    
+`withMissingData` [Boolean] - (required) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1    

catocli/parsers/query_appStatsTimeSeries/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_appStatsTimeSeries_parse(query_subparsers):
-	query_appStatsTimeSeries_parser = query_subparsers.add_parser('appStatsTimeSeries', 
-			help='appStatsTimeSeries() query operation', 
-			usage=get_help("query_appStatsTimeSeries"))
+    query_appStatsTimeSeries_parser = query_subparsers.add_parser('appStatsTimeSeries', 
+            help='appStatsTimeSeries() query operation', 
+            usage=get_help("query_appStatsTimeSeries"))
 
-	query_appStatsTimeSeries_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_appStatsTimeSeries_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_appStatsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_appStatsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_appStatsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_appStatsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_appStatsTimeSeries_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_appStatsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.appStatsTimeSeries')
+    query_appStatsTimeSeries_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_appStatsTimeSeries_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_appStatsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_appStatsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_appStatsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_appStatsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_appStatsTimeSeries_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_appStatsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.appStatsTimeSeries')