catocli 3.0.25__py3-none-any.whl → 3.0.29__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.
- catocli/Utils/clidriver.py +6 -6
- catocli/Utils/formatter_utils.py +0 -11
- catocli/Utils/help_formatter.py +145 -56
- catocli/__init__.py +1 -1
- catocli/clisettings.json +2 -1
- catocli/parsers/query_accountMetrics/README.md +64 -17
- catocli/parsers/query_appStats/README.md +127 -0
- catocli/parsers/query_appStatsTimeSeries/README.md +110 -26
- catocli/parsers/query_container/__init__.py +118 -10
- catocli/parsers/query_container_fqdn_downloadFile/README.md +27 -0
- catocli/parsers/query_container_fqdn_search/README.md +29 -0
- catocli/parsers/query_container_fqdn_searchFqdn/README.md +26 -0
- catocli/parsers/query_container_ipAddressRange_downloadFile/README.md +27 -0
- catocli/parsers/query_container_ipAddressRange_search/README.md +29 -0
- catocli/parsers/query_container_ipAddressRange_searchIpAddressRange/README.md +29 -0
- catocli/parsers/query_container_list/README.md +30 -0
- catocli/parsers/query_eventsTimeSeries/README.md +36 -59
- catocli/parsers/query_socketPortMetrics/README.md +64 -0
- catocli/parsers/query_socketPortMetricsTimeSeries/README.md +177 -18
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/METADATA +16 -8
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/RECORD +32 -19
- models/query.container.fqdn.downloadFile.json +519 -0
- models/query.container.fqdn.search.json +790 -0
- models/query.container.fqdn.searchFqdn.json +567 -0
- models/query.container.ipAddressRange.downloadFile.json +519 -0
- models/query.container.ipAddressRange.search.json +790 -0
- models/query.container.ipAddressRange.searchIpAddressRange.json +720 -0
- models/query.container.list.json +1316 -0
- catocli/parsers/query_container/README.md +0 -65
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/WHEEL +0 -0
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/entry_points.txt +0 -0
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/licenses/LICENSE +0 -0
- {catocli-3.0.25.dist-info → catocli-3.0.29.dist-info}/top_level.txt +0 -0
|
@@ -41,7 +41,12 @@ catocli query appStatsTimeSeries '{
|
|
|
41
41
|
## Advanced Usage
|
|
42
42
|
### Additional Examples
|
|
43
43
|
- Query to export upstream, downstream and traffic for user_name and application_name for last day broken into 1 hour buckets
|
|
44
|
-
-
|
|
44
|
+
- Traffic patterns throughout the day
|
|
45
|
+
- Wanbound traffic with hourly breakdown
|
|
46
|
+
- Usage patterns over a full week
|
|
47
|
+
- 5-minute intervals for detailed monitoring
|
|
48
|
+
- Business hours with 15-minute granularity
|
|
49
|
+
- User activity patterns with application usage
|
|
45
50
|
|
|
46
51
|
# Query to export upstream, downstream and traffic for user_name and application_name for last day broken into 1 hour buckets
|
|
47
52
|
|
|
@@ -74,51 +79,130 @@ catocli query appStatsTimeSeries '{
|
|
|
74
79
|
}
|
|
75
80
|
],
|
|
76
81
|
"timeFrame": "last.P1D"
|
|
77
|
-
}'
|
|
82
|
+
}' -f csv --csv-filename=appStatsTimeSeries_app_bw.csv
|
|
78
83
|
```
|
|
79
84
|
|
|
80
|
-
|
|
85
|
+
|
|
86
|
+
# Traffic patterns throughout the day
|
|
81
87
|
|
|
82
88
|
```bash
|
|
83
|
-
#
|
|
89
|
+
# Traffic patterns throughout the day
|
|
90
|
+
catocli query appStatsTimeSeries '{
|
|
91
|
+
"buckets": 24,
|
|
92
|
+
"dimension": [
|
|
93
|
+
{"fieldName": "user_name"},
|
|
94
|
+
{"fieldName": "application_name"}
|
|
95
|
+
],
|
|
96
|
+
"perSecond": false,
|
|
97
|
+
"measure": [
|
|
98
|
+
{"aggType": "sum", "fieldName": "upstream"},
|
|
99
|
+
{"aggType": "sum", "fieldName": "downstream"},
|
|
100
|
+
{"aggType": "sum", "fieldName": "traffic"}
|
|
101
|
+
],
|
|
102
|
+
"timeFrame": "last.P1D"
|
|
103
|
+
}' -f csv --csv-filename=appStatsTimeSeries_user_app.csv
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
# Wanbound traffic with hourly breakdown
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
# Wanbound traffic with hourly breakdown
|
|
84
110
|
catocli query appStatsTimeSeries '{
|
|
85
111
|
"appStatsFilter": [
|
|
86
112
|
{
|
|
87
113
|
"fieldName": "traffic_direction",
|
|
88
114
|
"operator": "is",
|
|
89
|
-
"values": [
|
|
90
|
-
"WANBOUND"
|
|
91
|
-
]
|
|
115
|
+
"values": ["WANBOUND"]
|
|
92
116
|
}
|
|
93
117
|
],
|
|
94
118
|
"buckets": 24,
|
|
95
119
|
"dimension": [
|
|
96
|
-
{
|
|
97
|
-
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"fieldName": "user_name"
|
|
101
|
-
}
|
|
120
|
+
{"fieldName": "application_name"},
|
|
121
|
+
{"fieldName": "user_name"}
|
|
102
122
|
],
|
|
103
123
|
"perSecond": false,
|
|
104
124
|
"measure": [
|
|
105
|
-
{
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
},
|
|
109
|
-
{
|
|
110
|
-
"aggType": "sum",
|
|
111
|
-
"fieldName": "upstream"
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"aggType": "sum",
|
|
115
|
-
"fieldName": "downstream"
|
|
116
|
-
}
|
|
125
|
+
{"aggType": "sum", "fieldName": "traffic"},
|
|
126
|
+
{"aggType": "sum", "fieldName": "upstream"},
|
|
127
|
+
{"aggType": "sum", "fieldName": "downstream"}
|
|
117
128
|
],
|
|
118
129
|
"timeFrame": "last.P1D"
|
|
119
|
-
}'
|
|
130
|
+
}' -f csv --csv-filename=appStatsTimeSeries_user_wan.csv
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
# Usage patterns over a full week
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# Usage patterns over a full week
|
|
137
|
+
catocli query appStatsTimeSeries '{
|
|
138
|
+
"buckets": 168,
|
|
139
|
+
"dimension": [
|
|
140
|
+
{"fieldName": "category"},
|
|
141
|
+
{"fieldName": "src_site_name"}
|
|
142
|
+
],
|
|
143
|
+
"perSecond": false,
|
|
144
|
+
"measure": [
|
|
145
|
+
{"aggType": "sum", "fieldName": "traffic"},
|
|
146
|
+
{"aggType": "sum", "fieldName": "flows_created"}
|
|
147
|
+
],
|
|
148
|
+
"timeFrame": "last.P7D"
|
|
149
|
+
}' -f csv --csv-filename appStatsTimeSeries_weekly_usage_category.csv
|
|
120
150
|
```
|
|
121
151
|
|
|
152
|
+
# 5-minute intervals for detailed monitoring
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
# 5-minute intervals for detailed monitoring
|
|
156
|
+
catocli query appStatsTimeSeries '{
|
|
157
|
+
"buckets": 72,
|
|
158
|
+
"dimension": [
|
|
159
|
+
{"fieldName": "user_name"}
|
|
160
|
+
],
|
|
161
|
+
"perSecond": false,
|
|
162
|
+
"measure": [
|
|
163
|
+
{"aggType": "sum", "fieldName": "traffic"}
|
|
164
|
+
],
|
|
165
|
+
"timeFrame": "last.PT6H"
|
|
166
|
+
}' -f csv --csv-filename appStatsTimeSeries_high_resolution_user.csv
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
# Business hours with 15-minute granularity
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
# Business hours with 15-minute granularity
|
|
173
|
+
catocli query appStatsTimeSeries '{
|
|
174
|
+
"buckets": 32,
|
|
175
|
+
"dimension": [
|
|
176
|
+
{"fieldName": "application_name"}
|
|
177
|
+
],
|
|
178
|
+
"perSecond": false,
|
|
179
|
+
"measure": [
|
|
180
|
+
{"aggType": "sum", "fieldName": "traffic"},
|
|
181
|
+
{"aggType": "sum", "fieldName": "flows_created"}
|
|
182
|
+
],
|
|
183
|
+
"timeFrame": "utc.2025-10-{15/08:00:00--15/16:00:00}"
|
|
184
|
+
}' -f csv --csv-filename appStatsTimeSeries_bus_hours.csv
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
# User activity patterns with application usage
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
# User activity patterns with application usage
|
|
191
|
+
catocli query appStatsTimeSeries '{
|
|
192
|
+
"buckets": 48,
|
|
193
|
+
"dimension": [
|
|
194
|
+
{"fieldName": "user_name"},
|
|
195
|
+
{"fieldName": "categories"}
|
|
196
|
+
],
|
|
197
|
+
"perSecond": false,
|
|
198
|
+
"measure": [
|
|
199
|
+
{"aggType": "sum", "fieldName": "flows_created"}
|
|
200
|
+
],
|
|
201
|
+
"timeFrame": "last.P2D"
|
|
202
|
+
}' -f csv --csv-filename appStatsTimeSeries_user_by_category.csv
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
|
|
122
206
|
|
|
123
207
|
|
|
124
208
|
#### TimeFrame Parameter Examples
|
|
@@ -7,13 +7,121 @@ def query_container_parse(query_subparsers):
|
|
|
7
7
|
help='container() query operation',
|
|
8
8
|
usage=get_help("query_container"), formatter_class=CustomSubparserHelpFormatter)
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
10
|
+
query_container_subparsers = query_container_parser.add_subparsers()
|
|
11
|
+
|
|
12
|
+
query_container_list_parser = query_container_subparsers.add_parser('list',
|
|
13
|
+
help='list() container operation',
|
|
14
|
+
usage=get_help("query_container_list"))
|
|
15
|
+
|
|
16
|
+
query_container_list_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
17
|
+
query_container_list_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
18
|
+
query_container_list_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
19
|
+
query_container_list_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
20
|
+
query_container_list_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
21
|
+
query_container_list_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
22
|
+
query_container_list_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
23
|
+
query_container_list_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
24
|
+
query_container_list_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
25
|
+
query_container_list_parser.set_defaults(func=createRequest,operation_name='query.container.list')
|
|
26
|
+
|
|
27
|
+
query_container_ipAddressRange_parser = query_container_subparsers.add_parser('ipAddressRange',
|
|
28
|
+
help='ipAddressRange() container operation',
|
|
29
|
+
usage=get_help("query_container_ipAddressRange"))
|
|
30
|
+
|
|
31
|
+
query_container_ipAddressRange_subparsers = query_container_ipAddressRange_parser.add_subparsers()
|
|
32
|
+
|
|
33
|
+
query_container_ipAddressRange_search_parser = query_container_ipAddressRange_subparsers.add_parser('search',
|
|
34
|
+
help='search() ipAddressRange operation',
|
|
35
|
+
usage=get_help("query_container_ipAddressRange_search"))
|
|
36
|
+
|
|
37
|
+
query_container_ipAddressRange_search_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
38
|
+
query_container_ipAddressRange_search_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
39
|
+
query_container_ipAddressRange_search_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
40
|
+
query_container_ipAddressRange_search_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
41
|
+
query_container_ipAddressRange_search_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
42
|
+
query_container_ipAddressRange_search_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
43
|
+
query_container_ipAddressRange_search_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
44
|
+
query_container_ipAddressRange_search_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
45
|
+
query_container_ipAddressRange_search_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
46
|
+
query_container_ipAddressRange_search_parser.set_defaults(func=createRequest,operation_name='query.container.ipAddressRange.search')
|
|
47
|
+
|
|
48
|
+
query_container_ipAddressRange_searchIpAddressRange_parser = query_container_ipAddressRange_subparsers.add_parser('searchIpAddressRange',
|
|
49
|
+
help='searchIpAddressRange() ipAddressRange operation',
|
|
50
|
+
usage=get_help("query_container_ipAddressRange_searchIpAddressRange"))
|
|
51
|
+
|
|
52
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
53
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
54
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
55
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
56
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
57
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
58
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
59
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
60
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
61
|
+
query_container_ipAddressRange_searchIpAddressRange_parser.set_defaults(func=createRequest,operation_name='query.container.ipAddressRange.searchIpAddressRange')
|
|
62
|
+
|
|
63
|
+
query_container_ipAddressRange_downloadFile_parser = query_container_ipAddressRange_subparsers.add_parser('downloadFile',
|
|
64
|
+
help='downloadFile() ipAddressRange operation',
|
|
65
|
+
usage=get_help("query_container_ipAddressRange_downloadFile"))
|
|
66
|
+
|
|
67
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
68
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
69
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
70
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
71
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
72
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
73
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
74
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
75
|
+
query_container_ipAddressRange_downloadFile_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
76
|
+
query_container_ipAddressRange_downloadFile_parser.set_defaults(func=createRequest,operation_name='query.container.ipAddressRange.downloadFile')
|
|
77
|
+
|
|
78
|
+
query_container_fqdn_parser = query_container_subparsers.add_parser('fqdn',
|
|
79
|
+
help='fqdn() container operation',
|
|
80
|
+
usage=get_help("query_container_fqdn"))
|
|
81
|
+
|
|
82
|
+
query_container_fqdn_subparsers = query_container_fqdn_parser.add_subparsers()
|
|
83
|
+
|
|
84
|
+
query_container_fqdn_search_parser = query_container_fqdn_subparsers.add_parser('search',
|
|
85
|
+
help='search() fqdn operation',
|
|
86
|
+
usage=get_help("query_container_fqdn_search"))
|
|
87
|
+
|
|
88
|
+
query_container_fqdn_search_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
89
|
+
query_container_fqdn_search_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
90
|
+
query_container_fqdn_search_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
91
|
+
query_container_fqdn_search_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
92
|
+
query_container_fqdn_search_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
93
|
+
query_container_fqdn_search_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
94
|
+
query_container_fqdn_search_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
95
|
+
query_container_fqdn_search_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
96
|
+
query_container_fqdn_search_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
97
|
+
query_container_fqdn_search_parser.set_defaults(func=createRequest,operation_name='query.container.fqdn.search')
|
|
98
|
+
|
|
99
|
+
query_container_fqdn_searchFqdn_parser = query_container_fqdn_subparsers.add_parser('searchFqdn',
|
|
100
|
+
help='searchFqdn() fqdn operation',
|
|
101
|
+
usage=get_help("query_container_fqdn_searchFqdn"))
|
|
102
|
+
|
|
103
|
+
query_container_fqdn_searchFqdn_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
104
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
105
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
106
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
107
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
108
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
109
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
110
|
+
query_container_fqdn_searchFqdn_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
111
|
+
query_container_fqdn_searchFqdn_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
112
|
+
query_container_fqdn_searchFqdn_parser.set_defaults(func=createRequest,operation_name='query.container.fqdn.searchFqdn')
|
|
113
|
+
|
|
114
|
+
query_container_fqdn_downloadFile_parser = query_container_fqdn_subparsers.add_parser('downloadFile',
|
|
115
|
+
help='downloadFile() fqdn operation',
|
|
116
|
+
usage=get_help("query_container_fqdn_downloadFile"))
|
|
117
|
+
|
|
118
|
+
query_container_fqdn_downloadFile_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
|
|
119
|
+
query_container_fqdn_downloadFile_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting. This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
|
|
120
|
+
query_container_fqdn_downloadFile_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
|
|
121
|
+
query_container_fqdn_downloadFile_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
|
|
122
|
+
query_container_fqdn_downloadFile_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
|
|
123
|
+
query_container_fqdn_downloadFile_parser.add_argument('-n', '--stream-events', dest='stream_events', help='Send events over network to host:port TCP')
|
|
124
|
+
query_container_fqdn_downloadFile_parser.add_argument('-z', '--sentinel', dest='sentinel', help='Send events to Sentinel customerid:sharedkey')
|
|
125
|
+
query_container_fqdn_downloadFile_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
|
|
126
|
+
query_container_fqdn_downloadFile_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
|
|
127
|
+
query_container_fqdn_downloadFile_parser.set_defaults(func=createRequest,operation_name='query.container.fqdn.downloadFile')
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.fqdn.downloadFile:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.fqdn.downloadFile) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.fqdn.downloadFile:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container fqdn downloadFile -h
|
|
9
|
+
|
|
10
|
+
catocli query container fqdn downloadFile <json>
|
|
11
|
+
|
|
12
|
+
catocli query container fqdn downloadFile "$(cat < query.container.fqdn.downloadFile.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container fqdn downloadFile '{"downloadFqdnContainerFileInput":{"by":"ID","input":"string"}}'
|
|
15
|
+
|
|
16
|
+
catocli query container fqdn downloadFile '{
|
|
17
|
+
"downloadFqdnContainerFileInput": {
|
|
18
|
+
"by": "ID",
|
|
19
|
+
"input": "string"
|
|
20
|
+
}
|
|
21
|
+
}'
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
#### Operation Arguments for query.container.fqdn.downloadFile ####
|
|
25
|
+
|
|
26
|
+
`accountId` [ID] - (required) N/A
|
|
27
|
+
`downloadFqdnContainerFileInput` [DownloadFqdnContainerFileInput] - (required) N/A
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.fqdn.search:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.fqdn.search) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.fqdn.search:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container fqdn search -h
|
|
9
|
+
|
|
10
|
+
catocli query container fqdn search <json>
|
|
11
|
+
|
|
12
|
+
catocli query container fqdn search "$(cat < query.container.fqdn.search.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container fqdn search '{"fqdnContainerSearchInput":{"containerRefInput":{"by":"ID","input":"string"}}}'
|
|
15
|
+
|
|
16
|
+
catocli query container fqdn search '{
|
|
17
|
+
"fqdnContainerSearchInput": {
|
|
18
|
+
"containerRefInput": {
|
|
19
|
+
"by": "ID",
|
|
20
|
+
"input": "string"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
#### Operation Arguments for query.container.fqdn.search ####
|
|
27
|
+
|
|
28
|
+
`accountId` [ID] - (required) N/A
|
|
29
|
+
`fqdnContainerSearchInput` [FqdnContainerSearchInput] - (required) N/A
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.fqdn.searchFqdn:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.fqdn.searchFqdn) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.fqdn.searchFqdn:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container fqdn searchFqdn -h
|
|
9
|
+
|
|
10
|
+
catocli query container fqdn searchFqdn <json>
|
|
11
|
+
|
|
12
|
+
catocli query container fqdn searchFqdn "$(cat < query.container.fqdn.searchFqdn.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container fqdn searchFqdn '{"fqdnContainerSearchFqdnInput":{"fqdn":"example_value"}}'
|
|
15
|
+
|
|
16
|
+
catocli query container fqdn searchFqdn '{
|
|
17
|
+
"fqdnContainerSearchFqdnInput": {
|
|
18
|
+
"fqdn": "example_value"
|
|
19
|
+
}
|
|
20
|
+
}'
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### Operation Arguments for query.container.fqdn.searchFqdn ####
|
|
24
|
+
|
|
25
|
+
`accountId` [ID] - (required) N/A
|
|
26
|
+
`fqdnContainerSearchFqdnInput` [FqdnContainerSearchFqdnInput] - (required) N/A
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.ipAddressRange.downloadFile:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.ipAddressRange.downloadFile) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.ipAddressRange.downloadFile:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container ipAddressRange downloadFile -h
|
|
9
|
+
|
|
10
|
+
catocli query container ipAddressRange downloadFile <json>
|
|
11
|
+
|
|
12
|
+
catocli query container ipAddressRange downloadFile "$(cat < query.container.ipAddressRange.downloadFile.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container ipAddressRange downloadFile '{"downloadIpAddressRangeContainerFileInput":{"by":"ID","input":"string"}}'
|
|
15
|
+
|
|
16
|
+
catocli query container ipAddressRange downloadFile '{
|
|
17
|
+
"downloadIpAddressRangeContainerFileInput": {
|
|
18
|
+
"by": "ID",
|
|
19
|
+
"input": "string"
|
|
20
|
+
}
|
|
21
|
+
}'
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
#### Operation Arguments for query.container.ipAddressRange.downloadFile ####
|
|
25
|
+
|
|
26
|
+
`accountId` [ID] - (required) N/A
|
|
27
|
+
`downloadIpAddressRangeContainerFileInput` [DownloadIpAddressRangeContainerFileInput] - (required) N/A
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.ipAddressRange.search:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.ipAddressRange.search) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.ipAddressRange.search:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container ipAddressRange search -h
|
|
9
|
+
|
|
10
|
+
catocli query container ipAddressRange search <json>
|
|
11
|
+
|
|
12
|
+
catocli query container ipAddressRange search "$(cat < query.container.ipAddressRange.search.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container ipAddressRange search '{"ipAddressRangeContainerSearchInput":{"containerRefInput":{"by":"ID","input":"string"}}}'
|
|
15
|
+
|
|
16
|
+
catocli query container ipAddressRange search '{
|
|
17
|
+
"ipAddressRangeContainerSearchInput": {
|
|
18
|
+
"containerRefInput": {
|
|
19
|
+
"by": "ID",
|
|
20
|
+
"input": "string"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
#### Operation Arguments for query.container.ipAddressRange.search ####
|
|
27
|
+
|
|
28
|
+
`accountId` [ID] - (required) N/A
|
|
29
|
+
`ipAddressRangeContainerSearchInput` [IpAddressRangeContainerSearchInput] - (required) N/A
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.ipAddressRange.searchIpAddressRange:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.ipAddressRange.searchIpAddressRange) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.ipAddressRange.searchIpAddressRange:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container ipAddressRange searchIpAddressRange -h
|
|
9
|
+
|
|
10
|
+
catocli query container ipAddressRange searchIpAddressRange <json>
|
|
11
|
+
|
|
12
|
+
catocli query container ipAddressRange searchIpAddressRange "$(cat < query.container.ipAddressRange.searchIpAddressRange.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container ipAddressRange searchIpAddressRange '{"ipAddressRangeContainerSearchIpAddressRangeInput":{"ipAddressRangeInput":{"from":"example_value","to":"example_value"}}}'
|
|
15
|
+
|
|
16
|
+
catocli query container ipAddressRange searchIpAddressRange '{
|
|
17
|
+
"ipAddressRangeContainerSearchIpAddressRangeInput": {
|
|
18
|
+
"ipAddressRangeInput": {
|
|
19
|
+
"from": "example_value",
|
|
20
|
+
"to": "example_value"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
#### Operation Arguments for query.container.ipAddressRange.searchIpAddressRange ####
|
|
27
|
+
|
|
28
|
+
`accountId` [ID] - (required) N/A
|
|
29
|
+
`ipAddressRangeContainerSearchIpAddressRangeInput` [IpAddressRangeContainerSearchIpAddressRangeInput] - (required) N/A
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
|
|
2
|
+
## CATO-CLI - query.container.list:
|
|
3
|
+
[Click here](https://api.catonetworks.com/documentation/#query-query.container.list) for documentation on this operation.
|
|
4
|
+
|
|
5
|
+
### Usage for query.container.list:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
catocli query container list -h
|
|
9
|
+
|
|
10
|
+
catocli query container list <json>
|
|
11
|
+
|
|
12
|
+
catocli query container list "$(cat < query.container.list.json)"
|
|
13
|
+
|
|
14
|
+
catocli query container list '{"containerSearchInput":{"containerRefInput":{"by":"ID","input":"string"},"types":"IP_RANGE"}}'
|
|
15
|
+
|
|
16
|
+
catocli query container list '{
|
|
17
|
+
"containerSearchInput": {
|
|
18
|
+
"containerRefInput": {
|
|
19
|
+
"by": "ID",
|
|
20
|
+
"input": "string"
|
|
21
|
+
},
|
|
22
|
+
"types": "IP_RANGE"
|
|
23
|
+
}
|
|
24
|
+
}'
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
#### Operation Arguments for query.container.list ####
|
|
28
|
+
|
|
29
|
+
`accountId` [ID] - (required) N/A
|
|
30
|
+
`containerSearchInput` [ContainerSearchInput] - (required) N/A
|