$schema: http://support.riverbed.com/apis/service_def/2.2
description: AR NetProfiler Export API.
id: http://support.riverbed.com/apis/npm.profiler_export/1.0
name: npm.profiler_export
provider: riverbed
resources:
  profiler_export:
    additionalProperties: false
    description: NetProfiler Export configuration.
    links:
      get:
        description: Returns the NetProfiler Export configuration.
        method: GET
        response:
          $ref: '#/resources/profiler_export'
      self:
        path: $/settings
      set:
        description: Updates the NetProfiler Export configuration.
        method: PUT
        request:
          $ref: '#/resources/profiler_export'
        response:
          $ref: '#/resources/profiler_export'
    properties:
      collectors:
        description: List of NetFlowV9 Collectors.
        items:
          additionalProperties: false
          description: NetFlowV9 Collector details.
          properties:
            address:
              description: NetFlowV9 Collector address, either IP or full qualified
                name.
              type: string
            port:
              description: NetFlowV9 Collector UDP port.
              tags:
                cpptype: uint16
              type: integer
            status:
              $ref: '#/types/exporter_status'
          required:
          - address
          - port
          type: object
        type: array
      enabled:
        description: Enable/disable the NetProfiler Export.
        type: boolean
      profilers:
        description: List of NetProfilers.
        items:
          additionalProperties: false
          description: NetProfiler details.
          properties:
            address:
              description: NetProfiler address, either IP or full qualified name.
              type: string
            status:
              $ref: '#/types/exporter_status'
            sync:
              description: Enable/disable the NetProfiler sync of applications, urls
                and ports definitions.
              type: boolean
          required:
          - address
          type: object
        type: array
      voip_enabled:
        description: Enable/disable the VoIP metrics export.
        type: boolean
    required:
    - enabled
    - profilers
    - collectors
    type: object
  profiler_export_stats:
    additionalProperties: false
    description: NetProfiler Export Statistics.
    links:
      get:
        description: Returns the NetProfiler Export statistics.
        method: GET
        response:
          $ref: '#/resources/profiler_export_stats'
      self:
        path: $/stats
    properties:
      last_minute:
        additionalProperties: false
        description: Statistics on the data exported in the last minute.
        properties:
          exported:
            additionalProperties: false
            properties:
              flows:
                description: Number of exported flows.
                tags:
                  cpptype: uint64
                type: integer
              ip_bytes:
                description: Cumulative number of IP bytes (IP header included) for
                  the exported flows.
                tags:
                  cpptype: uint64
                type: integer
              packets:
                description: Cumulative number of packets for the exported flows.
                tags:
                  cpptype: uint64
                type: integer
            required:
            - flows
            - packets
            - ip_bytes
            type: object
          rejected:
            additionalProperties: false
            properties:
              flows:
                description: Number of rejected flows.
                tags:
                  cpptype: uint64
                type: integer
              ip_bytes:
                description: Cumulative number of IP bytes (IP header included) for
                  the rejected flows.
                tags:
                  cpptype: uint64
                type: integer
              packets:
                description: Cumulative number of packets for the rejected flows.
                tags:
                  cpptype: uint64
                type: integer
            required:
            - flows
            - packets
            - ip_bytes
            type: object
        required:
        - exported
        - rejected
        type: object
      last_week:
        additionalProperties: false
        description: Statistics on the data exported in the last week.
        properties:
          exported:
            additionalProperties: false
            properties:
              average_flows:
                description: Average number of flows exported in the last week.
                tags:
                  cpptype: uint64
                type: integer
              flows:
                description: Number of exported flows.
                tags:
                  cpptype: uint64
                type: integer
              ip_bytes:
                description: Cumulative number of IP bytes (IP header included) for
                  the exported flows.
                tags:
                  cpptype: uint64
                type: integer
              packets:
                description: Cumulative number of packets for the exported flows.
                tags:
                  cpptype: uint64
                type: integer
              peak_flows:
                description: Max number of flows exported in a minute in the last
                  week.
                tags:
                  cpptype: uint64
                type: integer
            required:
            - flows
            - packets
            - ip_bytes
            - average_flows
            - peak_flows
            type: object
          rejected:
            additionalProperties: false
            properties:
              average_flows:
                description: Average number of flows rejected in the last week.
                tags:
                  cpptype: uint64
                type: integer
              flows:
                description: Number of rejected flows.
                tags:
                  cpptype: uint64
                type: integer
              ip_bytes:
                description: Cumulative number of IP bytes (IP header included) for
                  the rejected flows.
                tags:
                  cpptype: uint64
                type: integer
              packets:
                description: Cumulative number of packets for the rejected flows.
                tags:
                  cpptype: uint64
                type: integer
              peak_flows:
                description: Max number of flows rejected in a minute in the last
                  week.
                tags:
                  cpptype: uint64
                type: integer
            required:
            - flows
            - packets
            - ip_bytes
            - average_flows
            - peak_flows
            type: object
        required:
        - exported
        - rejected
        type: object
    required:
    - last_minute
    - last_week
    type: object
title: AR NetProfiler Export API
types:
  async_error_metrics_list:
    description: Array of key/value error metrics, used for detailed error responses
      from async tasks.
    items:
      additionalProperties: false
      description: Individual error key/value.
      properties:
        key:
          description: Error metric ID.
          type: string
        value:
          description: Error metric value.
          type: string
      required:
      - key
      - value
      type: object
    type: array
  exporter_status:
    additionalProperties: false
    description: Information on a NetProfiler or NetFlowV9 Collector connection.
    properties:
      error:
        additionalProperties: false
        description: Asynchronous task error object.
        properties:
          error_id:
            description: Error code.
            type: string
          error_metrics:
            $ref: '#/types/async_error_metrics_list'
          error_text:
            description: Error text.
            type: string
        required:
        - error_id
        - error_text
        type: object
      state:
        description: Connection state of a NetProfiler or NetFlowV9 Collector.
        enum:
        - OK
        - ERROR
        - DISABLED
        type: string
    required:
    - state
    type: object
version: '1.0'
