catocli 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

catocli/parsers/mutation_sites_updateIpsecIkeV2SiteGeneralDetails/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - mutation.sites.updateIpsecIkeV2SiteGeneralDetails:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateIpsecIkeV2SiteGeneralDetails) for documentation on this operation.
+
+### Usage for mutation.sites.updateIpsecIkeV2SiteGeneralDetails:
+
+`catocli mutation sites updateIpsecIkeV2SiteGeneralDetails -h`
+
+`catocli mutation sites updateIpsecIkeV2SiteGeneralDetails <accountID> <json>`
+
+`catocli mutation sites updateIpsecIkeV2SiteGeneralDetails 12345 "$(cat < updateIpsecIkeV2SiteGeneralDetails.json)"`
+
+`catocli mutation sites updateIpsecIkeV2SiteGeneralDetails 12345 '{"UpdateIpsecIkeV2SiteGeneralDetailsInput": {"IpsecIkeV2MessageInput": {"cipher": {"cipher": "enum(IpSecCipher)"}, "dhGroup": {"dhGroup": "enum(IpSecDHGroup)"}, "integrity": {"integrity": "enum(IpSecHash)"}, "prf": {"prf": "enum(IpSecHash)"}}, "connectionMode": {"connectionMode": "enum(ConnectionMode)"}, "identificationType": {"identificationType": "enum(IdentificationType)"}, "networkRanges": {"networkRanges": ["IPSubnet"]}}, "siteId": "ID"}'`
+
+#### Operation Arguments for mutation.sites.updateIpsecIkeV2SiteGeneralDetails ####
+`UpdateIpsecIkeV2SiteGeneralDetailsInput` [UpdateIpsecIkeV2SiteGeneralDetailsInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`siteId` [ID] - (required) N/A 

catocli/parsers/mutation_sites_updateIpsecIkeV2SiteTunnels/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - mutation.sites.updateIpsecIkeV2SiteTunnels:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateIpsecIkeV2SiteTunnels) for documentation on this operation.
+
+### Usage for mutation.sites.updateIpsecIkeV2SiteTunnels:
+
+`catocli mutation sites updateIpsecIkeV2SiteTunnels -h`
+
+`catocli mutation sites updateIpsecIkeV2SiteTunnels <accountID> <json>`
+
+`catocli mutation sites updateIpsecIkeV2SiteTunnels 12345 "$(cat < updateIpsecIkeV2SiteTunnels.json)"`
+
+`catocli mutation sites updateIpsecIkeV2SiteTunnels 12345 '{"UpdateIpsecIkeV2SiteTunnelsInput": {"UpdateIpsecIkeV2TunnelsInput": {"destinationType": {"destinationType": "enum(DestinationType)"}, "popLocationId": {"popLocationId": "ID"}, "publicCatoIpId": {"publicCatoIpId": "ID"}, "tunnels": {"lastMileBw": {"downstream": {"downstream": "Int"}, "upstream": {"upstream": "Int"}}, "privateCatoIp": {"privateCatoIp": "IPAddress"}, "privateSiteIp": {"privateSiteIp": "IPAddress"}, "psk": {"psk": "String"}, "publicSiteIp": {"publicSiteIp": "IPAddress"}, "tunnelId": {"tunnelId": "enum(IPSecV2InterfaceId)"}}}}, "siteId": "ID"}'`
+
+#### Operation Arguments for mutation.sites.updateIpsecIkeV2SiteTunnels ####
+`UpdateIpsecIkeV2SiteTunnelsInput` [UpdateIpsecIkeV2SiteTunnelsInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`siteId` [ID] - (required) N/A 

catocli/parsers/mutation_sites_updateNetworkRange/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - mutation.sites.updateNetworkRange:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateNetworkRange) for documentation on this operation.
+
+### Usage for mutation.sites.updateNetworkRange:
+
+`catocli mutation sites updateNetworkRange -h`
+
+`catocli mutation sites updateNetworkRange <accountID> <json>`
+
+`catocli mutation sites updateNetworkRange 12345 "$(cat < updateNetworkRange.json)"`
+
+`catocli mutation sites updateNetworkRange 12345 '{"UpdateNetworkRangeInput": {"NetworkDhcpSettingsInput": {"dhcpType": {"dhcpType": "enum(DhcpType)"}, "ipRange": {"ipRange": "IPRange"}, "relayGroupId": {"relayGroupId": "ID"}}, "azureFloatingIp": {"azureFloatingIp": "IPAddress"}, "gateway": {"gateway": "IPAddress"}, "localIp": {"localIp": "IPAddress"}, "mdnsReflector": {"mdnsReflector": "Boolean"}, "name": {"name": "String"}, "rangeType": {"rangeType": "enum(SubnetType)"}, "subnet": {"subnet": "IPSubnet"}, "translatedSubnet": {"translatedSubnet": "IPSubnet"}, "vlan": {"vlan": "Int"}}, "networkRangeId": "ID"}'`
+
+#### Operation Arguments for mutation.sites.updateNetworkRange ####
+`UpdateNetworkRangeInput` [UpdateNetworkRangeInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`networkRangeId` [ID] - (required) N/A 

catocli/parsers/mutation_sites_updateSiteGeneralDetails/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - mutation.sites.updateSiteGeneralDetails:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateSiteGeneralDetails) for documentation on this operation.
+
+### Usage for mutation.sites.updateSiteGeneralDetails:
+
+`catocli mutation sites updateSiteGeneralDetails -h`
+
+`catocli mutation sites updateSiteGeneralDetails <accountID> <json>`
+
+`catocli mutation sites updateSiteGeneralDetails 12345 "$(cat < updateSiteGeneralDetails.json)"`
+
+`catocli mutation sites updateSiteGeneralDetails 12345 '{"UpdateSiteGeneralDetailsInput": {"UpdateSiteLocationInput": {"address": {"address": "String"}, "countryCode": {"countryCode": "String"}, "stateCode": {"stateCode": "String"}, "timezone": {"timezone": "String"}}, "description": {"description": "String"}, "name": {"name": "String"}, "siteType": {"siteType": "enum(SiteType)"}}, "siteId": "ID"}'`
+
+#### Operation Arguments for mutation.sites.updateSiteGeneralDetails ####
+`UpdateSiteGeneralDetailsInput` [UpdateSiteGeneralDetailsInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`siteId` [ID] - (required) N/A 

catocli/parsers/mutation_sites_updateSocketInterface/README.md

@@ -0,0 +1,19 @@
+
+## CATO-CLI - mutation.sites.updateSocketInterface:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateSocketInterface) for documentation on this operation.
+
+### Usage for mutation.sites.updateSocketInterface:
+
+`catocli mutation sites updateSocketInterface -h`
+
+`catocli mutation sites updateSocketInterface <accountID> <json>`
+
+`catocli mutation sites updateSocketInterface 12345 "$(cat < updateSocketInterface.json)"`
+
+`catocli mutation sites updateSocketInterface 12345 '{"UpdateSocketInterfaceInput": {"SocketInterfaceAltWanInput": {"privateGatewayIp": {"privateGatewayIp": "IPAddress"}, "privateInterfaceIp": {"privateInterfaceIp": "IPAddress"}, "privateNetwork": {"privateNetwork": "IPSubnet"}, "privateVlanTag": {"privateVlanTag": "Int"}, "publicGatewayIp": {"publicGatewayIp": "IPAddress"}, "publicInterfaceIp": {"publicInterfaceIp": "IPAddress"}, "publicNetwork": {"publicNetwork": "IPSubnet"}, "publicVlanTag": {"publicVlanTag": "Int"}}, "SocketInterfaceBandwidthInput": {"downstreamBandwidth": {"downstreamBandwidth": "Int"}, "upstreamBandwidth": {"upstreamBandwidth": "Int"}}, "SocketInterfaceLagInput": {"minLinks": {"minLinks": "Int"}}, "SocketInterfaceLanInput": {"localIp": {"localIp": "IPAddress"}, "subnet": {"subnet": "IPSubnet"}, "translatedSubnet": {"translatedSubnet": "IPSubnet"}}, "SocketInterfaceOffCloudInput": {"enabled": {"enabled": "Boolean"}, "publicIp": {"publicIp": "IPAddress"}, "publicStaticPort": {"publicStaticPort": "Int"}}, "SocketInterfaceVrrpInput": {"vrrpType": {"vrrpType": "enum(VrrpType)"}}, "SocketInterfaceWanInput": {"precedence": {"precedence": "enum(SocketInterfacePrecedenceEnum)"}, "role": {"role": "enum(SocketInterfaceRole)"}}, "destType": {"destType": "enum(SocketInterfaceDestType)"}, "name": {"name": "String"}}, "siteId": "ID", "socketInterfaceId": "enum(SocketInterfaceIDEnum)"}'`
+
+#### Operation Arguments for mutation.sites.updateSocketInterface ####
+`UpdateSocketInterfaceInput` [UpdateSocketInterfaceInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`siteId` [ID] - (required) N/A 
+`socketInterfaceId` [SocketInterfaceIDEnum] - (required) N/A Default Value: ['LAN1', 'LAN2', 'WAN1', 'WAN2', 'USB1', 'USB2', 'INT_1', 'INT_2', 'INT_3', 'INT_4', 'INT_5', 'INT_6', 'INT_7', 'INT_8', 'INT_9', 'INT_10', 'INT_11', 'INT_12', 'WLAN', 'LTE']

catocli/parsers/mutation_sites_updateStaticHost/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - mutation.sites.updateStaticHost:
+[Click here](https://api.catonetworks.com/documentation/#mutation-updateStaticHost) for documentation on this operation.
+
+### Usage for mutation.sites.updateStaticHost:
+
+`catocli mutation sites updateStaticHost -h`
+
+`catocli mutation sites updateStaticHost <accountID> <json>`
+
+`catocli mutation sites updateStaticHost 12345 "$(cat < updateStaticHost.json)"`
+
+`catocli mutation sites updateStaticHost 12345 '{"UpdateStaticHostInput": {"ip": {"ip": "IPAddress"}, "macAddress": {"macAddress": "String"}, "name": {"name": "String"}}, "hostId": "ID"}'`
+
+#### Operation Arguments for mutation.sites.updateStaticHost ####
+`UpdateStaticHostInput` [UpdateStaticHostInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 
+`hostId` [ID] - (required) N/A 

catocli/parsers/query/README.md

@@ -0,0 +1,3 @@
+
+### Usage:
+`cato query -h`

catocli/parsers/query_accountBySubdomain/README.md

@@ -0,0 +1,17 @@
+
+## CATO-CLI - query.accountBySubdomain:
+[Click here](https://api.catonetworks.com/documentation/#query-accountBySubdomain) for documentation on this operation.
+
+### Usage for query.accountBySubdomain:
+
+`catocli query accountBySubdomain -h`
+
+`catocli query accountBySubdomain <accountID> <json>`
+
+`catocli query accountBySubdomain 12345 "$(cat < accountBySubdomain.json)"`
+
+`catocli query accountBySubdomain 12345 '{"subdomains": ["String"]}'`
+
+#### Operation Arguments for query.accountBySubdomain ####
+`accountID` [ID] - (required) N/A 
+`subdomains` [String[]] - (required) a list of required subdomains 

catocli/parsers/query_accountMetrics/README.md

@@ -0,0 +1,32 @@
+
+## CATO-CLI - query.accountMetrics:
+[Click here](https://api.catonetworks.com/documentation/#query-accountMetrics) for documentation on this operation.
+
+### Usage for query.accountMetrics:
+
+`catocli query accountMetrics -h`
+
+`catocli query accountMetrics <accountID> <json>`
+
+`catocli query accountMetrics 12345 "$(cat < accountMetrics.json)"`
+
+`catocli query accountMetrics 12345 '{"buckets": "Int", "groupDevices": "Boolean", "groupInterfaces": "Boolean", "labels": "enum(TimeseriesMetricType)", "perSecond": "Boolean", "siteIDs": ["ID"], "timeFrame": "TimeFrame", "toRate": "Boolean", "types": ["String"], "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
+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 
+`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 

catocli/parsers/query_accountRoles/README.md

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

catocli/parsers/query_accountSnapshot/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - query.accountSnapshot:
+[Click here](https://api.catonetworks.com/documentation/#query-accountSnapshot) for documentation on this operation.
+
+### Usage for query.accountSnapshot:
+
+`catocli query accountSnapshot -h`
+
+`catocli query accountSnapshot <accountID> <json>`
+
+`catocli query accountSnapshot 12345 "$(cat < accountSnapshot.json)"`
+
+`catocli query accountSnapshot 12345 '{"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 

catocli/parsers/query_admin/README.md

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

catocli/parsers/query_admins/README.md

@@ -0,0 +1,21 @@
+
+## CATO-CLI - query.admins:
+[Click here](https://api.catonetworks.com/documentation/#query-admins) for documentation on this operation.
+
+### Usage for query.admins:
+
+`catocli query admins -h`
+
+`catocli query admins <accountID> <json>`
+
+`catocli query admins 12345 "$(cat < admins.json)"`
+
+`catocli query admins 12345 '{"SortInput": {"field": {"field": "String"}, "order": {"order": "enum(DirectionInput)"}}, "adminIDs": ["ID"], "from": "Int", "limit": "Int", "search": "String"}'`
+
+#### Operation Arguments for query.admins ####
+`SortInput` [SortInput[]] - (optional) N/A 
+`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 

catocli/parsers/query_appStats/README.md

@@ -0,0 +1,23 @@
+
+## CATO-CLI - query.appStats:
+[Click here](https://api.catonetworks.com/documentation/#query-appStats) for documentation on this operation.
+
+### Usage for query.appStats:
+
+`catocli query appStats -h`
+
+`catocli query appStats <accountID> <json>`
+
+`catocli query appStats 12345 "$(cat < appStats.json)"`
+
+`catocli query appStats 12345 '{"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)"}}, "Measure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "trend": {"trend": "Boolean"}}, "from": "Int", "limit": "Int", "timeFrame": "TimeFrame"}'`
+
+#### Operation Arguments for query.appStats ####
+`AppStatsFilter` [AppStatsFilter[]] - (optional) N/A 
+`AppStatsSort` [AppStatsSort[]] - (optional) N/A 
+`Dimension` [Dimension[]] - (optional) N/A 
+`Measure` [Measure[]] - (optional) N/A 
+`accountID` [ID] - (required) Account ID 
+`from` [Int] - (optional) N/A 
+`limit` [Int] - (optional) N/A 
+`timeFrame` [TimeFrame] - (required) N/A 

catocli/parsers/query_appStatsTimeSeries/README.md

@@ -0,0 +1,23 @@
+
+## CATO-CLI - query.appStatsTimeSeries:
+[Click here](https://api.catonetworks.com/documentation/#query-appStatsTimeSeries) for documentation on this operation.
+
+### Usage for query.appStatsTimeSeries:
+
+`catocli query appStatsTimeSeries -h`
+
+`catocli query appStatsTimeSeries <accountID> <json>`
+
+`catocli query appStatsTimeSeries 12345 "$(cat < appStatsTimeSeries.json)"`
+
+`catocli query appStatsTimeSeries 12345 '{"AppStatsFilter": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "Dimension": {"fieldName": {"fieldName": "enum(AppStatsFieldName)"}}, "Measure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(AppStatsFieldName)"}, "trend": {"trend": "Boolean"}}, "buckets": "Int", "perSecond": "Boolean", "timeFrame": "TimeFrame", "withMissingData": "Boolean"}'`
+
+#### Operation Arguments for query.appStatsTimeSeries ####
+`AppStatsFilter` [AppStatsFilter[]] - (optional) N/A 
+`Dimension` [Dimension[]] - (optional) N/A 
+`Measure` [Measure[]] - (optional) N/A 
+`accountID` [ID] - (required) Account ID 
+`buckets` [Int] - (required) N/A 
+`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
+`timeFrame` [TimeFrame] - (required) N/A 
+`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 

catocli/parsers/query_auditFeed/README.md

@@ -0,0 +1,20 @@
+
+## CATO-CLI - query.auditFeed:
+[Click here](https://api.catonetworks.com/documentation/#query-auditFeed) for documentation on this operation.
+
+### Usage for query.auditFeed:
+
+`catocli query auditFeed -h`
+
+`catocli query auditFeed <accountID> <json>`
+
+`catocli query auditFeed 12345 "$(cat < auditFeed.json)"`
+
+`catocli query auditFeed 12345 '{"AuditFieldFilterInput": {"FieldNameInput": {"AuditFieldName": {"AuditFieldName": "enum(AuditFieldName)"}, "EventFieldName": {"EventFieldName": "enum(EventFieldName)"}}, "operator": {"operator": "enum(ElasticOperator)"}, "values": {"values": ["String"]}}, "accountIDs": ["ID"], "fieldNames": "enum(AuditFieldName)", "marker": "String", "timeFrame": "TimeFrame"}'`
+
+#### Operation Arguments for query.auditFeed ####
+`AuditFieldFilterInput` [AuditFieldFilterInput[]] - (optional) N/A 
+`accountIDs` [ID[]] - (optional) List of Unique Account Identifiers. 
+`fieldNames` [AuditFieldName[]] - (optional) N/A Default Value: ['admin', 'apiKey', 'model_name', 'admin_id', 'module', 'audit_creation_type', 'insertion_date', 'change_type', 'creation_date', 'model_type', 'account', 'account_id']
+`marker` [String] - (optional) Marker to use to get results from 
+`timeFrame` [TimeFrame] - (required) N/A 

catocli/parsers/query_container/README.md

@@ -0,0 +1,23 @@
+
+## CATO-CLI - query.container:
+[Click here](https://api.catonetworks.com/documentation/#query-container) for documentation on this operation.
+
+### Usage for query.container:
+
+`catocli query container -h`
+
+`catocli query container <accountID> <json>`
+
+`catocli query container 12345 "$(cat < container.json)"`
+
+`catocli query container 12345 '{"ContainerSearchInput": {"ContainerRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}, "types": {"types": "enum(ContainerType)"}}, "DownloadFqdnContainerFileInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}, "DownloadIpAddressRangeContainerFileInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}, "FqdnContainerSearchFqdnInput": {"fqdn": {"fqdn": "Fqdn"}}, "FqdnContainerSearchInput": {"ContainerRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "IpAddressRangeContainerSearchInput": {"ContainerRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}, "IpAddressRangeContainerSearchIpAddressRangeInput": {"IpAddressRangeInput": {"from": {"from": "IPAddress"}, "to": {"to": "IPAddress"}}}}'`
+
+#### Operation Arguments for query.container ####
+`ContainerSearchInput` [ContainerSearchInput] - (required) N/A 
+`DownloadFqdnContainerFileInput` [DownloadFqdnContainerFileInput] - (required) N/A 
+`DownloadIpAddressRangeContainerFileInput` [DownloadIpAddressRangeContainerFileInput] - (required) N/A 
+`FqdnContainerSearchFqdnInput` [FqdnContainerSearchFqdnInput] - (required) N/A 
+`FqdnContainerSearchInput` [FqdnContainerSearchInput] - (required) N/A 
+`IpAddressRangeContainerSearchInput` [IpAddressRangeContainerSearchInput] - (required) N/A 
+`IpAddressRangeContainerSearchIpAddressRangeInput` [IpAddressRangeContainerSearchIpAddressRangeInput] - (required) N/A 
+`accountId` [ID] - (required) N/A 

catocli/parsers/query_entityLookup/README.md

@@ -0,0 +1,31 @@
+
+## CATO-CLI - query.entityLookup:
+[Click here](https://api.catonetworks.com/documentation/#query-entityLookup) for documentation on this operation.
+
+### Usage for query.entityLookup:
+
+`catocli query entityLookup -h`
+
+`catocli query entityLookup <accountID> <json>`
+
+`catocli query entityLookup 12345 "$(cat < entityLookup.json)"`
+
+`catocli query entityLookup 12345 '{"EntityInput": {"id": {"id": "ID"}, "name": {"name": "String"}, "type": {"type": "enum(EntityType)"}}, "LookupFilterInput": {"filter": {"filter": "enum(LookupFilterType)"}, "value": {"value": "String"}}, "SortInput": {"field": {"field": "String"}, "order": {"order": "enum(DirectionInput)"}}, "entityIDs": ["ID"], "from": "Int", "helperFields": ["String"], "limit": "Int", "search": "String", "type": "enum(EntityType)"}'`
+
+#### Operation Arguments for query.entityLookup ####
+`EntityInput` [EntityInput] - (optional) Return items under a parent entity (can be site, vpn user, etc),
+used to filter for networks that belong to a specific site for example 
+`LookupFilterInput` [LookupFilterInput[]] - (optional) Custom filters for entityLookup 
+`SortInput` [SortInput[]] - (optional) Adds additional sort criteria(s) for the lookup.
+This option is not universally available, and may not be applicable specific Entity types. 
+`accountID` [ID] - (required) The account ID (or 0 for non-authenticated requests) 
+`entityIDs` [ID[]] - (optional) Adds additional search criteria to fetch by the selected list of entity IDs. This option is not
+universally available, and may not be applicable specific Entity types. If used on non applicable entity
+type, an error will be generated. 
+`from` [Int] - (optional) Sets the offset number of items (for paging) 
+`helperFields` [String[]] - (optional) Additional helper fields 
+`limit` [Int] - (optional) Sets the maximum number of items to retrieve 
+`search` [String] - (optional) Adds additional search parameters for the lookup. Available options:
+country lookup: "removeExcluded" to return only allowed countries
+countryState lookup: country code ("US", "CN", etc) to get country's states 
+`type` [EntityType] - (required) Type of entity to lookup for Default Value: ['account', 'site', 'vpnUser', 'country', 'countryState', 'timezone', 'host', 'any', 'networkInterface', 'location', 'admin', 'localRouting', 'lanFirewall', 'allocatedIP', 'siteRange', 'simpleService', 'availableSiteUsage', 'availablePooledUsage', 'dhcpRelayGroup', 'portProtocol', 'city', 'groupSubscription', 'mailingListSubscription', 'webhookSubscription']

catocli/parsers/query_events/README.md

@@ -0,0 +1,23 @@
+
+## CATO-CLI - query.events:
+[Click here](https://api.catonetworks.com/documentation/#query-events) for documentation on this operation.
+
+### Usage for query.events:
+
+`catocli query events -h`
+
+`catocli query events <accountID> <json>`
+
+`catocli query events 12345 "$(cat < events.json)"`
+
+`catocli query events 12345 '{"EventsDimension": {"fieldName": {"fieldName": "enum(EventFieldName)"}}, "EventsFilter": {"fieldName": {"fieldName": "enum(EventFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "EventsMeasure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(EventFieldName)"}, "trend": {"trend": "Boolean"}}, "EventsSort": {"fieldName": {"fieldName": "enum(EventFieldName)"}, "order": {"order": "enum(DirectionEnum)"}}, "from": "Int", "limit": "Int", "timeFrame": "TimeFrame"}'`
+
+#### Operation Arguments for query.events ####
+`EventsDimension` [EventsDimension[]] - (optional) N/A 
+`EventsFilter` [EventsFilter[]] - (optional) N/A 
+`EventsMeasure` [EventsMeasure[]] - (optional) N/A 
+`EventsSort` [EventsSort[]] - (optional) N/A 
+`accountID` [ID] - (required) Account ID 
+`from` [Int] - (optional) N/A 
+`limit` [Int] - (optional) N/A 
+`timeFrame` [TimeFrame] - (required) N/A 

catocli/parsers/query_eventsFeed/README.md

@@ -0,0 +1,19 @@
+
+## CATO-CLI - query.eventsFeed:
+[Click here](https://api.catonetworks.com/documentation/#query-eventsFeed) for documentation on this operation.
+
+### Usage for query.eventsFeed:
+
+`catocli query eventsFeed -h`
+
+`catocli query eventsFeed <accountID> <json>`
+
+`catocli query eventsFeed 12345 "$(cat < eventsFeed.json)"`
+
+`catocli query eventsFeed 12345 '{"EventFeedFieldFilterInput": {"fieldName": {"fieldName": "enum(EventFeedFilterFieldName)"}, "operator": {"operator": "enum(EventFeedFilterOperator)"}, "values": {"values": ["String"]}}, "accountIDs": ["ID"], "fieldNames": "enum(EventFieldName)", "marker": "String"}'`
+
+#### Operation Arguments for query.eventsFeed ####
+`EventFeedFieldFilterInput` [EventFeedFieldFilterInput[]] - (optional) N/A 
+`accountIDs` [ID[]] - (optional) List of Unique Account Identifiers. 
+`fieldNames` [EventFieldName[]] - (optional) N/A Default Value: ['src_site', 'src_site_id', 'static_host', 'user_id', 'dest_site', 'dest_site_id', 'src_or_dest_site_id', 'rule', 'ISP_name', 'socket_interface', 'custom_category', 'directory_host_name', 'dest_port', 'bgp_peer_asn', 'user_reference_id', 'src_port', 'link_health_pkt_loss', 'pop_name', 'host_ip', 'event_message', 'src_site_name', 'domain_name', 'dest_ip', 'file_hash', 'src_isp_ip', 'authentication_type', 'rule_name', 'directory_sync_result', 'host_mac', 'threat_type', 'threat_verdict', 'device_name', 'link_type', 'login_type', 'configured_host_name', 'internalId', 'directory_sync_type', 'vpn_user_email', 'client_class', 'incident_aggregation', 'socket_reset', 'user_name', 'client_version', 'file_size', 'registration_code', 'bgp_error_code', 'bgp_peer_description', 'threat_name', 'qos_reported_time', 'ip_protocol', 'bgp_cato_asn', 'src_ip', 'threat_reference', 'action', 'windows_domain_name', 'risk_level', 'socket_old_version', 'link_health_latency', 'tunnel_protocol', 'socket_new_version', 'socket_version', 'link_health_jitter', 'upgrade_start_time', 'bgp_cato_ip', 'categories', 'rule_id', 'socket_role', 'targets_cardinality', 'upgrade_initiated_by', 'dest_is_site_or_vpn', 'bgp_peer_ip', 'src_is_site_or_vpn', 'ad_name', 'user_awareness_method', 'link_health_is_congested', 'subnet_name', 'os_version', 'event_sub_type', 'os_type', 'traffic_direction', 'bgp_suberror_code', 'bgp_route_cidr', 'incident_id', 'application', 'application_name', 'application_id', 'upgrade_end_time', 'socket_interface_id', 'custom_categories', 'custom_category_id', 'custom_category_name', 'src_country', 'src_country_code', 'event_count', 'file_name', 'directory_ip', 'time', 'url', 'dest_country', 'dest_country_code', 'flows_cardinality', 'dest_site_name', 'event_type', 'account_id', 'signature_id', 'client_cert_expires', 'client_cert_name', 'is_sanctioned_app', 'app_activity', 'app_activity_type', 'device_posture_profile', 'device_posture_profiles', 'full_path_url', 'application_risk', 'mitre_attack_techniques', 'mitre_attack_subtechniques', 'mitre_attack_tactics', 'indicator', 'connector_type', 'connector_name', 'connector_status', 'parent_connector_name', 'file_type', 'dlp_fail_mode', 'dlp_profiles', 'matched_data_types', 'severity', 'owner', 'collaborators', 'email_subject', 'sharing_scope', 'dns_protection_category', 'final_object_status', 'object_name', 'object_type', 'object_id', 'alert_id', 'vendor', 'vendor_user_id', 'status', 'classification', 'quarantine_folder_path', 'title', 'recommended_actions', 'pid', 'parent_pid', 'process_path', 'failure_reason', 'out_of_band_access', 'logged_in_user', 'http_request_method', 'xff', 'dns_query', 'key_name', 'api_type', 'api_name', 'app_stack', 'tls_rule_name', 'tls_certificate_error', 'tls_version', 'tls_error_type', 'tls_error_description', 'cato_app', 'prompt_action', 'device_id', 'visible_device_id', 'auth_method', 'bypass_method', 'bypass_duration_sec', 'bypass_reason', 'sign_in_event_types', 'tenant_id', 'tenant_name', 'user_agent', 'vendor_event_id', 'vendor_device_id', 'vendor_device_name', 'is_compliant', 'is_managed', 'trust_type', 'confidence_level', 'dlp_scan_types', 'network_access', 'analyst_verdict', 'criticality', 'indication', 'producer', 'story_id', 'raw_data', 'trigger', 'network_rule', 'congestion_algorithm', 'tcp_acceleration', 'tls_inspection', 'public_ip', 'egress_site_name', 'egress_pop_name', 'qos_priority', 'split_tunnel_configuration', 'pac_file', 'always_on_configuration', 'vpn_lan_access', 'connect_on_boot', 'trusted_networks', 'office_mode', 'device_certificate', 'tunnel_ip_protocol', 'notification_description', 'notification_api_error', 'reference_url', 'app_activity_category', 'is_admin_activity', 'is_admin', 'collaborator_name', 'dest_group_id', 'dest_group_name', 'access_method', 'vendor_collaborator_id']
+`marker` [String] - (optional) Marker to use to get results from 

catocli/parsers/query_eventsTimeSeries/README.md

@@ -0,0 +1,23 @@
+
+## CATO-CLI - query.eventsTimeSeries:
+[Click here](https://api.catonetworks.com/documentation/#query-eventsTimeSeries) for documentation on this operation.
+
+### Usage for query.eventsTimeSeries:
+
+`catocli query eventsTimeSeries -h`
+
+`catocli query eventsTimeSeries <accountID> <json>`
+
+`catocli query eventsTimeSeries 12345 "$(cat < eventsTimeSeries.json)"`
+
+`catocli query eventsTimeSeries 12345 '{"EventsDimension": {"fieldName": {"fieldName": "enum(EventFieldName)"}}, "EventsFilter": {"fieldName": {"fieldName": "enum(EventFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "EventsMeasure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(EventFieldName)"}, "trend": {"trend": "Boolean"}}, "buckets": "Int", "perSecond": "Boolean", "timeFrame": "TimeFrame", "withMissingData": "Boolean"}'`
+
+#### Operation Arguments for query.eventsTimeSeries ####
+`EventsDimension` [EventsDimension[]] - (optional) N/A 
+`EventsFilter` [EventsFilter[]] - (optional) N/A 
+`EventsMeasure` [EventsMeasure[]] - (optional) N/A 
+`accountID` [ID] - (required) Account ID 
+`buckets` [Int] - (required) N/A 
+`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
+`timeFrame` [TimeFrame] - (required) N/A 
+`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 

catocli/parsers/query_hardwareManagement/README.md

@@ -0,0 +1,17 @@
+
+## CATO-CLI - query.hardwareManagement:
+[Click here](https://api.catonetworks.com/documentation/#query-hardwareManagement) for documentation on this operation.
+
+### Usage for query.hardwareManagement:
+
+`catocli query hardwareManagement -h`
+
+`catocli query hardwareManagement <accountID> <json>`
+
+`catocli query hardwareManagement 12345 "$(cat < hardwareManagement.json)"`
+
+`catocli query hardwareManagement 12345 '{"SocketInventoryInput": {"PagingInput": {"from": {"from": "Int"}, "limit": {"limit": "Int"}}, "SocketInventoryFilterInput": {"freeText": {"search": {"search": "String"}}}, "SocketInventoryOrderInput": {"deliverySiteName": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "description": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "installedSite": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "serialNumber": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "shippingCompany": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "shippingDate": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "socketType": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}, "status": {"direction": {"direction": "enum(SortOrder)"}, "priority": {"priority": "Int"}}}}}'`
+
+#### Operation Arguments for query.hardwareManagement ####
+`SocketInventoryInput` [SocketInventoryInput] - (optional) N/A 
+`accountId` [ID] - (required) N/A 

catocli/parsers/query_licensing/README.md

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

catocli/parsers/query_policy/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - query.policy:
+[Click here](https://api.catonetworks.com/documentation/#query-policy) for documentation on this operation.
+
+### Usage for query.policy:
+
+`catocli query policy -h`
+
+`catocli query policy <accountID> <json>`
+
+`catocli query policy 12345 "$(cat < policy.json)"`
+
+`catocli query policy 12345 '{"InternetFirewallPolicyInput": {"PolicyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}, "WanFirewallPolicyInput": {"PolicyRevisionInput": {"id": {"id": "ID"}, "type": {"type": "enum(PolicyRevisionType)"}}}}'`
+
+#### Operation Arguments for query.policy ####
+`InternetFirewallPolicyInput` [InternetFirewallPolicyInput] - (optional) N/A 
+`WanFirewallPolicyInput` [WanFirewallPolicyInput] - (optional) N/A 
+`accountId` [ID] - (required) N/A 

catocli/parsers/query_siteLocation/README.md

@@ -0,0 +1,26 @@
+
+
+## CATO-CLI - query.siteLocation:
+
+### Usage for query.siteLocation:
+
+`catocli query siteLocation -h`
+
+`catocli query siteLocation <accountID> <json>`
+
+`catocli query siteLocation 12345 "$(cat < siteLocation.json)"`
+
+`catocli query siteLocation 12345 '{"filters":[{"search": "Your city here","field":"city","operation":"exact"}]}'`
+
+`catocli query siteLocation 12345 '{"filters":[{"search": "Your Country here","field":"countryName","operation":"startsWith"}]}'`
+
+`catocli query siteLocation 12345 '{"filters":[{"search": "Your stateName here","field":"stateName","operation":"endsWith"}]}'`
+
+`catocli query siteLocation 12345 '{filters:[{"search": "Your City here","field":"city","operation":"startsWith"},{"search": "Your StateName here","field":"stateName","operation":"endsWith"},{"search": "Your Country here","field":"countryName","operation":"contains"}}'`
+
+#### Operation Arguments for query.siteLocation ####
+`accountID` [ID] - (optional) Unique Identifier of Account. 
+`filters[]` [Array] - (optional) Array of objects consisting of `search`, `field` and `operation` attributes.
+`filters[].search` [String] - (required) String to match countryName, stateName, or city specificed in `filters[].field`.
+`filters[].field` [String] - (required) Specify field to match query against, defaults to look for any.  Possible values: `countryName`, `stateName`, or `city`.
+`filters[].operation` [string] - (required) If a field is specified, operation to match the field value.  Possible values: `startsWith`,`endsWith`,`exact`, `contains`.

catocli/parsers/query_subDomains/README.md

@@ -0,0 +1,17 @@
+
+## CATO-CLI - query.subDomains:
+[Click here](https://api.catonetworks.com/documentation/#query-subDomains) for documentation on this operation.
+
+### Usage for query.subDomains:
+
+`catocli query subDomains -h`
+
+`catocli query subDomains <accountID> <json>`
+
+`catocli query subDomains 12345 "$(cat < subDomains.json)"`
+
+`catocli query subDomains 12345 '{"managedAccount": "Boolean"}'`
+
+#### Operation Arguments for query.subDomains ####
+`accountID` [ID] - (required) Unique Identifier of Account 
+`managedAccount` [Boolean] - (optional) When the boolean argument managedAccount is set to true (default), then the query returns all subdomains related to the account 

catocli/parsers/query_xdr/README.md

@@ -0,0 +1,7 @@
+
+## CATO-CLI - query.xdr:
+[Click here](https://api.catonetworks.com/documentation/#query-xdr) for documentation on this operation.
+
+### Usage for query.xdr:
+
+`catocli query xdr -h`

catocli/parsers/query_xdr_stories/README.md

@@ -0,0 +1,18 @@
+
+## CATO-CLI - query.xdr.stories:
+[Click here](https://api.catonetworks.com/documentation/#query-stories) for documentation on this operation.
+
+### Usage for query.xdr.stories:
+
+`catocli query xdr stories -h`
+
+`catocli query xdr stories <accountID> <json>`
+
+`catocli query xdr stories 12345 "$(cat < stories.json)"`
+
+`catocli query xdr stories 12345 '{"StoryInput": {"PagingInput": {"from": {"from": "Int"}, "limit": {"limit": "Int"}}, "StoryFilterInput": {"accountId": {"in": {"in": ["ID"]}, "not_in": {"not_in": ["ID"]}}, "criticality": {"eq": {"eq": "Int"}, "gt": {"gt": "Int"}, "gte": {"gte": "Int"}, "in": {"in": ["Int"]}, "lt": {"lt": "Int"}, "lte": {"lte": "Int"}, "not_in": {"not_in": ["Int"]}}, "engineType": {"in": {"in": "enum(StoryEngineTypeEnum)"}, "not_in": {"not_in": "enum(StoryEngineTypeEnum)"}}, "incidentId": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "ioa": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "muted": {"is": {"is": "String"}}, "producer": {"in": {"in": "enum(StoryProducerEnum)"}, "not_in": {"not_in": "enum(StoryProducerEnum)"}}, "queryName": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "severity": {"in": {"in": "enum(SeverityEnum)"}, "not_in": {"not_in": "enum(SeverityEnum)"}}, "source": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "sourceIp": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "status": {"in": {"in": "enum(StoryStatusEnum)"}, "not_in": {"not_in": "enum(StoryStatusEnum)"}}, "storyId": {"in": {"in": ["ID"]}, "not_in": {"not_in": ["ID"]}}, "timeFrame": {"time": {"time": "TimeFrame"}, "timeFrameModifier": {"timeFrameModifier": "enum(TimeFrameModifier)"}}, "vendor": {"in": {"in": "enum(VendorEnum)"}, "not_in": {"not_in": "enum(VendorEnum)"}}, "verdict": {"in": {"in": "enum(StoryVerdictEnum)"}, "not_in": {"not_in": "enum(StoryVerdictEnum)"}}}, "StorySortInput": {"fieldName": {"fieldName": "enum(StorySortFieldName)"}, "order": {"order": "enum(SortDirectionEnum)"}}}, "perSecond": "Boolean"}'`
+
+#### Operation Arguments for query.xdr.stories ####
+`StoryInput` [StoryInput] - (required) N/A 
+`accountID` [ID] - (required) N/A 
+`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity)