Skip to content

Hive.cookbook.ts ntop flows

TsNtopFlows

Bases: ApiManager

Class that handles all the XAutomata ts_ntop_flows APIs

Source code in hive/cookbook/ts_ntop_flows.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
class TsNtopFlows(ApiManager):
    """Class that handles all the XAutomata ts_ntop_flows APIs"""

    def ts_ntop_flows(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Read Data

        Args:
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
            null_fields (string optional): additional filter - parameter
            uuid_service (string optional): additional filter - parameter
            uuid_site_src (string optional): additional filter - parameter
            uuid_site_dst (string optional): additional filter - parameter
            l7_proto (string optional): additional filter - parameter
            ip_src_addr (None optional): additional filter - parameter
            ip_dst_addr (None optional): additional filter - parameter
            l4_dst_port (integer optional): additional filter - parameter
            fqdn_src_addr (string optional): additional filter - parameter
            fqdn_dst_addr (string optional): additional filter - parameter
            in_bytes (integer optional): additional filter - parameter
            out_bytes (integer optional): additional filter - parameter
            last_switched_start (string optional): additional filter - parameter
            last_switched_end (string optional): additional filter - parameter
            interface_id (integer optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'uuid_service',
            'uuid_site_src', 'uuid_site_dst', 'l7_proto', 'ip_src_addr',
            'ip_dst_addr', 'l4_dst_port', 'fqdn_src_addr', 'fqdn_dst_addr',
            'in_bytes', 'out_bytes', 'last_switched_start',
            'last_switched_end', 'interface_id', 'skip', 'limit', 'like',
            'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'uuid_service'), params.get('uuid_site_src'), params.get(
            'uuid_site_dst'), params.get('l7_proto'), params.get('ip_src_addr'
            ), params.get('ip_dst_addr'), params.get('l4_dst_port'
            ), params.get('fqdn_src_addr'), params.get('fqdn_dst_addr'
            ), params.get('in_bytes'), params.get('out_bytes'), params.get(
            'last_switched_start'), params.get('last_switched_end'
            ), params.get('interface_id'), params.get('skip'), params.get(
            'limit'), params.get('like'), params.get('join'), params.get(
            'count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_ntop_flows.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/ts_ntop_flows/', single_page
            =single_page, page_size=page_size, warm_start=warm_start,
            params=params, **kwargs)
        return response

    def ts_ntop_flows_create_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Create Ts Ntop Flow

        Args:
            payload (list[dict], optional): List dict to create.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Examples:
            payload = 
          [
           {
            "uuid_service": "string", optional
            "uuid_site_src": "string", optional
            "uuid_site_dst": "string", optional
            "l7_proto": "string", optional
            "ip_src_addr": "integer string string", optional
            "ip_dst_addr": "integer string string", optional
            "l4_dst_port": "integer", optional
            "fqdn_src_addr": "string", optional
            "fqdn_dst_addr": "string", optional
            "in_bytes": "integer", optional
            "out_bytes": "integer", optional
            "last_switched": "string", required
            "interface_id": "integer", optional
           }
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('POST', path=f'/ts_ntop_flows/bulk/create/',
            single_page=single_page, page_size=page_size, payload=payload,
            **kwargs)
        return response

    def ts_ntop_flows_top_protocols(self, uuid_customer: str,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Get Top Protocols

        Args:
            uuid_customer (str, required): uuid_customer
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            uuid_site (string optional): additional filter - parameter
            profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('uuid_site'), params.get('profile'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_ntop_flows_top_protocols.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/ts_ntop_flows/top_protocols/{uuid_customer}', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def ts_ntop_flows_top_talkers(self, uuid_customer: str,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Get Top Talkers

        Args:
            uuid_customer (str, required): uuid_customer
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            uuid_site (string optional): additional filter - parameter
            profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('uuid_site'), params.get('profile'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_ntop_flows_top_talkers.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/ts_ntop_flows/top_talkers/{uuid_customer}', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def ts_ntop_flows_top_receivers(self, uuid_customer: str,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Get Top Receivers

        Args:
            uuid_customer (str, required): uuid_customer
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            uuid_site (string optional): additional filter - parameter
            profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('uuid_site'), params.get('profile'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.ts_ntop_flows_top_receivers.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/ts_ntop_flows/top_receivers/{uuid_customer}', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def ts_ntop_flows_top_protocols_history(self, uuid_customer: str,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Get Top Used Protocols

        Args:
            uuid_customer (str, required): uuid_customer
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            uuid_site (string optional): additional filter - parameter
            profile (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
            'like', 'join', 'count']
        params.get('uuid_site'), params.get('profile'), params.get('skip'
            ), params.get('limit'), params.get('like'), params.get('join'
            ), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                ts_ntop_flows_top_protocols_history.__name__, params,
                official_params_list)
        response = self.execute('GET', path=
            f'/ts_ntop_flows/top_protocols_history/{uuid_customer}',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

ts_ntop_flows(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Read Data

Parameters:

Name Type Description Default
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
sort_by string optional

Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
null_fields string optional

additional filter - parameter
uuid_service string optional

additional filter - parameter
uuid_site_src string optional

additional filter - parameter
uuid_site_dst string optional

additional filter - parameter
l7_proto string optional

additional filter - parameter
ip_src_addr None optional

additional filter - parameter
ip_dst_addr None optional

additional filter - parameter
l4_dst_port integer optional

additional filter - parameter
fqdn_src_addr string optional

additional filter - parameter
fqdn_dst_addr string optional

additional filter - parameter
in_bytes integer optional

additional filter - parameter
out_bytes integer optional

additional filter - parameter
last_switched_start string optional

additional filter - parameter
last_switched_end string optional

additional filter - parameter
interface_id integer optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def ts_ntop_flows(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Data

    Args:
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
        null_fields (string optional): additional filter - parameter
        uuid_service (string optional): additional filter - parameter
        uuid_site_src (string optional): additional filter - parameter
        uuid_site_dst (string optional): additional filter - parameter
        l7_proto (string optional): additional filter - parameter
        ip_src_addr (None optional): additional filter - parameter
        ip_dst_addr (None optional): additional filter - parameter
        l4_dst_port (integer optional): additional filter - parameter
        fqdn_src_addr (string optional): additional filter - parameter
        fqdn_dst_addr (string optional): additional filter - parameter
        in_bytes (integer optional): additional filter - parameter
        out_bytes (integer optional): additional filter - parameter
        last_switched_start (string optional): additional filter - parameter
        last_switched_end (string optional): additional filter - parameter
        interface_id (integer optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'uuid_service',
        'uuid_site_src', 'uuid_site_dst', 'l7_proto', 'ip_src_addr',
        'ip_dst_addr', 'l4_dst_port', 'fqdn_src_addr', 'fqdn_dst_addr',
        'in_bytes', 'out_bytes', 'last_switched_start',
        'last_switched_end', 'interface_id', 'skip', 'limit', 'like',
        'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'uuid_service'), params.get('uuid_site_src'), params.get(
        'uuid_site_dst'), params.get('l7_proto'), params.get('ip_src_addr'
        ), params.get('ip_dst_addr'), params.get('l4_dst_port'
        ), params.get('fqdn_src_addr'), params.get('fqdn_dst_addr'
        ), params.get('in_bytes'), params.get('out_bytes'), params.get(
        'last_switched_start'), params.get('last_switched_end'
        ), params.get('interface_id'), params.get('skip'), params.get(
        'limit'), params.get('like'), params.get('join'), params.get(
        'count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_ntop_flows.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/ts_ntop_flows/', single_page
        =single_page, page_size=page_size, warm_start=warm_start,
        params=params, **kwargs)
    return response

ts_ntop_flows_create_bulk(payload, single_page=False, page_size=50, kwargs=None)

Bulk Create Ts Ntop Flow

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

 required
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

 50
kwargs dict

additional parameters for execute. Default to None.

 None

Examples:

payload =

[ { "uuid_service": "string", optional "uuid_site_src": "string", optional "uuid_site_dst": "string", optional "l7_proto": "string", optional "ip_src_addr": "integer string string", optional "ip_dst_addr": "integer string string", optional "l4_dst_port": "integer", optional "fqdn_src_addr": "string", optional "fqdn_dst_addr": "string", optional "in_bytes": "integer", optional "out_bytes": "integer", optional "last_switched": "string", required "interface_id": "integer", optional } ]

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def ts_ntop_flows_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Create Ts Ntop Flow

    Args:
        payload (list[dict], optional): List dict to create.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Examples:
        payload = 
      [
       {
        "uuid_service": "string", optional
        "uuid_site_src": "string", optional
        "uuid_site_dst": "string", optional
        "l7_proto": "string", optional
        "ip_src_addr": "integer string string", optional
        "ip_dst_addr": "integer string string", optional
        "l4_dst_port": "integer", optional
        "fqdn_src_addr": "string", optional
        "fqdn_dst_addr": "string", optional
        "in_bytes": "integer", optional
        "out_bytes": "integer", optional
        "last_switched": "string", required
        "interface_id": "integer", optional
       }
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('POST', path=f'/ts_ntop_flows/bulk/create/',
        single_page=single_page, page_size=page_size, payload=payload,
        **kwargs)
    return response

ts_ntop_flows_top_protocols(uuid_customer, warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Get Top Protocols

Parameters:

Name Type Description Default
uuid_customer (str, required)

uuid_customer

 required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_site string optional

additional filter - parameter
profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def ts_ntop_flows_top_protocols(self, uuid_customer: str,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Get Top Protocols

    Args:
        uuid_customer (str, required): uuid_customer
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        uuid_site (string optional): additional filter - parameter
        profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('uuid_site'), params.get('profile'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_ntop_flows_top_protocols.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/ts_ntop_flows/top_protocols/{uuid_customer}', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response

ts_ntop_flows_top_protocols_history(uuid_customer, warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Get Top Used Protocols

Parameters:

Name Type Description Default
uuid_customer (str, required)

uuid_customer

 required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_site string optional

additional filter - parameter
profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def ts_ntop_flows_top_protocols_history(self, uuid_customer: str,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Get Top Used Protocols

    Args:
        uuid_customer (str, required): uuid_customer
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        uuid_site (string optional): additional filter - parameter
        profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('uuid_site'), params.get('profile'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            ts_ntop_flows_top_protocols_history.__name__, params,
            official_params_list)
    response = self.execute('GET', path=
        f'/ts_ntop_flows/top_protocols_history/{uuid_customer}',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

ts_ntop_flows_top_receivers(uuid_customer, warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Get Top Receivers

Parameters:

Name Type Description Default
uuid_customer (str, required)

uuid_customer

 required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_site string optional

additional filter - parameter
profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def ts_ntop_flows_top_receivers(self, uuid_customer: str,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Get Top Receivers

    Args:
        uuid_customer (str, required): uuid_customer
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        uuid_site (string optional): additional filter - parameter
        profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('uuid_site'), params.get('profile'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_ntop_flows_top_receivers.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/ts_ntop_flows/top_receivers/{uuid_customer}', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response

ts_ntop_flows_top_talkers(uuid_customer, warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Get Top Talkers

Parameters:

Name Type Description Default
uuid_customer (str, required)

uuid_customer

 required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

 False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

 False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

 5000
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_site string optional

additional filter - parameter
profile string optional

additional filter - parameter
skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/ts_ntop_flows.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def ts_ntop_flows_top_talkers(self, uuid_customer: str,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Get Top Talkers

    Args:
        uuid_customer (str, required): uuid_customer
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        uuid_site (string optional): additional filter - parameter
        profile (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['uuid_site', 'profile', 'skip', 'limit',
        'like', 'join', 'count']
    params.get('uuid_site'), params.get('profile'), params.get('skip'
        ), params.get('limit'), params.get('like'), params.get('join'
        ), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.ts_ntop_flows_top_talkers.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/ts_ntop_flows/top_talkers/{uuid_customer}', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response