catocli 1.0.15__py3-none-any.whl → 1.0.17__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of catocli might be problematic. Click here for more details.

Files changed (139) hide show
  1. catocli/Utils/clidriver.py +14 -1
  2. catocli/__init__.py +1 -1
  3. catocli/parsers/mutation_policy/__init__.py +348 -0
  4. catocli/parsers/mutation_policy_appTenantRestriction/README.md +7 -0
  5. catocli/parsers/mutation_policy_appTenantRestriction_addRule/README.md +18 -0
  6. catocli/parsers/mutation_policy_appTenantRestriction_addSection/README.md +18 -0
  7. catocli/parsers/mutation_policy_appTenantRestriction_createPolicyRevision/README.md +18 -0
  8. catocli/parsers/mutation_policy_appTenantRestriction_discardPolicyRevision/README.md +18 -0
  9. catocli/parsers/mutation_policy_appTenantRestriction_moveRule/README.md +18 -0
  10. catocli/parsers/mutation_policy_appTenantRestriction_moveSection/README.md +18 -0
  11. catocli/parsers/mutation_policy_appTenantRestriction_publishPolicyRevision/README.md +18 -0
  12. catocli/parsers/mutation_policy_appTenantRestriction_removeRule/README.md +18 -0
  13. catocli/parsers/mutation_policy_appTenantRestriction_removeSection/README.md +18 -0
  14. catocli/parsers/mutation_policy_appTenantRestriction_updatePolicy/README.md +18 -0
  15. catocli/parsers/mutation_policy_appTenantRestriction_updateRule/README.md +18 -0
  16. catocli/parsers/mutation_policy_appTenantRestriction_updateSection/README.md +18 -0
  17. catocli/parsers/mutation_policy_remotePortFwd/README.md +7 -0
  18. catocli/parsers/mutation_policy_remotePortFwd_addRule/README.md +18 -0
  19. catocli/parsers/mutation_policy_remotePortFwd_addSection/README.md +18 -0
  20. catocli/parsers/mutation_policy_remotePortFwd_createPolicyRevision/README.md +18 -0
  21. catocli/parsers/mutation_policy_remotePortFwd_discardPolicyRevision/README.md +18 -0
  22. catocli/parsers/mutation_policy_remotePortFwd_moveRule/README.md +18 -0
  23. catocli/parsers/mutation_policy_remotePortFwd_moveSection/README.md +18 -0
  24. catocli/parsers/mutation_policy_remotePortFwd_publishPolicyRevision/README.md +18 -0
  25. catocli/parsers/mutation_policy_remotePortFwd_removeRule/README.md +18 -0
  26. catocli/parsers/mutation_policy_remotePortFwd_removeSection/README.md +18 -0
  27. catocli/parsers/mutation_policy_remotePortFwd_updatePolicy/README.md +18 -0
  28. catocli/parsers/mutation_policy_remotePortFwd_updateRule/README.md +18 -0
  29. catocli/parsers/mutation_policy_remotePortFwd_updateSection/README.md +18 -0
  30. catocli/parsers/mutation_site/__init__.py +98 -0
  31. catocli/parsers/mutation_site_addBgpPeer/README.md +17 -0
  32. catocli/parsers/mutation_site_addCloudInterconnectPhysicalConnection/README.md +17 -0
  33. catocli/parsers/mutation_site_addCloudInterconnectSite/README.md +17 -0
  34. catocli/parsers/mutation_site_removeBgpPeer/README.md +17 -0
  35. catocli/parsers/mutation_site_removeCloudInterconnectPhysicalConnection/README.md +17 -0
  36. catocli/parsers/mutation_site_updateBgpPeer/README.md +17 -0
  37. catocli/parsers/mutation_site_updateCloudInterconnectPhysicalConnection/README.md +17 -0
  38. catocli/parsers/mutation_site_updateIpsecIkeV2SiteTunnels/README.md +1 -1
  39. catocli/parsers/mutation_sites/__init__.py +98 -0
  40. catocli/parsers/mutation_sites_addBgpPeer/README.md +17 -0
  41. catocli/parsers/mutation_sites_addCloudInterconnectPhysicalConnection/README.md +17 -0
  42. catocli/parsers/mutation_sites_addCloudInterconnectSite/README.md +17 -0
  43. catocli/parsers/mutation_sites_removeBgpPeer/README.md +17 -0
  44. catocli/parsers/mutation_sites_removeCloudInterconnectPhysicalConnection/README.md +17 -0
  45. catocli/parsers/mutation_sites_updateBgpPeer/README.md +17 -0
  46. catocli/parsers/mutation_sites_updateCloudInterconnectPhysicalConnection/README.md +17 -0
  47. catocli/parsers/mutation_sites_updateIpsecIkeV2SiteTunnels/README.md +1 -1
  48. catocli/parsers/query_eventsFeed/README.md +1 -1
  49. catocli/parsers/query_hardwareManagement/README.md +1 -1
  50. catocli/parsers/query_policy/README.md +3 -1
  51. catocli/parsers/query_site/README.md +22 -0
  52. catocli/parsers/query_site/__init__.py +17 -0
  53. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/METADATA +11 -2
  54. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/RECORD +139 -58
  55. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/WHEEL +1 -1
  56. models/mutation.policy.appTenantRestriction.addRule.json +8674 -0
  57. models/mutation.policy.appTenantRestriction.addSection.json +1358 -0
  58. models/mutation.policy.appTenantRestriction.createPolicyRevision.json +3327 -0
  59. models/mutation.policy.appTenantRestriction.discardPolicyRevision.json +3261 -0
  60. models/mutation.policy.appTenantRestriction.moveRule.json +3059 -0
  61. models/mutation.policy.appTenantRestriction.moveSection.json +1259 -0
  62. models/mutation.policy.appTenantRestriction.publishPolicyRevision.json +3318 -0
  63. models/mutation.policy.appTenantRestriction.removeRule.json +2707 -0
  64. models/mutation.policy.appTenantRestriction.removeSection.json +958 -0
  65. models/mutation.policy.appTenantRestriction.updatePolicy.json +3337 -0
  66. models/mutation.policy.appTenantRestriction.updateRule.json +8295 -0
  67. models/mutation.policy.appTenantRestriction.updateSection.json +1111 -0
  68. models/mutation.policy.remotePortFwd.addRule.json +5502 -0
  69. models/mutation.policy.remotePortFwd.addSection.json +1358 -0
  70. models/mutation.policy.remotePortFwd.createPolicyRevision.json +2628 -0
  71. models/mutation.policy.remotePortFwd.discardPolicyRevision.json +2562 -0
  72. models/mutation.policy.remotePortFwd.moveRule.json +2360 -0
  73. models/mutation.policy.remotePortFwd.moveSection.json +1259 -0
  74. models/mutation.policy.remotePortFwd.publishPolicyRevision.json +2619 -0
  75. models/mutation.policy.remotePortFwd.removeRule.json +2008 -0
  76. models/mutation.policy.remotePortFwd.removeSection.json +958 -0
  77. models/mutation.policy.remotePortFwd.updatePolicy.json +2638 -0
  78. models/mutation.policy.remotePortFwd.updateRule.json +5138 -0
  79. models/mutation.policy.remotePortFwd.updateSection.json +1111 -0
  80. models/mutation.site.addBgpPeer.json +3334 -0
  81. models/mutation.site.addCloudInterconnectPhysicalConnection.json +1441 -0
  82. models/mutation.site.addCloudInterconnectSite.json +911 -0
  83. models/mutation.site.addIpsecIkeV2Site.json +2 -2
  84. models/mutation.site.addIpsecIkeV2SiteTunnels.json +2 -2
  85. models/mutation.site.addNetworkRange.json +2 -2
  86. models/mutation.site.addSocketSite.json +2 -2
  87. models/mutation.site.addStaticHost.json +2 -2
  88. models/mutation.site.removeBgpPeer.json +1158 -0
  89. models/mutation.site.removeCloudInterconnectPhysicalConnection.json +298 -0
  90. models/mutation.site.removeIpsecIkeV2SiteTunnels.json +2 -2
  91. models/mutation.site.removeNetworkRange.json +2 -2
  92. models/mutation.site.removeSite.json +2 -2
  93. models/mutation.site.removeStaticHost.json +2 -2
  94. models/mutation.site.updateBgpPeer.json +3063 -0
  95. models/mutation.site.updateCloudInterconnectPhysicalConnection.json +1056 -0
  96. models/mutation.site.updateHa.json +2 -2
  97. models/mutation.site.updateIpsecIkeV2SiteGeneralDetails.json +2 -2
  98. models/mutation.site.updateIpsecIkeV2SiteTunnels.json +405 -2
  99. models/mutation.site.updateNetworkRange.json +2 -2
  100. models/mutation.site.updateSiteGeneralDetails.json +2 -2
  101. models/mutation.site.updateSocketInterface.json +2 -2
  102. models/mutation.site.updateStaticHost.json +2 -2
  103. models/mutation.sites.addBgpPeer.json +3334 -0
  104. models/mutation.sites.addCloudInterconnectPhysicalConnection.json +1441 -0
  105. models/mutation.sites.addCloudInterconnectSite.json +911 -0
  106. models/mutation.sites.addIpsecIkeV2Site.json +2 -2
  107. models/mutation.sites.addIpsecIkeV2SiteTunnels.json +2 -2
  108. models/mutation.sites.addNetworkRange.json +2 -2
  109. models/mutation.sites.addSocketSite.json +2 -2
  110. models/mutation.sites.addStaticHost.json +2 -2
  111. models/mutation.sites.removeBgpPeer.json +1158 -0
  112. models/mutation.sites.removeCloudInterconnectPhysicalConnection.json +298 -0
  113. models/mutation.sites.removeIpsecIkeV2SiteTunnels.json +2 -2
  114. models/mutation.sites.removeNetworkRange.json +2 -2
  115. models/mutation.sites.removeSite.json +2 -2
  116. models/mutation.sites.removeStaticHost.json +2 -2
  117. models/mutation.sites.updateBgpPeer.json +3063 -0
  118. models/mutation.sites.updateCloudInterconnectPhysicalConnection.json +1056 -0
  119. models/mutation.sites.updateHa.json +2 -2
  120. models/mutation.sites.updateIpsecIkeV2SiteGeneralDetails.json +2 -2
  121. models/mutation.sites.updateIpsecIkeV2SiteTunnels.json +405 -2
  122. models/mutation.sites.updateNetworkRange.json +2 -2
  123. models/mutation.sites.updateSiteGeneralDetails.json +2 -2
  124. models/mutation.sites.updateSocketInterface.json +2 -2
  125. models/mutation.sites.updateStaticHost.json +2 -2
  126. models/query.auditFeed.json +36 -12
  127. models/query.events.json +144 -48
  128. models/query.eventsFeed.json +36 -12
  129. models/query.eventsTimeSeries.json +108 -36
  130. models/query.hardwareManagement.json +192 -0
  131. models/query.licensing.json +304 -325
  132. models/query.policy.json +9605 -4234
  133. models/query.site.json +4138 -0
  134. models/query.xdr.stories.json +27 -27
  135. models/query.xdr.story.json +27 -27
  136. schema/catolib.py +11 -1
  137. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/LICENSE +0 -0
  138. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/entry_points.txt +0 -0
  139. {catocli-1.0.15.dist-info → catocli-1.0.17.dist-info}/top_level.txt +0 -0
models/query.xdr.stories.json CHANGED
@@ -6945,7 +6945,7 @@
6945
6945
  "alias": "connectionTypeEnumConnectionType: connectionType",
6946
6946
  "args": {},
6947
6947
  "deprecationReason": null,
6948
- "description": "Enum for the connection for this incident (ie. site, host, user)",
6948
+ "description": "Connection for the incident",
6949
6949
  "id_str": "stories___items___incident___connectionType",
6950
6950
  "isDeprecated": false,
6951
6951
  "name": "connectionType",
@@ -7260,7 +7260,7 @@
7260
7260
  "alias": "storyProducerEnumProducer: producer",
7261
7261
  "args": {},
7262
7262
  "deprecationReason": null,
7263
- "description": "Enum for the Producer (specific XDR engine and service) involved with the incident",
7263
+ "description": "Producer (specific XDR engine and service) involved with the incident",
7264
7264
  "id_str": "stories___items___incident___producer",
7265
7265
  "isDeprecated": false,
7266
7266
  "name": "producer",
@@ -7482,10 +7482,10 @@
7482
7482
  },
7483
7483
  "siteName": {
7484
7484
  "args": {},
7485
- "deprecationReason": null,
7485
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
7486
7486
  "description": "Site name related to the story",
7487
7487
  "id_str": "stories___items___incident___siteName",
7488
- "isDeprecated": false,
7488
+ "isDeprecated": true,
7489
7489
  "name": "siteName",
7490
7490
  "path": "stories.items.incident.siteName",
7491
7491
  "requestStr": "$siteName:String ",
@@ -7544,7 +7544,7 @@
7544
7544
  "alias": "storyStatusEnumStatus: status",
7545
7545
  "args": {},
7546
7546
  "deprecationReason": null,
7547
- "description": "Enum for the status of this story (ie. Open, Closed, Monitoring)",
7547
+ "description": "Status for the story",
7548
7548
  "id_str": "stories___items___incident___status",
7549
7549
  "isDeprecated": false,
7550
7550
  "name": "status",
@@ -9449,10 +9449,10 @@
9449
9449
  "siteName": {
9450
9450
  "alias": "anomalyEventsSiteName: siteName",
9451
9451
  "args": {},
9452
- "deprecationReason": null,
9452
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
9453
9453
  "description": null,
9454
9454
  "id_str": "stories___items___incident___AnomalyEvents___siteName",
9455
- "isDeprecated": false,
9455
+ "isDeprecated": true,
9456
9456
  "name": "siteName",
9457
9457
  "path": "stories.items.incident.AnomalyEvents.siteName",
9458
9458
  "requestStr": "$siteName:String ",
@@ -12471,10 +12471,10 @@
12471
12471
  "siteName": {
12472
12472
  "alias": "anomalyStatsSiteName: siteName",
12473
12473
  "args": {},
12474
- "deprecationReason": null,
12474
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
12475
12475
  "description": null,
12476
12476
  "id_str": "stories___items___incident___AnomalyStats___siteName",
12477
- "isDeprecated": false,
12477
+ "isDeprecated": true,
12478
12478
  "name": "siteName",
12479
12479
  "path": "stories.items.incident.AnomalyStats.siteName",
12480
12480
  "requestStr": "$siteName:String ",
@@ -26983,7 +26983,7 @@
26983
26983
  "alias": "threatConnectionType: connectionType",
26984
26984
  "args": {},
26985
26985
  "deprecationReason": null,
26986
- "description": "Enum for the connection for this incident (ie. site, host, user)",
26986
+ "description": "Connection for this incident",
26987
26987
  "id_str": "stories___items___incident___Threat___connectionType",
26988
26988
  "isDeprecated": false,
26989
26989
  "name": "connectionType",
@@ -28264,7 +28264,7 @@
28264
28264
  "alias": "threatPredictedThreatType: predictedThreatType",
28265
28265
  "args": {},
28266
28266
  "deprecationReason": null,
28267
- "description": "Cato\u2019s predicted threat type for the story",
28267
+ "description": "Predicted threat type for the story based on Cato algorithm",
28268
28268
  "id_str": "stories___items___incident___Threat___predictedThreatType",
28269
28269
  "isDeprecated": false,
28270
28270
  "name": "predictedThreatType",
@@ -28285,7 +28285,7 @@
28285
28285
  "alias": "threatPredictedVerdict: predictedVerdict",
28286
28286
  "args": {},
28287
28287
  "deprecationReason": null,
28288
- "description": "Enum for Cato\u2019s predicted verdict of the story (ie. Malicious, Benign)",
28288
+ "description": "Predicted verdict of the story based on Cato algorithm",
28289
28289
  "id_str": "stories___items___incident___Threat___predictedVerdict",
28290
28290
  "isDeprecated": false,
28291
28291
  "name": "predictedVerdict",
@@ -28342,7 +28342,7 @@
28342
28342
  "alias": "threatProducer: producer",
28343
28343
  "args": {},
28344
28344
  "deprecationReason": null,
28345
- "description": "Enum for the Producer (specific XDR engine and service) involved with the incident",
28345
+ "description": "Producer (specific XDR engine and service) involved with the incident",
28346
28346
  "id_str": "stories___items___incident___Threat___producer",
28347
28347
  "isDeprecated": false,
28348
28348
  "name": "producer",
@@ -28797,10 +28797,10 @@
28797
28797
  "siteName": {
28798
28798
  "alias": "threatSiteName: siteName",
28799
28799
  "args": {},
28800
- "deprecationReason": null,
28800
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
28801
28801
  "description": "Site name related to the story",
28802
28802
  "id_str": "stories___items___incident___Threat___siteName",
28803
- "isDeprecated": false,
28803
+ "isDeprecated": true,
28804
28804
  "name": "siteName",
28805
28805
  "path": "stories.items.incident.Threat.siteName",
28806
28806
  "requestStr": "$siteName:String ",
@@ -28881,7 +28881,7 @@
28881
28881
  "alias": "threatStatus: status",
28882
28882
  "args": {},
28883
28883
  "deprecationReason": null,
28884
- "description": "Enum for the status of this story (ie. Open, Closed, Monitoring)",
28884
+ "description": "Status of this story",
28885
28885
  "id_str": "stories___items___incident___Threat___status",
28886
28886
  "isDeprecated": false,
28887
28887
  "name": "status",
@@ -31727,10 +31727,10 @@
31727
31727
  "siteName": {
31728
31728
  "alias": "threatPreventionSiteName: siteName",
31729
31729
  "args": {},
31730
- "deprecationReason": null,
31730
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
31731
31731
  "description": null,
31732
31732
  "id_str": "stories___items___incident___ThreatPrevention___siteName",
31733
- "isDeprecated": false,
31733
+ "isDeprecated": true,
31734
31734
  "name": "siteName",
31735
31735
  "path": "stories.items.incident.ThreatPrevention.siteName",
31736
31736
  "requestStr": "$siteName:String ",
@@ -33635,7 +33635,7 @@
33635
33635
  "responseStr": "timeline:$timelineItem ",
33636
33636
  "type": {
33637
33637
  "definition": {
33638
- "description": null,
33638
+ "description": "For XDR stories, items that happened during the lifetime of the story",
33639
33639
  "enumValues": null,
33640
33640
  "fields": {
33641
33641
  "additionalInfo": {
@@ -33735,7 +33735,7 @@
33735
33735
  "alias": "timelineItemCategoryEnumCategory: category",
33736
33736
  "args": {},
33737
33737
  "deprecationReason": null,
33738
- "description": "Enum for the timeline category (ie. Information, Warning, Error)",
33738
+ "description": "Icon for the timeline item",
33739
33739
  "id_str": "stories___items___timeline___category",
33740
33740
  "isDeprecated": false,
33741
33741
  "name": "category",
@@ -33785,7 +33785,7 @@
33785
33785
  "context": {
33786
33786
  "args": {},
33787
33787
  "deprecationReason": null,
33788
- "description": "Status of the timeline item",
33788
+ "description": "Brief summary of action related to the timeline item (ie. Story created, Status update to)",
33789
33789
  "id_str": "stories___items___timeline___context",
33790
33790
  "isDeprecated": false,
33791
33791
  "name": "context",
@@ -33806,7 +33806,7 @@
33806
33806
  "createdAt": {
33807
33807
  "args": {},
33808
33808
  "deprecationReason": null,
33809
- "description": "Timestamp the story was created",
33809
+ "description": "Timestamp the timeline item was created",
33810
33810
  "id_str": "stories___items___timeline___createdAt",
33811
33811
  "isDeprecated": false,
33812
33812
  "name": "createdAt",
@@ -33826,10 +33826,10 @@
33826
33826
  },
33827
33827
  "description": {
33828
33828
  "args": {},
33829
- "deprecationReason": null,
33830
- "description": "Description for the story in the timeline",
33829
+ "deprecationReason": "use 'descriptions' instead",
33830
+ "description": "Description of the timeline item",
33831
33831
  "id_str": "stories___items___timeline___description",
33832
- "isDeprecated": false,
33832
+ "isDeprecated": true,
33833
33833
  "name": "description",
33834
33834
  "path": "stories.items.timeline.description",
33835
33835
  "requestStr": "$description:String! ",
@@ -33848,7 +33848,7 @@
33848
33848
  "descriptions": {
33849
33849
  "args": {},
33850
33850
  "deprecationReason": null,
33851
- "description": "Description for the story in the timeline",
33851
+ "description": "Description of the timeline item",
33852
33852
  "id_str": "stories___items___timeline___descriptions",
33853
33853
  "isDeprecated": false,
33854
33854
  "name": "descriptions",
@@ -33872,7 +33872,7 @@
33872
33872
  "alias": "timelineTypeEnumType: type",
33873
33873
  "args": {},
33874
33874
  "deprecationReason": null,
33875
- "description": "Enum for the type (ie. Diff, Action, Comment)",
33875
+ "description": "Type of threat assigned by the analyst",
33876
33876
  "id_str": "stories___items___timeline___type",
33877
33877
  "isDeprecated": false,
33878
33878
  "name": "type",
models/query.xdr.story.json CHANGED
@@ -953,7 +953,7 @@
953
953
  "alias": "connectionTypeEnumConnectionType: connectionType",
954
954
  "args": {},
955
955
  "deprecationReason": null,
956
- "description": "Enum for the connection for this incident (ie. site, host, user)",
956
+ "description": "Connection for the incident",
957
957
  "id_str": "story___incident___connectionType",
958
958
  "isDeprecated": false,
959
959
  "name": "connectionType",
@@ -1268,7 +1268,7 @@
1268
1268
  "alias": "storyProducerEnumProducer: producer",
1269
1269
  "args": {},
1270
1270
  "deprecationReason": null,
1271
- "description": "Enum for the Producer (specific XDR engine and service) involved with the incident",
1271
+ "description": "Producer (specific XDR engine and service) involved with the incident",
1272
1272
  "id_str": "story___incident___producer",
1273
1273
  "isDeprecated": false,
1274
1274
  "name": "producer",
@@ -1490,10 +1490,10 @@
1490
1490
  },
1491
1491
  "siteName": {
1492
1492
  "args": {},
1493
- "deprecationReason": null,
1493
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
1494
1494
  "description": "Site name related to the story",
1495
1495
  "id_str": "story___incident___siteName",
1496
- "isDeprecated": false,
1496
+ "isDeprecated": true,
1497
1497
  "name": "siteName",
1498
1498
  "path": "story.incident.siteName",
1499
1499
  "requestStr": "$siteName:String ",
@@ -1552,7 +1552,7 @@
1552
1552
  "alias": "storyStatusEnumStatus: status",
1553
1553
  "args": {},
1554
1554
  "deprecationReason": null,
1555
- "description": "Enum for the status of this story (ie. Open, Closed, Monitoring)",
1555
+ "description": "Status for the story",
1556
1556
  "id_str": "story___incident___status",
1557
1557
  "isDeprecated": false,
1558
1558
  "name": "status",
@@ -3457,10 +3457,10 @@
3457
3457
  "siteName": {
3458
3458
  "alias": "anomalyEventsSiteName: siteName",
3459
3459
  "args": {},
3460
- "deprecationReason": null,
3460
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
3461
3461
  "description": null,
3462
3462
  "id_str": "story___incident___AnomalyEvents___siteName",
3463
- "isDeprecated": false,
3463
+ "isDeprecated": true,
3464
3464
  "name": "siteName",
3465
3465
  "path": "story.incident.AnomalyEvents.siteName",
3466
3466
  "requestStr": "$siteName:String ",
@@ -6479,10 +6479,10 @@
6479
6479
  "siteName": {
6480
6480
  "alias": "anomalyStatsSiteName: siteName",
6481
6481
  "args": {},
6482
- "deprecationReason": null,
6482
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
6483
6483
  "description": null,
6484
6484
  "id_str": "story___incident___AnomalyStats___siteName",
6485
- "isDeprecated": false,
6485
+ "isDeprecated": true,
6486
6486
  "name": "siteName",
6487
6487
  "path": "story.incident.AnomalyStats.siteName",
6488
6488
  "requestStr": "$siteName:String ",
@@ -20991,7 +20991,7 @@
20991
20991
  "alias": "threatConnectionType: connectionType",
20992
20992
  "args": {},
20993
20993
  "deprecationReason": null,
20994
- "description": "Enum for the connection for this incident (ie. site, host, user)",
20994
+ "description": "Connection for this incident",
20995
20995
  "id_str": "story___incident___Threat___connectionType",
20996
20996
  "isDeprecated": false,
20997
20997
  "name": "connectionType",
@@ -22272,7 +22272,7 @@
22272
22272
  "alias": "threatPredictedThreatType: predictedThreatType",
22273
22273
  "args": {},
22274
22274
  "deprecationReason": null,
22275
- "description": "Cato\u2019s predicted threat type for the story",
22275
+ "description": "Predicted threat type for the story based on Cato algorithm",
22276
22276
  "id_str": "story___incident___Threat___predictedThreatType",
22277
22277
  "isDeprecated": false,
22278
22278
  "name": "predictedThreatType",
@@ -22293,7 +22293,7 @@
22293
22293
  "alias": "threatPredictedVerdict: predictedVerdict",
22294
22294
  "args": {},
22295
22295
  "deprecationReason": null,
22296
- "description": "Enum for Cato\u2019s predicted verdict of the story (ie. Malicious, Benign)",
22296
+ "description": "Predicted verdict of the story based on Cato algorithm",
22297
22297
  "id_str": "story___incident___Threat___predictedVerdict",
22298
22298
  "isDeprecated": false,
22299
22299
  "name": "predictedVerdict",
@@ -22350,7 +22350,7 @@
22350
22350
  "alias": "threatProducer: producer",
22351
22351
  "args": {},
22352
22352
  "deprecationReason": null,
22353
- "description": "Enum for the Producer (specific XDR engine and service) involved with the incident",
22353
+ "description": "Producer (specific XDR engine and service) involved with the incident",
22354
22354
  "id_str": "story___incident___Threat___producer",
22355
22355
  "isDeprecated": false,
22356
22356
  "name": "producer",
@@ -22805,10 +22805,10 @@
22805
22805
  "siteName": {
22806
22806
  "alias": "threatSiteName: siteName",
22807
22807
  "args": {},
22808
- "deprecationReason": null,
22808
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
22809
22809
  "description": "Site name related to the story",
22810
22810
  "id_str": "story___incident___Threat___siteName",
22811
- "isDeprecated": false,
22811
+ "isDeprecated": true,
22812
22812
  "name": "siteName",
22813
22813
  "path": "story.incident.Threat.siteName",
22814
22814
  "requestStr": "$siteName:String ",
@@ -22889,7 +22889,7 @@
22889
22889
  "alias": "threatStatus: status",
22890
22890
  "args": {},
22891
22891
  "deprecationReason": null,
22892
- "description": "Enum for the status of this story (ie. Open, Closed, Monitoring)",
22892
+ "description": "Status of this story",
22893
22893
  "id_str": "story___incident___Threat___status",
22894
22894
  "isDeprecated": false,
22895
22895
  "name": "status",
@@ -25735,10 +25735,10 @@
25735
25735
  "siteName": {
25736
25736
  "alias": "threatPreventionSiteName: siteName",
25737
25737
  "args": {},
25738
- "deprecationReason": null,
25738
+ "deprecationReason": "'siteName' is deprecated, use 'site.name' instead",
25739
25739
  "description": null,
25740
25740
  "id_str": "story___incident___ThreatPrevention___siteName",
25741
- "isDeprecated": false,
25741
+ "isDeprecated": true,
25742
25742
  "name": "siteName",
25743
25743
  "path": "story.incident.ThreatPrevention.siteName",
25744
25744
  "requestStr": "$siteName:String ",
@@ -27642,7 +27642,7 @@
27642
27642
  "responseStr": "timeline:$timelineItem ",
27643
27643
  "type": {
27644
27644
  "definition": {
27645
- "description": null,
27645
+ "description": "For XDR stories, items that happened during the lifetime of the story",
27646
27646
  "enumValues": null,
27647
27647
  "fields": {
27648
27648
  "additionalInfo": {
@@ -27742,7 +27742,7 @@
27742
27742
  "alias": "timelineItemCategoryEnumCategory: category",
27743
27743
  "args": {},
27744
27744
  "deprecationReason": null,
27745
- "description": "Enum for the timeline category (ie. Information, Warning, Error)",
27745
+ "description": "Icon for the timeline item",
27746
27746
  "id_str": "story___timeline___category",
27747
27747
  "isDeprecated": false,
27748
27748
  "name": "category",
@@ -27792,7 +27792,7 @@
27792
27792
  "context": {
27793
27793
  "args": {},
27794
27794
  "deprecationReason": null,
27795
- "description": "Status of the timeline item",
27795
+ "description": "Brief summary of action related to the timeline item (ie. Story created, Status update to)",
27796
27796
  "id_str": "story___timeline___context",
27797
27797
  "isDeprecated": false,
27798
27798
  "name": "context",
@@ -27813,7 +27813,7 @@
27813
27813
  "createdAt": {
27814
27814
  "args": {},
27815
27815
  "deprecationReason": null,
27816
- "description": "Timestamp the story was created",
27816
+ "description": "Timestamp the timeline item was created",
27817
27817
  "id_str": "story___timeline___createdAt",
27818
27818
  "isDeprecated": false,
27819
27819
  "name": "createdAt",
@@ -27833,10 +27833,10 @@
27833
27833
  },
27834
27834
  "description": {
27835
27835
  "args": {},
27836
- "deprecationReason": null,
27837
- "description": "Description for the story in the timeline",
27836
+ "deprecationReason": "use 'descriptions' instead",
27837
+ "description": "Description of the timeline item",
27838
27838
  "id_str": "story___timeline___description",
27839
- "isDeprecated": false,
27839
+ "isDeprecated": true,
27840
27840
  "name": "description",
27841
27841
  "path": "story.timeline.description",
27842
27842
  "requestStr": "$description:String! ",
@@ -27855,7 +27855,7 @@
27855
27855
  "descriptions": {
27856
27856
  "args": {},
27857
27857
  "deprecationReason": null,
27858
- "description": "Description for the story in the timeline",
27858
+ "description": "Description of the timeline item",
27859
27859
  "id_str": "story___timeline___descriptions",
27860
27860
  "isDeprecated": false,
27861
27861
  "name": "descriptions",
@@ -27879,7 +27879,7 @@
27879
27879
  "alias": "timelineTypeEnumType: type",
27880
27880
  "args": {},
27881
27881
  "deprecationReason": null,
27882
- "description": "Enum for the type (ie. Diff, Action, Comment)",
27882
+ "description": "Type of threat assigned by the analyst",
27883
27883
  "id_str": "story___timeline___type",
27884
27884
  "isDeprecated": false,
27885
27885
  "name": "type",
schema/catolib.py CHANGED
@@ -503,6 +503,9 @@ def writeCliDriver(catoApiSchema):
503
503
  operationNameAry = operation.split(".")
504
504
  parsersIndex[operationNameAry[0]+"_"+operationNameAry[1]] = True
505
505
  parsers = list(parsersIndex.keys())
506
+
507
+
508
+
506
509
  cliDriverStr = """
507
510
  import os
508
511
  import argparse
@@ -536,7 +539,14 @@ configuration.host = "{}".format(catocli.__cato_host__)
536
539
  configuration.debug = CATO_DEBUG
537
540
  configuration.version = "{}".format(catocli.__version__)
538
541
 
539
- parser = argparse.ArgumentParser(prog='catocli', usage='%(prog)s <operationType> <operationName> [options]', description="CLI for query on CATO via API.")
542
+ defaultReadmeStr = \"""
543
+ The Cato CLI is a command-line interface tool designed to simplify the management and automation of Cato Networks’ configurations and operations.
544
+ It enables users to interact with Cato’s API for tasks such as managing Cato Management Application (CMA) site and account configurations, security policies, retrieving events, etc.\n\n
545
+ For assistance in generating syntax for the cli to perform various operations, please refer to the Cato API Explorer application.\n\n
546
+ https://github.com/catonetworks/cato-api-explorer
547
+ \"""
548
+
549
+ parser = argparse.ArgumentParser(prog='catocli', usage='%(prog)s <operationType> <operationName> [options]', description=defaultReadmeStr)
540
550
  parser.add_argument('--version', action='version', version=catocli.__version__)
541
551
  subparsers = parser.add_subparsers()
542
552
  custom_parsers = custom_parse(subparsers)