AR NetProfiler Export API v1.0

Resource: profiler_export

NetProfiler Export configuration.

http://{device}/api/npm.profiler_export/1.0/settings

JSON

{
  "collectors": [
    {
      "address": string,
      "port": integer,
      "status": exporter_status
    }
  ],
  "enabled": boolean,
  "profilers": [
    {
      "address": string,
      "status": exporter_status,
      "sync": boolean
    }
  ],
  "voip_enabled": boolean
}

{
  "collectors": [
    {
      "address": string,
      "port": integer,
      "status": exporter_status
    }
  ],
  "enabled": boolean,
  "profilers": [
    {
      "address": string,
      "status": exporter_status,
      "sync": boolean
    }
  ],
  "voip_enabled": boolean
}

Property Name	Type	Description	Notes
profiler_export	<object>	NetProfiler Export configuration.	Required properties: [enabled, profilers, collectors];
profiler_export.collectors	<array of <object>>	List of NetFlowV9 Collectors.
profiler_export.collectors[items]	<object>	NetFlowV9 Collector details.	Required properties: [address, port];
profiler_export.collectors[items]. address	<string>	NetFlowV9 Collector address, either IP or full qualified name.
profiler_export.collectors[items].port	<integer>	NetFlowV9 Collector UDP port.
profiler_export.collectors[items].status	<exporter_status>	Information on a NetProfiler or NetFlowV9 Collector connection.
profiler_export.enabled	<boolean>	Enable/disable the NetProfiler Export.
profiler_export.profilers	<array of <object>>	List of NetProfilers.
profiler_export.profilers[items]	<object>	NetProfiler details.	Required properties: [address];
profiler_export.profilers[items].address	<string>	NetProfiler address, either IP or full qualified name.
profiler_export.profilers[items].status	<exporter_status>	Information on a NetProfiler or NetFlowV9 Collector connection.
profiler_export.profilers[items].sync	<boolean>	Enable/disable the NetProfiler sync of applications, urls and ports definitions.	Optional;
profiler_export.voip_enabled	<boolean>	Enable/disable the VoIP metrics export.	Optional;

Links

profiler_export: get

Returns the NetProfiler Export configuration.

GET http://{device}/api/npm.profiler_export/1.0/settings

Response Body

Returns a profiler_export data object.

profiler_export: set

Updates the NetProfiler Export configuration.

PUT http://{device}/api/npm.profiler_export/1.0/settings

Request Body

Provide a profiler_export data object.

Response Body

Returns a profiler_export data object.

Resource: profiler_export_stats

NetProfiler Export Statistics.

http://{device}/api/npm.profiler_export/1.0/stats

JSON

{
  "last_minute": {
    "exported": {
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer
    },
    "rejected": {
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer
    }
  },
  "last_week": {
    "exported": {
      "average_flows": integer,
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer,
      "peak_flows": integer
    },
    "rejected": {
      "average_flows": integer,
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer,
      "peak_flows": integer
    }
  }
}

{
  "last_minute": {
    "exported": {
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer
    },
    "rejected": {
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer
    }
  },
  "last_week": {
    "exported": {
      "average_flows": integer,
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer,
      "peak_flows": integer
    },
    "rejected": {
      "average_flows": integer,
      "flows": integer,
      "ip_bytes": integer,
      "packets": integer,
      "peak_flows": integer
    }
  }
}

Property Name	Type	Description	Notes
profiler_export_stats	<object>	NetProfiler Export Statistics.	Required properties: [last_minute, last_week];
profiler_export_stats.last_minute	<object>	Statistics on the data exported in the last minute.	Required properties: [exported, rejected];
profiler_export_stats.last_minute. exported	<object>		Required properties: [flows, packets, ip_bytes];
profiler_export_stats.last_minute. exported.flows	<integer>	Number of exported flows.
profiler_export_stats.last_minute. exported.ip_bytes	<integer>	Cumulative number of IP bytes (IP header included) for the exported flows.
profiler_export_stats.last_minute. exported.packets	<integer>	Cumulative number of packets for the exported flows.
profiler_export_stats.last_minute. rejected	<object>		Required properties: [flows, packets, ip_bytes];
profiler_export_stats.last_minute. rejected.flows	<integer>	Number of rejected flows.
profiler_export_stats.last_minute. rejected.ip_bytes	<integer>	Cumulative number of IP bytes (IP header included) for the rejected flows.
profiler_export_stats.last_minute. rejected.packets	<integer>	Cumulative number of packets for the rejected flows.
profiler_export_stats.last_week	<object>	Statistics on the data exported in the last week.	Required properties: [exported, rejected];
profiler_export_stats.last_week.exported	<object>		Required properties: [flows, packets, ip_bytes, average_flows, peak_flows];
profiler_export_stats.last_week.exported. average_flows	<integer>	Average number of flows exported in the last week.
profiler_export_stats.last_week.exported. flows	<integer>	Number of exported flows.
profiler_export_stats.last_week.exported. ip_bytes	<integer>	Cumulative number of IP bytes (IP header included) for the exported flows.
profiler_export_stats.last_week.exported. packets	<integer>	Cumulative number of packets for the exported flows.
profiler_export_stats.last_week.exported. peak_flows	<integer>	Max number of flows exported in a minute in the last week.
profiler_export_stats.last_week.rejected	<object>		Required properties: [flows, packets, ip_bytes, average_flows, peak_flows];
profiler_export_stats.last_week.rejected. average_flows	<integer>	Average number of flows rejected in the last week.
profiler_export_stats.last_week.rejected. flows	<integer>	Number of rejected flows.
profiler_export_stats.last_week.rejected. ip_bytes	<integer>	Cumulative number of IP bytes (IP header included) for the rejected flows.
profiler_export_stats.last_week.rejected. packets	<integer>	Cumulative number of packets for the rejected flows.
profiler_export_stats.last_week.rejected. peak_flows	<integer>	Max number of flows rejected in a minute in the last week.

Links

profiler_export_stats: get

Returns the NetProfiler Export statistics.

GET http://{device}/api/npm.profiler_export/1.0/stats

Response Body

Returns a profiler_export_stats data object.

Type: async_error_metrics_list

Array of key/value error metrics, used for detailed error responses from async tasks.

JSON

[
  {
    "key": string,
    "value": string
  }
]

[
  {
    "key": string,
    "value": string
  }
]

Property Name	Type	Description	Notes
async_error_metrics_list	<array of <object>>	Array of key/value error metrics, used for detailed error responses from async tasks.
async_error_metrics_list[items]	<object>	Individual error key/value.	Required properties: [key, value];
async_error_metrics_list[items].key	<string>	Error metric ID.
async_error_metrics_list[items].value	<string>	Error metric value.

Type: exporter_status

Information on a NetProfiler or NetFlowV9 Collector connection.

JSON

{
  "error": {
    "error_id": string,
    "error_metrics": async_error_metrics_list,
    "error_text": string
  },
  "state": string
}

{
  "error": {
    "error_id": string,
    "error_metrics": async_error_metrics_list,
    "error_text": string
  },
  "state": string
}

Property Name	Type	Description	Notes
exporter_status	<object>	Information on a NetProfiler or NetFlowV9 Collector connection.	Required properties: [state];
exporter_status.error	<object>	Asynchronous task error object.	Required properties: [error_id, error_text]; Optional;
exporter_status.error.error_id	<string>	Error code.
exporter_status.error.error_metrics	<async_error_metrics_list>	Array of key/value error metrics, used for detailed error responses from async tasks.
exporter_status.error.error_text	<string>	Error text.
exporter_status.state	<string>	Connection state of a NetProfiler or NetFlowV9 Collector.	Values: OK, ERROR, DISABLED;