catocli 2.0.1__py3-none-any.whl → 2.0.3__py3-none-any.whl

catocli/parsers/query_eventsFeed/README.md

@@ -15,5 +15,5 @@
 #### Operation Arguments for query.eventsFeed ####
 `accountIDs` [ID[]] - (optional) List of Unique Account Identifiers. 
 `eventFeedFieldFilterInput` [EventFeedFieldFilterInput[]] - (optional) N/A 
-`fieldNames` [EventFieldName[]] - (optional) N/A Default Value: ['access_method', 'account_id', 'action', 'actions_taken', 'ad_name', 'alert_id', 'always_on_configuration', 'analyst_verdict', 'api_name', 'api_type', 'app_activity', 'app_activity_category', 'app_activity_type', 'app_stack', 'application', 'application_id', 'application_name', 'application_risk', 'auth_method', 'authentication_type', 'bgp_cato_asn', 'bgp_cato_ip', 'bgp_error_code', 'bgp_peer_asn', 'bgp_peer_ip', 'bgp_route_cidr', 'bgp_suberror_code', 'bypass_duration_sec', 'bypass_method', 'bypass_reason', 'categories', 'cato_app', 'classification', 'client_cert_expires', 'client_cert_name', 'client_class', 'client_version', 'collaborator_name', 'collaborators', 'confidence_level', 'configured_host_name', 'congestion_algorithm', 'connect_on_boot', 'connection_origin', 'connector_name', 'connector_status', 'connector_type', 'container_name', 'correlation_id', 'criticality', 'custom_categories', 'custom_category', 'custom_category_id', 'custom_category_name', 'dest_country', 'dest_country_code', 'dest_group_id', 'dest_group_name', 'dest_ip', 'dest_is_site_or_vpn', 'dest_pid', 'dest_port', 'dest_process_cmdline', 'dest_process_parent_path', 'dest_process_parent_pid', 'dest_process_path', 'dest_site', 'dest_site_id', 'dest_site_name', 'detection_name', 'detection_stage', 'device_categories', 'device_certificate', 'device_id', 'device_manufacturer', 'device_model', 'device_name', 'device_os_type', 'device_posture_profile', 'device_posture_profiles', 'device_type', 'directory_host_name', 'directory_ip', 'directory_sync_result', 'directory_sync_type', 'disinfect_result', 'dlp_fail_mode', 'dlp_profiles', 'dlp_scan_types', 'dns_protection_category', 'dns_query', 'domain_name', 'egress_pop_name', 'egress_site_name', 'email_subject', 'endpoint_id', 'epp_engine_type', 'epp_profile', 'event_count', 'event_id', 'event_message', 'event_sub_type', 'event_type', 'failure_reason', 'file_hash', 'file_name', 'file_operation', 'file_size', 'file_type', 'final_object_status', 'flows_cardinality', 'full_path_url', 'guest_user', 'host_ip', 'host_mac', 'http_request_method', 'incident_aggregation', 'incident_id', 'indication', 'indicator', 'initial_object_status', 'internalId', 'ip_protocol', 'is_admin', 'is_admin_activity', 'is_compliant', 'is_managed', 'is_sanctioned_app', 'is_sinkhole', 'ISP_name', 'key_name', 'labels', 'link_health_is_congested', 'link_health_jitter', 'link_health_latency', 'link_health_pkt_loss', 'link_type', 'logged_in_user', 'login_type', 'matched_data_types', 'mitre_attack_subtechniques', 'mitre_attack_tactics', 'mitre_attack_techniques', 'network_access', 'network_rule', 'notification_api_error', 'notification_description', 'object_id', 'object_name', 'object_type', 'office_mode', 'os_type', 'os_version', 'out_of_band_access', 'owner', 'pac_file', 'parent_connector_name', 'pop_name', 'precedence', 'processes_count', 'producer', 'prompt_action', 'public_ip', 'qos_priority', 'qos_reported_time', 'quarantine_folder_path', 'quarantine_uuid', 'raw_data', 'recommended_actions', 'reference_url', 'registration_code', 'risk_level', 'rule', 'rule_id', 'rule_name', 'severity', 'sharing_scope', 'sign_in_event_types', 'signature_id', 'socket_interface', 'socket_interface_id', 'socket_new_version', 'socket_old_version', 'socket_reset', 'socket_role', 'socket_serial', 'socket_version', 'split_tunnel_configuration', 'src_country', 'src_country_code', 'src_ip', 'src_is_site_or_vpn', 'src_isp_ip', 'src_or_dest_site_id', 'src_pid', 'src_port', 'src_process_cmdline', 'src_process_parent_path', 'src_process_parent_pid', 'src_process_path', 'src_site', 'src_site_id', 'src_site_name', 'static_host', 'status', 'story_id', 'subnet_name', 'targets_cardinality', 'tcp_acceleration', 'tenant_id', 'tenant_name', 'tenant_restriction_rule_name', 'threat_confidence', 'threat_name', 'threat_reference', 'threat_score', 'threat_type', 'threat_verdict', 'time', 'time_str', 'title', 'tls_certificate_error', 'tls_error_description', 'tls_error_type', 'tls_inspection', 'tls_rule_name', 'tls_version', 'traffic_direction', 'translated_client_ip', 'translated_server_ip', 'trigger', 'trust_type', 'trusted_networks', 'tunnel_ip_protocol', 'tunnel_protocol', 'upgrade_end_time', 'upgrade_initiated_by', 'upgrade_start_time', 'url', 'user_agent', 'user_awareness_method', 'user_id', 'user_name', 'user_reference_id', 'user_risk_level', 'vendor', 'vendor_collaborator_id', 'vendor_device_id', 'vendor_device_name', 'vendor_event_id', 'vendor_user_id', 'visible_device_id', 'vpn_lan_access', 'vpn_user_email', 'windows_domain_name', 'xff']
+`fieldNames` [EventFieldName[]] - (optional) N/A Default Value: ['access_method', 'account_id', 'action', 'actions_taken', 'ad_name', 'alert_id', 'always_on_configuration', 'analyst_verdict', 'api_name', 'api_type', 'app_activity', 'app_activity_category', 'app_activity_type', 'app_stack', 'application', 'application_id', 'application_name', 'application_risk', 'auth_method', 'authentication_type', 'bgp_cato_asn', 'bgp_cato_ip', 'bgp_error_code', 'bgp_peer_asn', 'bgp_peer_ip', 'bgp_route_cidr', 'bgp_suberror_code', 'bypass_duration_sec', 'bypass_method', 'bypass_reason', 'categories', 'cato_app', 'classification', 'client_cert_expires', 'client_cert_name', 'client_class', 'client_version', 'collaborator_name', 'collaborators', 'confidence_level', 'configured_host_name', 'congestion_algorithm', 'connect_on_boot', 'connection_origin', 'connector_name', 'connector_status', 'connector_type', 'container_name', 'correlation_id', 'criticality', 'custom_categories', 'custom_category', 'custom_category_id', 'custom_category_name', 'dest_country', 'dest_country_code', 'dest_group_id', 'dest_group_name', 'dest_ip', 'dest_is_site_or_vpn', 'dest_pid', 'dest_port', 'dest_process_cmdline', 'dest_process_parent_path', 'dest_process_parent_pid', 'dest_process_path', 'dest_site', 'dest_site_id', 'dest_site_name', 'detection_name', 'detection_stage', 'device_categories', 'device_certificate', 'device_id', 'device_manufacturer', 'device_model', 'device_name', 'device_os_type', 'device_posture_profile', 'device_posture_profiles', 'device_type', 'directory_host_name', 'directory_ip', 'directory_sync_result', 'directory_sync_type', 'disinfect_result', 'dlp_fail_mode', 'dlp_profiles', 'dlp_scan_types', 'dns_protection_category', 'dns_query', 'domain_name', 'egress_pop_name', 'egress_site_name', 'email_subject', 'endpoint_id', 'epp_engine_type', 'epp_profile', 'event_count', 'event_id', 'event_message', 'event_sub_type', 'event_type', 'failure_reason', 'file_hash', 'file_name', 'file_operation', 'file_size', 'file_type', 'final_object_status', 'flows_cardinality', 'full_path_url', 'guest_user', 'host_ip', 'host_mac', 'http_request_method', 'incident_aggregation', 'incident_id', 'indication', 'indicator', 'initial_object_status', 'internalId', 'ip_protocol', 'is_admin', 'is_admin_activity', 'is_compliant', 'is_managed', 'is_sanctioned_app', 'is_sinkhole', 'ISP_name', 'key_name', 'labels', 'link_health_is_congested', 'link_health_jitter', 'link_health_latency', 'link_health_pkt_loss', 'link_type', 'logged_in_user', 'login_type', 'matched_data_types', 'mitre_attack_subtechniques', 'mitre_attack_tactics', 'mitre_attack_techniques', 'network_access', 'network_rule', 'notification_api_error', 'notification_description', 'object_id', 'object_name', 'object_type', 'office_mode', 'os_type', 'os_version', 'out_of_band_access', 'owner', 'pac_file', 'parent_connector_name', 'pop_name', 'precedence', 'processes_count', 'producer', 'prompt_action', 'public_ip', 'qos_priority', 'qos_reported_time', 'quarantine_folder_path', 'quarantine_uuid', 'raw_data', 'recommended_actions', 'reference_url', 'referer_url', 'registration_code', 'risk_level', 'rule', 'rule_id', 'rule_name', 'severity', 'sharing_scope', 'sign_in_event_types', 'signature_id', 'socket_interface', 'socket_interface_id', 'socket_new_version', 'socket_old_version', 'socket_reset', 'socket_role', 'socket_serial', 'socket_version', 'split_tunnel_configuration', 'src_country', 'src_country_code', 'src_ip', 'src_is_site_or_vpn', 'src_isp_ip', 'src_or_dest_site_id', 'src_pid', 'src_port', 'src_process_cmdline', 'src_process_parent_path', 'src_process_parent_pid', 'src_process_path', 'src_site', 'src_site_id', 'src_site_name', 'static_host', 'status', 'story_id', 'subnet_name', 'targets_cardinality', 'tcp_acceleration', 'tenant_id', 'tenant_name', 'tenant_restriction_rule_name', 'threat_confidence', 'threat_name', 'threat_reference', 'threat_score', 'threat_type', 'threat_verdict', 'time', 'time_str', 'title', 'tls_certificate_error', 'tls_error_description', 'tls_error_type', 'tls_inspection', 'tls_rule_name', 'tls_version', 'traffic_direction', 'translated_client_ip', 'translated_server_ip', 'trigger', 'trust_type', 'trusted_networks', 'tunnel_ip_protocol', 'tunnel_protocol', 'upgrade_end_time', 'upgrade_initiated_by', 'upgrade_start_time', 'url', 'user_agent', 'user_awareness_method', 'user_id', 'user_name', 'user_reference_id', 'user_risk_level', 'vendor', 'vendor_collaborator_id', 'vendor_device_id', 'vendor_device_name', 'vendor_event_id', 'vendor_user_id', 'visible_device_id', 'vpn_lan_access', 'vpn_user_email', 'windows_domain_name', 'xff']
 `marker` [String] - (optional) Marker to use to get results from 

catocli/parsers/query_eventsFeed/__init__.py

@@ -6,12 +6,11 @@ def query_eventsFeed_parse(query_subparsers):
 			help='eventsFeed() query operation', 
 			usage=get_help("query_eventsFeed"))
 
-	query_eventsFeed_parser.add_argument('json', help='Variables in JSON format.')
+	query_eventsFeed_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_eventsFeed_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_eventsFeed_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_eventsFeed_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_eventsFeed_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_eventsFeed_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_eventsFeed_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_eventsFeed_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_eventsFeed_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_eventsFeed_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_eventsFeed_parser.set_defaults(func=createRequest,operation_name='query.eventsFeed')

catocli/parsers/query_eventsTimeSeries/__init__.py

@@ -6,12 +6,11 @@ def query_eventsTimeSeries_parse(query_subparsers):
 			help='eventsTimeSeries() query operation', 
 			usage=get_help("query_eventsTimeSeries"))
 
-	query_eventsTimeSeries_parser.add_argument('json', help='Variables in JSON format.')
+	query_eventsTimeSeries_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_eventsTimeSeries_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_eventsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_eventsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_eventsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_eventsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_eventsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_eventsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_eventsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_eventsTimeSeries_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_eventsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.eventsTimeSeries')

catocli/parsers/query_hardware/__init__.py

@@ -6,12 +6,11 @@ def query_hardware_parse(query_subparsers):
 			help='hardware() query operation', 
 			usage=get_help("query_hardware"))
 
-	query_hardware_parser.add_argument('json', help='Variables in JSON format.')
+	query_hardware_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_hardware_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_hardware_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_hardware_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_hardware_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_hardware_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_hardware_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_hardware_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_hardware_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_hardware_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_hardware_parser.set_defaults(func=createRequest,operation_name='query.hardware')

catocli/parsers/query_hardwareManagement/__init__.py

@@ -6,12 +6,11 @@ def query_hardwareManagement_parse(query_subparsers):
 			help='hardwareManagement() query operation', 
 			usage=get_help("query_hardwareManagement"))
 
-	query_hardwareManagement_parser.add_argument('json', help='Variables in JSON format.')
+	query_hardwareManagement_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_hardwareManagement_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_hardwareManagement_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_hardwareManagement_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_hardwareManagement_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_hardwareManagement_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_hardwareManagement_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_hardwareManagement_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_hardwareManagement_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_hardwareManagement_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_hardwareManagement_parser.set_defaults(func=createRequest,operation_name='query.hardwareManagement')

catocli/parsers/query_licensing/__init__.py

@@ -6,12 +6,11 @@ def query_licensing_parse(query_subparsers):
 			help='licensing() query operation', 
 			usage=get_help("query_licensing"))
 
-	query_licensing_parser.add_argument('json', help='Variables in JSON format.')
+	query_licensing_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_licensing_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_licensing_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_licensing_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_licensing_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_licensing_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_licensing_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_licensing_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_licensing_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_licensing_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_licensing_parser.set_defaults(func=createRequest,operation_name='query.licensing')

catocli/parsers/query_policy/README.md

@@ -10,7 +10,7 @@
 
 `catocli query policy "$(cat < policy.json)"`
 
-`catocli query policy '{"appTenantRestrictionPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "dynamicIpAllocationPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "internetFirewallPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "remotePortFwdPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "socketLanPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "wanFirewallPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "wanNetworkPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}}'`
+`catocli query policy '{"appTenantRestrictionPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "dynamicIpAllocationPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "internetFirewallPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "remotePortFwdPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "socketLanPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "terminalServerPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "wanFirewallPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "wanNetworkPolicyInput": {"policyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}}'`
 
 #### Operation Arguments for query.policy ####
 `accountId` [ID] - (required) N/A 
@@ -19,5 +19,6 @@
 `internetFirewallPolicyInput` [InternetFirewallPolicyInput] - (optional) N/A 
 `remotePortFwdPolicyInput` [RemotePortFwdPolicyInput] - (optional) N/A 
 `socketLanPolicyInput` [SocketLanPolicyInput] - (optional) N/A 
+`terminalServerPolicyInput` [TerminalServerPolicyInput] - (optional) N/A 
 `wanFirewallPolicyInput` [WanFirewallPolicyInput] - (optional) N/A 
 `wanNetworkPolicyInput` [WanNetworkPolicyInput] - (optional) N/A 

catocli/parsers/query_policy/__init__.py

@@ -6,12 +6,11 @@ def query_policy_parse(query_subparsers):
 			help='policy() query operation', 
 			usage=get_help("query_policy"))
 
-	query_policy_parser.add_argument('json', help='Variables in JSON format.')
+	query_policy_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_policy_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_policy_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_policy_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_policy_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_policy_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_policy_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_policy_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_policy_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_policy_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_policy_parser.set_defaults(func=createRequest,operation_name='query.policy')

catocli/parsers/query_sandbox/__init__.py

@@ -6,12 +6,11 @@ def query_sandbox_parse(query_subparsers):
 			help='sandbox() query operation', 
 			usage=get_help("query_sandbox"))
 
-	query_sandbox_parser.add_argument('json', help='Variables in JSON format.')
+	query_sandbox_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_sandbox_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_sandbox_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_sandbox_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_sandbox_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_sandbox_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_sandbox_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_sandbox_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_sandbox_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_sandbox_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_sandbox_parser.set_defaults(func=createRequest,operation_name='query.sandbox')

catocli/parsers/query_site/README.md

@@ -10,10 +10,11 @@
 
 `catocli query site "$(cat < site.json)"`
 
-`catocli query site '{"bgpPeerListInput": {"siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "bgpPeerRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}, "cloudInterconnectConnectionConnectivityInput": {"id": {"id": "ID"}}, "cloudInterconnectPhysicalConnectionIdInput": {"haRole": {"haRole": "enum(HaRole)"}, "siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "cloudInterconnectPhysicalConnectionInput": {"id": {"id": "ID"}}, "siteBgpStatusInput": {"siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}}'`
+`catocli query site '{"availableVersionListInput": {"platforms": {"platforms": ["String"]}}, "bgpPeerListInput": {"siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "bgpPeerRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}, "cloudInterconnectConnectionConnectivityInput": {"id": {"id": "ID"}}, "cloudInterconnectPhysicalConnectionIdInput": {"haRole": {"haRole": "enum(HaRole)"}, "siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "cloudInterconnectPhysicalConnectionInput": {"id": {"id": "ID"}}, "siteBgpStatusInput": {"siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}}'`
 
 #### Operation Arguments for query.site ####
 `accountId` [ID] - (required) N/A 
+`availableVersionListInput` [AvailableVersionListInput] - (required) N/A 
 `bgpPeerListInput` [BgpPeerListInput] - (required) N/A 
 `bgpPeerRefInput` [BgpPeerRefInput] - (required) N/A 
 `cloudInterconnectConnectionConnectivityInput` [CloudInterconnectConnectionConnectivityInput] - (required) N/A 

catocli/parsers/query_site/__init__.py

@@ -6,12 +6,11 @@ def query_site_parse(query_subparsers):
 			help='site() query operation', 
 			usage=get_help("query_site"))
 
-	query_site_parser.add_argument('json', help='Variables in JSON format.')
+	query_site_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_site_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_site_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_site_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_site_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_site_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_site_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_site_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_site_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_site_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_site_parser.set_defaults(func=createRequest,operation_name='query.site')

catocli/parsers/query_siteLocation/__init__.py

@@ -5,13 +5,9 @@ def query_siteLocation_parse(query_subparsers):
 	query_siteLocation_parser = query_subparsers.add_parser('siteLocation', 
 			help='siteLocation local cli query', 
 			usage=get_help("query_siteLocation"))
-
-	query_siteLocation_parser.add_argument('json', help='Variables in JSON format.')
+	query_siteLocation_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_siteLocation_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_siteLocation_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_siteLocation_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_siteLocation_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_siteLocation_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_siteLocation_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_siteLocation_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
 	query_siteLocation_parser.set_defaults(func=querySiteLocation,operation_name='query.siteLocation')

catocli/parsers/query_subDomains/__init__.py

@@ -6,12 +6,11 @@ def query_subDomains_parse(query_subparsers):
 			help='subDomains() query operation', 
 			usage=get_help("query_subDomains"))
 
-	query_subDomains_parser.add_argument('json', help='Variables in JSON format.')
+	query_subDomains_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_subDomains_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_subDomains_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_subDomains_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_subDomains_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_subDomains_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_subDomains_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_subDomains_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_subDomains_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_subDomains_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_subDomains_parser.set_defaults(func=createRequest,operation_name='query.subDomains')

catocli/parsers/query_xdr/__init__.py

@@ -12,26 +12,24 @@ def query_xdr_parse(query_subparsers):
 			help='stories() xdr operation', 
 			usage=get_help("query_xdr_stories"))
 
-	query_xdr_stories_parser.add_argument('json', help='Variables in JSON format.')
+	query_xdr_stories_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_xdr_stories_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_xdr_stories_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_xdr_stories_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_xdr_stories_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_xdr_stories_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_xdr_stories_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_xdr_stories_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_xdr_stories_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_xdr_stories_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_xdr_stories_parser.set_defaults(func=createRequest,operation_name='query.xdr.stories')
 
 	query_xdr_story_parser = query_xdr_subparsers.add_parser('story', 
 			help='story() xdr operation', 
 			usage=get_help("query_xdr_story"))
 
-	query_xdr_story_parser.add_argument('json', help='Variables in JSON format.')
+	query_xdr_story_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_xdr_story_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_xdr_story_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_xdr_story_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_xdr_story_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_xdr_story_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_xdr_story_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_xdr_story_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	query_xdr_story_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	query_xdr_story_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_xdr_story_parser.set_defaults(func=createRequest,operation_name='query.xdr.story')

catocli/parsers/raw/README.md

@@ -13,3 +13,7 @@
 `catocli raw '{ "query": "query operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
 
 `catocli raw '{ "query": "mutation operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
+
+#### Override API endpoint
+
+`catocli raw --endpoint https://custom-api.example.com/graphql '<json>'`

catocli/parsers/raw/__init__.py

@@ -2,8 +2,11 @@
 from ..parserApiClient import createRawRequest, get_help
 
 def raw_parse(raw_parser):
-	raw_parser.add_argument('json', help='Query, Variables and opertaionName in JSON format.')
-	raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print test request preview without sending api call')
+	raw_parser.add_argument('json', nargs='?', default='{}', help='Query, Variables and opertaionName in JSON format (defaults to empty object if not provided).')
+	raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
 	raw_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
 	raw_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	raw_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	raw_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+	raw_parser.add_argument('--endpoint', dest='endpoint', help='Override the API endpoint URL (e.g., https://api.catonetworks.com/api/v1/graphql2)')
 	raw_parser.set_defaults(func=createRawRequest,operation_name='raw')

{catocli-2.0.1.dist-info → catocli-2.0.3.dist-info}/METADATA

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