Overview

The documentation pages in this section describe the RESTful APIs included with Riverbed SteelCentral Flowgateway Product. It is assumed that the reader has practical knowledge of RESTful APIs, so the documentation does not go into detail about what REST is and how to use it. Instead the documentation focuses on what data can be accessed, how to configure it.

The following operations can be performed via the API:

Display netprofiler export settings
Configure netprofiler settings
Delete Netrofiler filters from settings

Details about REST resources can be found in the Resources section. This overview continues with how to run these API's.

Authentication

All REST requests must be authenticated. The Authentication section of the Common API describes which authentication methods are presently supported.

Resources

Settings: Display Settings

Displays Netprofiler export settings.

GET https://{device}/api/mgmt.netprofiler_export/1.0/settings

Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

JSON

{
  "sync_src_ipaddr": string,
  "asm_portal_ipaddr": string,
  "enable_flow_buffering": string,
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": string,
      "filter_ipaddrs": [
        string
      ]
    }
  ]
}

Example:
{
  "sync_src_ipaddr": "192.1.1.99", 
  "asm_portal_ipaddr": "192.1.1.99", 
  "enable_flow_buffering": "true", 
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": "192.1.1.1", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }, 
    {
      "netprofiler_ipaddr": "192.1.1.99", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }
  ]
}

{
  "sync_src_ipaddr": string,
  "asm_portal_ipaddr": string,
  "enable_flow_buffering": string,
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": string,
      "filter_ipaddrs": [
        string
      ]
    }
  ]
}

Example:
{
  "sync_src_ipaddr": "192.1.1.99", 
  "asm_portal_ipaddr": "192.1.1.99", 
  "enable_flow_buffering": "true", 
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": "192.1.1.1", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }, 
    {
      "netprofiler_ipaddr": "192.1.1.99", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }
  ]
}

Property Name	Type	Description
response	<object>	Settings
response.sync_src_ipaddr	<string>	Specify NetProfiler IP Address for synchronization of Ports and Application Definitions
response.asm_portal_ipaddr	<string>	Specify NetProfiler IP Address to send ASM analysis
response.enable_flow_buffering	<string>	Enable Flow buffering for offline NetProfilers ? Values : ('true'/'false')
response.export_ipaddrs	<array of <object>>
response.export_ipaddrs[item]	<object>
response.export_ipaddrs[item]. netprofiler_ipaddr	<string>	Specify the target NetProfiler by entering the IP address of the management interface for an NetExpress or Standard NetProfiler, or the address of the Analysis Module for an Enterprise NetProfiler.
response.export_ipaddrs[item]. filter_ipaddrs	<array of <string>>	Enter a comma-separated list of device IP addresses whose traffic is to be sent to the NetProfiler. Leave the Flow Sources field empty if the Flow Gateway is to send all flow data to the specified NetProfiler.
response.export_ipaddrs[item]. filter_ipaddrs[item]	<string>

Settings: Configure Settings

Configure Netprofiler export settings.

POST https://{device}/api/mgmt.netprofiler_export/1.0/settings

Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

JSON

{
  "sync_src_ipaddr": string,
  "asm_portal_ipaddr": string,
  "enable_flow_buffering": string,
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": string,
      "filter_ipaddrs": [
        string
      ]
    }
  ]
}

Example:
{
  "sync_src_ipaddr": "192.1.1.99", 
  "asm_portal_ipaddr": "192.1.1.99", 
  "enable_flow_buffering": "true", 
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": "192.1.1.1", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }, 
    {
      "netprofiler_ipaddr": "192.1.1.99", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }
  ]
}

{
  "sync_src_ipaddr": string,
  "asm_portal_ipaddr": string,
  "enable_flow_buffering": string,
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": string,
      "filter_ipaddrs": [
        string
      ]
    }
  ]
}

Example:
{
  "sync_src_ipaddr": "192.1.1.99", 
  "asm_portal_ipaddr": "192.1.1.99", 
  "enable_flow_buffering": "true", 
  "export_ipaddrs": [
    {
      "netprofiler_ipaddr": "192.1.1.1", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }, 
    {
      "netprofiler_ipaddr": "192.1.1.99", 
      "filter_ipaddrs": [
        "1.1.1.1", 
        "1.1.1.2"
      ]
    }
  ]
}

Property Name	Type	Description
request	<object>	Settings
request.sync_src_ipaddr	<string>	Specify NetProfiler IP Address for synchronization of Ports and Application Definitions
request.asm_portal_ipaddr	<string>	Specify NetProfiler IP Address to send ASM analysis
request.enable_flow_buffering	<string>	Enable Flow buffering for offline NetProfilers ? Values : ('true'/'false')
request.export_ipaddrs	<array of <object>>
request.export_ipaddrs[item]	<object>
request.export_ipaddrs[item]. netprofiler_ipaddr	<string>	Specify the target NetProfiler by entering the IP address of the management interface for an NetExpress or Standard NetProfiler, or the address of the Analysis Module for an Enterprise NetProfiler.
request.export_ipaddrs[item]. filter_ipaddrs	<array of <string>>	Enter a comma-separated list of device IP addresses whose traffic is to be sent to the NetProfiler. Leave the Flow Sources field empty if the Flow Gateway is to send all flow data to the specified NetProfiler.
request.export_ipaddrs[item]. filter_ipaddrs[item]	<string>

Response Body

On success, the server does not provide any body in the responses.

Settings: Delete netprofilers

Displays Netprofiler export settings.

DELETE https://{device}/api/mgmt.netprofiler_export/1.0/settings

Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

JSON

{
  "netprofilers": [
    string
  ]
}

Example:
{
  "netprofilers": [
    "192.1.1.99"
  ]
}

{
  "netprofilers": [
    string
  ]
}

Example:
{
  "netprofilers": [
    "192.1.1.99"
  ]
}

Property Name	Type	Description
request	<object>
request.netprofilers	<array of <string>>	list of netprofilers IPs to delete from settings.
request.netprofilers[item]	<string>

Response Body

On success, the server does not provide any body in the responses.

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
BAD_REQUEST	400	Invalid argument.
AUTH_REQUIRED	401	Authentication required.
AUTH_INVALID_CREDENTIALS	401	Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
INTERNAL_ERROR	500	Internal error.