Netflow agent

GET

/

v2

/

api

/

get_netflow_agent

cURL

curl -sk -X GET "https://<controller>/v2/api/get_netflow_agent" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_netflow_agent"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_netflow_agent", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Query Parameters

server_ip

string

Netflow Collector IP address.

port

string

Netflow Collector listening port.

interface

string

Interface name or any.

version

enum<integer>

Netflow version.

Available options:

5,

9

exclude_list

string

Comma separated exclude gateway list.

l7_mode

enum<string>

Toggle L7 netflow.

Available options:

disable,

enable

tcp_mode

boolean

Toggle TCP netflow for non-private-mode.

oteld_enabled

boolean

Toggle oteld for netflow to be collected and forwarded by OpenTelemetry collector.

global_sampling_rate

string

Global netflow sampling rate (in percentage).

tls

boolean

Use TLS for TCP netflow.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X GET "https://<controller>/v2/api/get_netflow_agent" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_netflow_agent"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_netflow_agent", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}