Riverbed Cloud Synchronization API.
Created Jan 16, 2025 at 06:32 PM

Overview

Resources

Setup: Setup Hyperion

Initialize Hyperion integration.

PUT https://{device}/api/npm.cloud_sync/2.0/setup
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "blob": {
    "connection_string": string,
    "container": string,
    "data_source_id": string
  },
  "user_account": {
    "password": string,
    "username": string
  }
}
Property Name Type Description Notes
CloudSyncSetup <object> Initial Hyperion setup information.
CloudSyncSetup.blob <object> Configuration of the outgoing blob storage.
CloudSyncSetup.blob.connection_string <string> Connection string for the outgoing blob storage.
CloudSyncSetup.blob.container <string> Container name.
CloudSyncSetup.blob.data_source_id <string> Data source ID.
CloudSyncSetup.user_account <object> Credentials for the Hyperion user.
CloudSyncSetup.user_account.password <string> Password for the Hyperion user.
CloudSyncSetup.user_account.username <string> User name for the Hyperion user.
Response Body

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

Sync: Get Sync Configuration

Obsoleted. Please do not use anymore. Set the cloud synchronization configuration.

GET https://{device}/api/npm.cloud_sync/2.0/sync
Authorization

This request requires authorization.

Response Body

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

  • JSON
{
  "enabled": string,
  "data": {
    "entities": {
      [CloudSyncObject]: {
        "source": string,
        "keys": [
          {
            "source": string,
            "process": string,
            "target": string
          }
        ],
        "metrics": [
          {
            "source": string,
            "target_unit": string,
            "source_unit": string,
            "process": string,
            "target": string,
            "target_type": string
          }
        ],
        "granularities": [
          number
        ],
        "destination": string
      }
    },
    "version": string,
    "timestamp": {
      "target_unit": string,
      "target": string,
      "target_type": string
    }
  },
  "push_interval": number
}

Example:
{
  "enabled": true
}
Property Name Type Description Notes
CloudSyncConfig <object> Hyperion Sync Configuration.
CloudSyncConfig.enabled <string> Flag indicating if data/metadata synchronization is enabled.
CloudSyncConfig.data <object> Data synchronization configuration. Optional
CloudSyncConfig.data.entities <object> Per-type data configuration. Optional
CloudSyncConfig.data.entities
[CloudSyncObject]
<object> Configuration for a specific data type. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].source
<string> Source property. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
<array of <object>> Mapping of objects identifiers from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping]
<object> Mapping of objects identifiers from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].source
<string> Identifier source (source table).
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].process
<string> Process name. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].target
<string> Hyperion key name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
<array of <object>> Mapping of objects metrics from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping]
<object> Mapping of objects metrics from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].source
<string> Profiler metric name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target_unit
<string> Hyperion unit.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].source_unit
<string> Profiler unit. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].process
<string> Process function name. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target
<string> Hyperion metric name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target_type
<string> Hyperion unit type (integer/float/string/boolean). Optional; Values: integer, float, string, boolean
CloudSyncConfig.data.entities
[CloudSyncObject].granularities
<array of <number>> List of granularities. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].granularities[item]
<number> Granularity in seconds. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].destination
<string> Target property. Optional
CloudSyncConfig.data.version <string> Semantic version.
CloudSyncConfig.data.timestamp <object> Timestamp mapping configuration.
CloudSyncConfig.data.timestamp.
target_unit
<string> Hyperion unit. Optional
CloudSyncConfig.data.timestamp.target <string> Hyperion property name. Optional
CloudSyncConfig.data.timestamp.
target_type
<string> Hyperion type. Optional
CloudSyncConfig.push_interval <number> Push interval in seconds. Optional

Sync: Set DB objects

Get a list of configured clickhouse precomputations.

PUT https://{device}/api/npm.cloud_sync/2.0/sync/clickhouse
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "flag": number,
  "name": string
}
Property Name Type Description Notes
ClickhouseTableUpdate <object> Configuration object for clickhouse precomputation.
ClickhouseTableUpdate.flag <number> State: 1 - enabled; 4 - disabled.
ClickhouseTableUpdate.name <string> Name of object to precompue.
Response Body

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

Sync: List DB of objects

Get a list of configured clickhouse precomputations.

GET https://{device}/api/npm.cloud_sync/2.0/sync/clickhouse
Authorization

This request requires authorization.

Response Body

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

  • JSON
[
  {
    "flag": number,
    "disk_limit_kb": number,
    "disk_usage_kb": number,
    "query_bundle_id": number,
    "blade_id": number,
    "resolution": number,
    "retention_days": number,
    "last_update": number,
    "first_update": number,
    "name": string
  }
]

Example:
[]
Property Name Type Description Notes
ClickhouseTables <array of <object>> Configuration objects for clickhouse precomputation.
ClickhouseTables[ClickhouseTable] <object> Configuration objects for clickhouse precomputation. Optional
ClickhouseTables[ClickhouseTable].flag <number> State: 1 - enabled; 4 - disabled.
ClickhouseTables[ClickhouseTable].
disk_limit_kb
<number> Disk limit.
ClickhouseTables[ClickhouseTable].
disk_usage_kb
<number> Current disk usage.
ClickhouseTables[ClickhouseTable].
query_bundle_id
<number> Bundle ID.
ClickhouseTables[ClickhouseTable].
blade_id
<number> Blade ID.
ClickhouseTables[ClickhouseTable].
resolution
<number> Resolution.
ClickhouseTables[ClickhouseTable].
retention_days
<number> Disk retantion.
ClickhouseTables[ClickhouseTable].
last_update
<number> Last updated.
ClickhouseTables[ClickhouseTable].
first_update
<number> First updated.
ClickhouseTables[ClickhouseTable].name <string> Name of object to precompue.

Sync: Set Sync Configuration

Obsoleted. Please do not use anymore. Set the cloud synchronization configuration.

PUT https://{device}/api/npm.cloud_sync/2.0/sync
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "enabled": string,
  "data": {
    "entities": {
      [CloudSyncObject]: {
        "source": string,
        "keys": [
          {
            "source": string,
            "process": string,
            "target": string
          }
        ],
        "metrics": [
          {
            "source": string,
            "target_unit": string,
            "source_unit": string,
            "process": string,
            "target": string,
            "target_type": string
          }
        ],
        "granularities": [
          number
        ],
        "destination": string
      }
    },
    "version": string,
    "timestamp": {
      "target_unit": string,
      "target": string,
      "target_type": string
    }
  },
  "push_interval": number
}

Example:
{
  "enabled": true
}
Property Name Type Description Notes
CloudSyncConfig <object> Hyperion Sync Configuration.
CloudSyncConfig.enabled <string> Flag indicating if data/metadata synchronization is enabled.
CloudSyncConfig.data <object> Data synchronization configuration. Optional
CloudSyncConfig.data.entities <object> Per-type data configuration. Optional
CloudSyncConfig.data.entities
[CloudSyncObject]
<object> Configuration for a specific data type. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].source
<string> Source property. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
<array of <object>> Mapping of objects identifiers from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping]
<object> Mapping of objects identifiers from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].source
<string> Identifier source (source table).
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].process
<string> Process name. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].keys
[CloudSyncKeyMapping].target
<string> Hyperion key name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
<array of <object>> Mapping of objects metrics from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping]
<object> Mapping of objects metrics from a point product to Hyperion fields. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].source
<string> Profiler metric name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target_unit
<string> Hyperion unit.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].source_unit
<string> Profiler unit. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].process
<string> Process function name. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target
<string> Hyperion metric name.
CloudSyncConfig.data.entities
[CloudSyncObject].metrics
[CloudSyncMetricMapping].target_type
<string> Hyperion unit type (integer/float/string/boolean). Optional; Values: integer, float, string, boolean
CloudSyncConfig.data.entities
[CloudSyncObject].granularities
<array of <number>> List of granularities. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].granularities[item]
<number> Granularity in seconds. Optional
CloudSyncConfig.data.entities
[CloudSyncObject].destination
<string> Target property. Optional
CloudSyncConfig.data.version <string> Semantic version.
CloudSyncConfig.data.timestamp <object> Timestamp mapping configuration.
CloudSyncConfig.data.timestamp.
target_unit
<string> Hyperion unit. Optional
CloudSyncConfig.data.timestamp.target <string> Hyperion property name. Optional
CloudSyncConfig.data.timestamp.
target_type
<string> Hyperion type. Optional
CloudSyncConfig.push_interval <number> Push interval in seconds. Optional
Response Body

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

Reports: Create Report

Create a new Hyperion report instance.

POST https://{device}/api/npm.cloud_sync/2.0/reports
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "meta": {
    "data_source_id": string
  },
  "report": {
    "criteria": {
      "traffic_expression": string,
      "time_frame": {
        "time_interval": string,
        "resolution": string,
        "end": number,
        "expression": string,
        "start": number,
        "time_zone": string
      },
      "query": {
        "ports": [
          {
            "port": number,
            "protocol": number,
            "name": string
          }
        ],
        "dscp_app_ports": [
          {
            "port": {
              "port": number,
              "protocol": number,
              "name": string
            },
            "app": {
              "id": number,
              "code": string,
              "name": string,
              "tunneled": string
            },
            "dscp": {
              "name": string,
              "code_point": number
            }
          }
        ],
        "port_groups": [
          {
            "name": string,
            "group_id": number
          }
        ],
        "cbqos_classes": [
          {
            "id": string
          }
        ],
        "bgpasscope": string,
        "host_group_pairs": [
          {
            "server": {
              "name": string,
              "group_id": number
            },
            "client": {
              "name": string,
              "group_id": number
            }
          }
        ],
        "wan_group": string,
        "traffic_expression": string,
        "include_non_optimized_sites": string,
        "columns": [
          number
        ],
        "sort_direction": string,
        "bgpas_pairs": [
          {
            "server": {
              "id": number,
              "name": string
            },
            "client": {
              "id": number,
              "name": string
            }
          }
        ],
        "application_servers": [
          {
            "app": {
              "id": number,
              "code": string,
              "name": string,
              "tunneled": string
            },
            "server": {
              "mac": string,
              "ipaddr": string,
              "name": string
            }
          }
        ],
        "devices": [
          {
            "ipaddr": string,
            "name": string
          }
        ],
        "application_ports": [
          {
            "port": {
              "port": number,
              "protocol": number,
              "name": string
            },
            "app": {
              "id": number,
              "code": string,
              "name": string,
              "tunneled": string
            }
          }
        ],
        "mplsexpbits": [
          {
            "traffic_class": string,
            "exp_bit": number
          }
        ],
        "bgpas_host_groups": [
          {
            "host_group": {
              "name": string,
              "group_id": number
            },
            "bgpas": {
              "id": number,
              "name": string
            }
          }
        ],
        "host_pair_ports": [
          {
            "port": {
              "port": number,
              "protocol": number,
              "name": string
            },
            "server": {
              "mac": string,
              "ipaddr": string,
              "name": string
            },
            "client": {
              "mac": string,
              "ipaddr": string,
              "name": string
            }
          }
        ],
        "dscp_interfaces": [
          {
            "interface": {
              "ipaddr": string,
              "name": string,
              "ifindex": number
            },
            "dscp": {
              "name": string,
              "code_point": number
            }
          }
        ],
        "bgpas": [
          {
            "id": number,
            "name": string
          }
        ],
        "role": string,
        "show_ttl": string,
        "group_by": string,
        "case_insensitive": string,
        "switch_name": string,
        "macs": string,
        "host_group_type": string,
        "host_pair_app_ports": [
          {
            "port": {
              "port": number,
              "protocol": number,
              "name": string
            },
            "app": {
              "id": number,
              "code": string,
              "name": string,
              "tunneled": string
            },
            "server": {
              "mac": string,
              "ipaddr": string,
              "name": string
            },
            "client": {
              "mac": string,
              "ipaddr": string,
              "name": string
            }
          }
        ],
        "direction": string,
        "users": [
          {
            "name": string
          }
        ],
        "switch_ports": string,
        "sort_column": number,
        "host_group_pair_ports": [
          {
            "port": {
              "port": number,
              "protocol": number,
              "name": string
            },
            "server": {
              "name": string,
              "group_id": number
            },
            "client": {
              "name": string,
              "group_id": number
            }
          }
        ],
        "network_segments": [
          {
            "src": {
              "ipaddr": string,
              "name": string,
              "ifindex": number
            },
            "dst": {
              "ipaddr": string,
              "name": string,
              "ifindex": number
            }
          }
        ],
        "macless_ports": string,
        "hosts": [
          {
            "mac": string,
            "ipaddr": string,
            "name": string
          }
        ],
        "ignore_dhcp": string,
        "host_pairs": [
          {
            "server": {
              "mac": string,
              "ipaddr": string,
              "name": string
            },
            "client": {
              "mac": string,
              "ipaddr": string,
              "name": string
            }
          }
        ],
        "area": string,
        "protocols": [
          {
            "id": number,
            "name": string
          }
        ],
        "group_dev_iface": string,
        "centricity": string,
        "limit": number,
        "interfaces": [
          {
            "ipaddr": string,
            "name": string,
            "ifindex": number
          }
        ],
        "host_groups": [
          {
            "name": string,
            "group_id": number
          }
        ],
        "realm": string,
        "dscps": [
          {
            "name": string,
            "code_point": number
          }
        ],
        "applications": [
          {
            "id": number,
            "code": string,
            "name": string,
            "tunneled": string
          }
        ]
      },
      "network_type": string,
      "queries": [
        {
          "ports": [
            {
              "port": number,
              "protocol": number,
              "name": string
            }
          ],
          "dscp_app_ports": [
            {
              "port": {
                "port": number,
                "protocol": number,
                "name": string
              },
              "app": {
                "id": number,
                "code": string,
                "name": string,
                "tunneled": string
              },
              "dscp": {
                "name": string,
                "code_point": number
              }
            }
          ],
          "port_groups": [
            {
              "name": string,
              "group_id": number
            }
          ],
          "cbqos_classes": [
            {
              "id": string
            }
          ],
          "bgpasscope": string,
          "host_group_pairs": [
            {
              "server": {
                "name": string,
                "group_id": number
              },
              "client": {
                "name": string,
                "group_id": number
              }
            }
          ],
          "wan_group": string,
          "traffic_expression": string,
          "include_non_optimized_sites": string,
          "columns": [
            number
          ],
          "sort_direction": string,
          "bgpas_pairs": [
            {
              "server": {
                "id": number,
                "name": string
              },
              "client": {
                "id": number,
                "name": string
              }
            }
          ],
          "application_servers": [
            {
              "app": {
                "id": number,
                "code": string,
                "name": string,
                "tunneled": string
              },
              "server": {
                "mac": string,
                "ipaddr": string,
                "name": string
              }
            }
          ],
          "devices": [
            {
              "ipaddr": string,
              "name": string
            }
          ],
          "application_ports": [
            {
              "port": {
                "port": number,
                "protocol": number,
                "name": string
              },
              "app": {
                "id": number,
                "code": string,
                "name": string,
                "tunneled": string
              }
            }
          ],
          "mplsexpbits": [
            {
              "traffic_class": string,
              "exp_bit": number
            }
          ],
          "bgpas_host_groups": [
            {
              "host_group": {
                "name": string,
                "group_id": number
              },
              "bgpas": {
                "id": number,
                "name": string
              }
            }
          ],
          "host_pair_ports": [
            {
              "port": {
                "port": number,
                "protocol": number,
                "name": string
              },
              "server": {
                "mac": string,
                "ipaddr": string,
                "name": string
              },
              "client": {
                "mac": string,
                "ipaddr": string,
                "name": string
              }
            }
          ],
          "dscp_interfaces": [
            {
              "interface": {
                "ipaddr": string,
                "name": string,
                "ifindex": number
              },
              "dscp": {
                "name": string,
                "code_point": number
              }
            }
          ],
          "bgpas": [
            {
              "id": number,
              "name": string
            }
          ],
          "role": string,
          "show_ttl": string,
          "group_by": string,
          "case_insensitive": string,
          "switch_name": string,
          "macs": string,
          "host_group_type": string,
          "host_pair_app_ports": [
            {
              "port": {
                "port": number,
                "protocol": number,
                "name": string
              },
              "app": {
                "id": number,
                "code": string,
                "name": string,
                "tunneled": string
              },
              "server": {
                "mac": string,
                "ipaddr": string,
                "name": string
              },
              "client": {
                "mac": string,
                "ipaddr": string,
                "name": string
              }
            }
          ],
          "direction": string,
          "users": [
            {
              "name": string
            }
          ],
          "switch_ports": string,
          "sort_column": number,
          "host_group_pair_ports": [
            {
              "port": {
                "port": number,
                "protocol": number,
                "name": string
              },
              "server": {
                "name": string,
                "group_id": number
              },
              "client": {
                "name": string,
                "group_id": number
              }
            }
          ],
          "network_segments": [
            {
              "src": {
                "ipaddr": string,
                "name": string,
                "ifindex": number
              },
              "dst": {
                "ipaddr": string,
                "name": string,
                "ifindex": number
              }
            }
          ],
          "macless_ports": string,
          "hosts": [
            {
              "mac": string,
              "ipaddr": string,
              "name": string
            }
          ],
          "ignore_dhcp": string,
          "host_pairs": [
            {
              "server": {
                "mac": string,
                "ipaddr": string,
                "name": string
              },
              "client": {
                "mac": string,
                "ipaddr": string,
                "name": string
              }
            }
          ],
          "area": string,
          "protocols": [
            {
              "id": number,
              "name": string
            }
          ],
          "group_dev_iface": string,
          "centricity": string,
          "limit": number,
          "interfaces": [
            {
              "ipaddr": string,
              "name": string,
              "ifindex": number
            }
          ],
          "host_groups": [
            {
              "name": string,
              "group_id": number
            }
          ],
          "realm": string,
          "dscps": [
            {
              "name": string,
              "code_point": number
            }
          ],
          "applications": [
            {
              "id": number,
              "code": string,
              "name": string,
              "tunneled": string
            }
          ]
        }
      ],
      "deprecated": {
        [prop]: string
      },
      "vni": string,
      "fast_data_source": string,
      "app_reduction": string
    },
    "timeout": number,
    "name": string,
    "template_id": number
  },
  "uuid": string
}
Property Name Type Description Notes
CloudSyncOnDemandReport <object> Data Ocean on-demand report request.
CloudSyncOnDemandReport.meta <object> Cloud meta info.
CloudSyncOnDemandReport.meta.
data_source_id
<string> Data source ID.
CloudSyncOnDemandReport.report <object> Report definition.
CloudSyncOnDemandReport.report.criteria <object> Criteria neeed to run the report. Optional
CloudSyncOnDemandReport.report.criteria.
traffic_expression
<string> Traffic expression. Optional
CloudSyncOnDemandReport.report.criteria.
time_frame
<object> Time frame object. Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.time_interval
<string> Time interval pipe-separated string (example: 'last|1|hour'). Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.resolution
<string> Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month. If not specified a resolution will automatically be selected based on time frame of the report. Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.end
<number> Report end time (unix time). Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.expression
<string> Traffic expression. Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.start
<number> Report start time (unix time). Optional
CloudSyncOnDemandReport.report.criteria.
time_frame.time_zone
<string> Time zone name. Optional
CloudSyncOnDemandReport.report.criteria.
query
<object> Query object. Optional
CloudSyncOnDemandReport.report.criteria.
query.ports
<array of <object>> Query ports. Can be one of GET /reporting/ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.ports[CProtoPort]
<object> One CProtoPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.ports[CProtoPort].port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.ports[CProtoPort].protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.ports[CProtoPort].name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports
<array of <object>> Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort]
<object> One CDSCPAppPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].app.
id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].app.
code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].app.
name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].app.
tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
dscp
<object> DSCP specification.
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
dscp.name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_app_ports[CDSCPAppPort].
dscp.code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
query.port_groups
<array of <object>> Query port_groups. Can be one of GET /reporting/port_groups. Optional
CloudSyncOnDemandReport.report.criteria.
query.port_groups[CPortGroup]
<object> One CPortGroup object. Optional
CloudSyncOnDemandReport.report.criteria.
query.port_groups[CPortGroup].name
<string> Name of the port group. Optional
CloudSyncOnDemandReport.report.criteria.
query.port_groups[CPortGroup].group_id
<number> ID of the port group. Optional
CloudSyncOnDemandReport.report.criteria.
query.cbqos_classes
<array of <object>> Query CBQoS classes. Optional
CloudSyncOnDemandReport.report.criteria.
query.cbqos_classes[CCBQOSCLASS]
<object> Object representing a CBQoS class. Optional
CloudSyncOnDemandReport.report.criteria.
query.cbqos_classes[CCBQOSCLASS].id
<string> CBQoS class id. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpasscope
<string> Query autonomous system scope. Optional; Values: ALL, PRIVATE, PUBLIC
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs
<array of <object>> Query host_group_pairs. Can be one of GET /reporting/host_group_pairs. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair]
<object> One CHostGroupPair object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
server
<object> Server host group specification.
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
server.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
server.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
client
<object> Client host group specification.
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
client.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pairs[CHostGroupPair].
client.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.wan_group
<string> Query WAN group. Can be any Interface Group under /WAN. Optional
CloudSyncOnDemandReport.report.criteria.
query.traffic_expression
<string> Query-specific traffic expression. Optional
CloudSyncOnDemandReport.report.criteria.
query.include_non_optimized_sites
<string> Query include non-optimized. Include non-optimized sites in a WAN query. Optional
CloudSyncOnDemandReport.report.criteria.
query.columns
<array of <number>> Query columns. Can be many of GET /reporting/columns. Optional
CloudSyncOnDemandReport.report.criteria.
query.columns[item]
<number> Query column. Optional
CloudSyncOnDemandReport.report.criteria.
query.sort_direction
<string> Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default). Optional; Values: ASC, DESC
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs
<array of <object>> Query autonomous system pairs. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair]
<object> Pair of Autonomous Systems. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].server
<object> Object representing a server Autonomous System.
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].server.
id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].server.
name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].client
<object> Object representing a client Autonomous System.
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].client.
id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_pairs[CBGPASPair].client.
name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
<array of <object>> Query application_servers. Can be one of GET /reporting/application_servers. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer]
<object> One CApplicationServer object. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].server
<object> Server specification.
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_servers
[CApplicationServer].server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.devices
<array of <object>> Query devices. Can be one of GET /reporting/devices. Optional
CloudSyncOnDemandReport.report.criteria.
query.devices[CDevice]
<object> One CDevice object. Optional
CloudSyncOnDemandReport.report.criteria.
query.devices[CDevice].ipaddr
<string> Device IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.devices[CDevice].name
<string> Device name. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
<array of <object>> Query application_ports. Can be one of GET /reporting/application_ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort]
<object> One CApplicationPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
query.application_ports
[CApplicationPort].app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
query.mplsexpbits
<array of <object>> Query mplsexpbits. Optional
CloudSyncOnDemandReport.report.criteria.
query.mplsexpbits[CMPLSEXPBIT]
<object> One CMPLSEXPBIT object. Optional
CloudSyncOnDemandReport.report.criteria.
query.mplsexpbits[CMPLSEXPBIT].
traffic_class
<string> MPLSEXPBIT traffic class name. Optional
CloudSyncOnDemandReport.report.criteria.
query.mplsexpbits[CMPLSEXPBIT].exp_bit
<number> MPLSEXP Bit. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
<array of <object>> Query autonomous system and host group. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup]
<object> Object representing Autonomous System and Host Group. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].host_group
<object> Object representing a Host Group.
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].host_group.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].host_group.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].bgpas
<object> Object representing a Autonomous System.
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].bgpas.id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas_host_groups
[CBGPASHostGroup].bgpas.name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports
<array of <object>> Query host_pair_ports. Can be one of GET /reporting/host_pair_ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort]
<object> One CHostPairPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
server
<object> Server host specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
client
<object> Client host specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
client.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
client.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_ports[CHostPairPort].
client.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces
<array of <object>> Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface]
<object> One CDSCPInterface object. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
interface
<object> Interface specification.
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
interface.ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
interface.name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
interface.ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
dscp
<object> DSCP specification.
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
dscp.name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscp_interfaces[CDSCPInterface].
dscp.code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas
<array of <object>> Query autonomous system. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas[CBGPAS]
<object> Object representing a Autonomous System. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas[CBGPAS].id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
query.bgpas[CBGPAS].name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
query.role
<string> Query role. Can be one of /reporting/roles. Optional
CloudSyncOnDemandReport.report.criteria.
query.show_ttl
<string> Query show TTL. Only applicable to flow list report format. Optional
CloudSyncOnDemandReport.report.criteria.
query.group_by
<string> Query group_by. Can be one of GET /reporting/group_bys. Optional
CloudSyncOnDemandReport.report.criteria.
query.case_insensitive
<string> Query user case insensitivity. Whether to search for users in a case-insensitive fashion. Optional
CloudSyncOnDemandReport.report.criteria.
query.switch_name
<string> Query switch name. Can be an IP address or a name. Optional
CloudSyncOnDemandReport.report.criteria.
query.macs
<string> Query MAC addresses. Host MAC addresses, only apply to switch_port requests. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_type
<string> Query host group type. Required for "host group (gro)" "host group pairs (gpp)" and "host group pairs with ports (gpr)" queries. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
<array of <object>> Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort]
<object> One CHostPairAppPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].server
<object> Server host specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].client
<object> Client host specification.
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].client.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].client.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pair_app_ports
[CHostPairAppPort].client.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.direction
<string> Query direction. Can be one of GET /reporting/directions. Optional
CloudSyncOnDemandReport.report.criteria.
query.users
<array of <object>> Query time host users. Can be one of GET /reporting/time host user. Optional
CloudSyncOnDemandReport.report.criteria.
query.users[CUser]
<object> One CUser object. Optional
CloudSyncOnDemandReport.report.criteria.
query.users[CUser].name
<string> Active Directory user name.
CloudSyncOnDemandReport.report.criteria.
query.switch_ports
<string> Query switch ports. Switch port addresses. Optional
CloudSyncOnDemandReport.report.criteria.
query.sort_column
<number> Query sort column. Can be one of GET /reporting/columns. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
<array of <object>> Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort]
<object> One CHostGroupPairPort object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].server
<object> Server host group specification.
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].server.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].server.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].client
<object> Client host group specification.
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].client.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_group_pair_ports
[CHostGroupPairPort].client.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
<array of <object>> Query network_segments. Can be one of GET /reporting/network_segments. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment]
<object> One CNetworkSegment object. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].src
<object> Segment source.
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].src.ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].src.name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].src.ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].dst
<object> Segment destination.
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].dst.ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].dst.name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
query.network_segments
[CNetworkSegment].dst.ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
query.macless_ports
<string> Query macless ports. Include switch ports without a MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.hosts
<array of <object>> Query hosts. Can be one of GET /reporting/hosts. Optional
CloudSyncOnDemandReport.report.criteria.
query.hosts[CHost]
<object> One CHost object. Optional
CloudSyncOnDemandReport.report.criteria.
query.hosts[CHost].mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.hosts[CHost].ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.hosts[CHost].name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.ignore_dhcp
<string> Query ignore DHCP. Use only switch port polling for ARP Bindings. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs
<array of <object>> Query host pairs. Can be one of GET /reporting/host_pairs. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair]
<object> One CHostPair object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].server
<object> Specification of the server host.
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].server.
ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].server.
name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].client
<object> Specification of the client host.
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].client.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].client.
ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_pairs[CHostPair].client.
name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
query.area
<string> Query area. Can be one of GET /reporting/areas. Optional
CloudSyncOnDemandReport.report.criteria.
query.protocols
<array of <object>> Query protocols. Can be one of GET /reporting/protocols. Optional
CloudSyncOnDemandReport.report.criteria.
query.protocols[CProtocol]
<object> Object representing Protocol information. Optional
CloudSyncOnDemandReport.report.criteria.
query.protocols[CProtocol].id
<number> ID of the Protocol. Optional
CloudSyncOnDemandReport.report.criteria.
query.protocols[CProtocol].name
<string> Name of the Protocol. Optional
CloudSyncOnDemandReport.report.criteria.
query.group_dev_iface
<string> Query host groups and/or devices and/or interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
query.centricity
<string> Query centricity. Can be one of GET /reporting/centricities. Optional
CloudSyncOnDemandReport.report.criteria.
query.limit
<number> Query data limit. Maximum number of rows to be returned. Default value: 10000. Optional
CloudSyncOnDemandReport.report.criteria.
query.interfaces
<array of <object>> Query interfaces. Can be one of GET /reporting/interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
query.interfaces[CInterface]
<object> One CInterface object. Optional
CloudSyncOnDemandReport.report.criteria.
query.interfaces[CInterface].ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
query.interfaces[CInterface].name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
query.interfaces[CInterface].ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_groups
<array of <object>> Query host_groups. Can be one of GET /reporting/host_groups. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_groups[CHostGroup]
<object> One CHostGroup object. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_groups[CHostGroup].name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
query.host_groups[CHostGroup].group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
query.realm
<string> Query realm. Can be one of GET /reporting/realms.
CloudSyncOnDemandReport.report.criteria.
query.dscps
<array of <object>> Query dscps. Can be one of GET /reporting/dscps. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscps[CDSCP]
<object> One CDSCP object. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscps[CDSCP].name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
query.dscps[CDSCP].code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications
<array of <object>> Query applications. Can be one of GET /reporting/applications. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications[CApplication]
<object> One CApplication object. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications[CApplication].id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications[CApplication].code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications[CApplication].name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
query.applications[CApplication].
tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
network_type
<string> Specifies the network type the user wants the report on. Available options are PHYSICAL, CLOUD, AWS_VPC(deprecated, works as CLOUD), VXLAN, PHYSICAL_TUNNEL_VXLAN. Optional; Values: PHYSICAL, CLOUD, HYBRID, AWS_VPC, VXLAN, PHYSICAL_TUNNEL_VXLAN
CloudSyncOnDemandReport.report.criteria.
queries
<array of <object>> Array of Query objects. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter]
<object> Report Query. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ports
<array of <object>> Query ports. Can be one of GET /reporting/ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ports
[CProtoPort]
<object> One CProtoPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ports
[CProtoPort].port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ports
[CProtoPort].protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ports
[CProtoPort].name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports
<array of <object>> Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort]
<object> One CDSCPAppPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].port.
protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].app.
tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].dscp
<object> DSCP specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].dscp.name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_app_ports[CDSCPAppPort].dscp.
code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].port_groups
<array of <object>> Query port_groups. Can be one of GET /reporting/port_groups. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].port_groups
[CPortGroup]
<object> One CPortGroup object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].port_groups
[CPortGroup].name
<string> Name of the port group. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].port_groups
[CPortGroup].group_id
<number> ID of the port group. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
cbqos_classes
<array of <object>> Query CBQoS classes. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
cbqos_classes[CCBQOSCLASS]
<object> Object representing a CBQoS class. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
cbqos_classes[CCBQOSCLASS].id
<string> CBQoS class id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpasscope
<string> Query autonomous system scope. Optional; Values: ALL, PRIVATE, PUBLIC
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs
<array of <object>> Query host_group_pairs. Can be one of GET /reporting/host_group_pairs. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair]
<object> One CHostGroupPair object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
server
<object> Server host group specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
server.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
server.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
client
<object> Client host group specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
client.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pairs[CHostGroupPair].
client.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].wan_group
<string> Query WAN group. Can be any Interface Group under /WAN. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
traffic_expression
<string> Query-specific traffic expression. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
include_non_optimized_sites
<string> Query include non-optimized. Include non-optimized sites in a WAN query. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].columns
<array of <number>> Query columns. Can be many of GET /reporting/columns. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].columns
[item]
<number> Query column. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
sort_direction
<string> Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default). Optional; Values: ASC, DESC
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
<array of <object>> Query autonomous system pairs. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair]
<object> Pair of Autonomous Systems. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].server
<object> Object representing a server Autonomous System.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].server.id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].server.name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].client
<object> Object representing a client Autonomous System.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].client.id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas_pairs
[CBGPASPair].client.name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
<array of <object>> Query application_servers. Can be one of GET /reporting/application_servers. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer]
<object> One CApplicationServer object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].server
<object> Server specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_servers
[CApplicationServer].server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].devices
<array of <object>> Query devices. Can be one of GET /reporting/devices. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].devices
[CDevice]
<object> One CDevice object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].devices
[CDevice].ipaddr
<string> Device IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].devices
[CDevice].name
<string> Device name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports
<array of <object>> Query application_ports. Can be one of GET /reporting/application_ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort]
<object> One CApplicationPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
application_ports[CApplicationPort].
app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].mplsexpbits
<array of <object>> Query mplsexpbits. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].mplsexpbits
[CMPLSEXPBIT]
<object> One CMPLSEXPBIT object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].mplsexpbits
[CMPLSEXPBIT].traffic_class
<string> MPLSEXPBIT traffic class name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].mplsexpbits
[CMPLSEXPBIT].exp_bit
<number> MPLSEXP Bit. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups
<array of <object>> Query autonomous system and host group. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup]
<object> Object representing Autonomous System and Host Group. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
host_group
<object> Object representing a Host Group.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
host_group.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
host_group.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
bgpas
<object> Object representing a Autonomous System.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
bgpas.id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
bgpas_host_groups[CBGPASHostGroup].
bgpas.name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports
<array of <object>> Query host_pair_ports. Can be one of GET /reporting/host_pair_ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort]
<object> One CHostPairPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].port.
port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].port.
protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].port.
name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].server
<object> Server host specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].server.
mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].server.
ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].server.
name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].client
<object> Client host specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].client.
mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].client.
ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_ports[CHostPairPort].client.
name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces
<array of <object>> Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface]
<object> One CDSCPInterface object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].
interface
<object> Interface specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].
interface.ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].
interface.name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].
interface.ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].dscp
<object> DSCP specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].dscp.
name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
dscp_interfaces[CDSCPInterface].dscp.
code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas
<array of <object>> Query autonomous system. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas
[CBGPAS]
<object> Object representing a Autonomous System. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas
[CBGPAS].id
<number> Autonomous System Number. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].bgpas
[CBGPAS].name
<string> Autonomous System Name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].role
<string> Query role. Can be one of /reporting/roles. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].show_ttl
<string> Query show TTL. Only applicable to flow list report format. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].group_by
<string> Query group_by. Can be one of GET /reporting/group_bys. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
case_insensitive
<string> Query user case insensitivity. Whether to search for users in a case-insensitive fashion. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].switch_name
<string> Query switch name. Can be an IP address or a name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].macs
<string> Query MAC addresses. Host MAC addresses, only apply to switch_port requests. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_type
<string> Query host group type. Required for "host group (gro)" "host group pairs (gpp)" and "host group pairs with ports (gpr)" queries. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports
<array of <object>> Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort]
<object> One CHostPairAppPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
app
<object> Application specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
app.id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
app.code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
app.name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
app.tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
server
<object> Server host specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
client
<object> Client host specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
client.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
client.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_pair_app_ports[CHostPairAppPort].
client.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].direction
<string> Query direction. Can be one of GET /reporting/directions. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].users
<array of <object>> Query time host users. Can be one of GET /reporting/time host user. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].users
[CUser]
<object> One CUser object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].users
[CUser].name
<string> Active Directory user name.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
switch_ports
<string> Query switch ports. Switch port addresses. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].sort_column
<number> Query sort column. Can be one of GET /reporting/columns. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
<array of <object>> Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort]
<object> One CHostGroupPairPort object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].port
<object> Port specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].port.port
<number> Port specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].port.protocol
<number> Protocol specification. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].port.name
<string> Protocol + port combination name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].server
<object> Server host group specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].server.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].server.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].client
<object> Client host group specification.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].client.name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
host_group_pair_ports
[CHostGroupPairPort].client.group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments
<array of <object>> Query network_segments. Can be one of GET /reporting/network_segments. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment]
<object> One CNetworkSegment object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].src
<object> Segment source.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].src.
ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].src.
name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].src.
ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].dst
<object> Segment destination.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].dst.
ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].dst.
name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
network_segments[CNetworkSegment].dst.
ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
macless_ports
<string> Query macless ports. Include switch ports without a MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].hosts
<array of <object>> Query hosts. Can be one of GET /reporting/hosts. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].hosts
[CHost]
<object> One CHost object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].hosts
[CHost].mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].hosts
[CHost].ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].hosts
[CHost].name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].ignore_dhcp
<string> Query ignore DHCP. Use only switch port polling for ARP Bindings. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
<array of <object>> Query host pairs. Can be one of GET /reporting/host_pairs. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair]
<object> One CHostPair object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].server
<object> Specification of the server host.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].server.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].server.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].server.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].client
<object> Specification of the client host.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].client.mac
<string> Host MAC address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].client.ipaddr
<string> Host IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_pairs
[CHostPair].client.name
<string> Host name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].area
<string> Query area. Can be one of GET /reporting/areas. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].protocols
<array of <object>> Query protocols. Can be one of GET /reporting/protocols. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].protocols
[CProtocol]
<object> Object representing Protocol information. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].protocols
[CProtocol].id
<number> ID of the Protocol. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].protocols
[CProtocol].name
<string> Name of the Protocol. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
group_dev_iface
<string> Query host groups and/or devices and/or interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].centricity
<string> Query centricity. Can be one of GET /reporting/centricities. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].limit
<number> Query data limit. Maximum number of rows to be returned. Default value: 10000. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].interfaces
<array of <object>> Query interfaces. Can be one of GET /reporting/interfaces. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].interfaces
[CInterface]
<object> One CInterface object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].interfaces
[CInterface].ipaddr
<string> Interface IP address. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].interfaces
[CInterface].name
<string> Interface name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].interfaces
[CInterface].ifindex
<number> Interface index. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_groups
<array of <object>> Query host_groups. Can be one of GET /reporting/host_groups. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_groups
[CHostGroup]
<object> One CHostGroup object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_groups
[CHostGroup].name
<string> Host group name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].host_groups
[CHostGroup].group_id
<number> Host group ID. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].realm
<string> Query realm. Can be one of GET /reporting/realms.
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].dscps
<array of <object>> Query dscps. Can be one of GET /reporting/dscps. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].dscps
[CDSCP]
<object> One CDSCP object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].dscps
[CDSCP].name
<string> DSCP name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].dscps
[CDSCP].code_point
<number> DSCP code point. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications
<array of <object>> Query applications. Can be one of GET /reporting/applications. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications[CApplication]
<object> One CApplication object. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications[CApplication].id
<number> Application id. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications[CApplication].code
<string> Application code. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications[CApplication].name
<string> Application name. Optional
CloudSyncOnDemandReport.report.criteria.
queries[ReportQueryFilter].
applications[CApplication].tunneled
<string> Flag: is the application tunneled. Optional
CloudSyncOnDemandReport.report.criteria.
deprecated
<object> Map with legacy criteria attributes that will not be supported soon. Optional
CloudSyncOnDemandReport.report.criteria.
deprecated[prop]
<string> ReportDeprecatedFilters map value. Optional
CloudSyncOnDemandReport.report.criteria.
vni
<string> Specifies VNI, needed if network_type is VXLAN or PHYSICAL_TUNNEL_VXLAN. Optional
CloudSyncOnDemandReport.report.criteria.
fast_data_source
<string> Options to force using fast (pre-computed) interfaces data. FORCE: force using only fast data. ON: use fast data when possible, fallback to slower traffic query. OFF: never use fast data. By default it is ON. Optional; Values: FORCE, ON, OFF
CloudSyncOnDemandReport.report.criteria.
app_reduction
<string> App reduction. Turn app reduction on or off. Optional
CloudSyncOnDemandReport.report.timeout <number> Used when doing POST to /reporting/reports/synchronous. Timeout (# of seconds) to wait for the repot to complete, it the report does not complete the operation will return and the client needs to wait for progress. Optional
CloudSyncOnDemandReport.report.name <string> Report name. Optional
CloudSyncOnDemandReport.report.
template_id
<number> Template ID. Can be one of GET /reporting/templates.
CloudSyncOnDemandReport.uuid <string> Unique ID on the cloud.
Response Body

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

  • JSON
{
  "run_time": number,
  "error_text": string,
  "remaining_seconds": number,
  "saved": string,
  "id": number,
  "status": string,
  "percent": number,
  "user_id": number,
  "size": number,
  "name": string,
  "template_id": number
}

Example:
{
  "status": "completed", 
  "user_id": 1, 
  "name": "Host Information Report", 
  "percent": 100, 
  "template_id": 952, 
  "remaining_seconds": 0, 
  "run_time": 1352494550, 
  "saved": true, 
  "id": 1001, 
  "error_text": "", 
  "size": 140
}
Property Name Type Description Notes
ReportInfo <object> Object representing report information.
ReportInfo.run_time <number> Time when the report was run (Unix time).
ReportInfo.error_text <string> A report can be completed with an error. Error message may provide more detailed info. Optional
ReportInfo.remaining_seconds <number> Number of seconds remaining to run the report. Even if this number is 0, the report may not yet be completed, so check 'status' to make sure what the status is.
ReportInfo.saved <string> Boolean flag indicating if the report was saved.
ReportInfo.id <number> ID of the report. To be used in the API.
ReportInfo.status <string> Status of the report. Values: completed, running, waiting
ReportInfo.percent <number> Progress of the report represented by percentage of report completion.
ReportInfo.user_id <number> ID of the user who owns the report.
ReportInfo.size <number> Size of the report in kilobytes.
ReportInfo.name <string> Name of the report. Could be given by a user or automatically generated by the system. Optional
ReportInfo.template_id <number> ID of the template that the report is based on.

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
INTERNAL_ERROR 500 Internal server error.
AUTH_REQUIRED 401 The requested resource requires authentication.
AUTH_INVALID_CREDENTIALS 401 Invalid username and/or password.
AUTH_INVALID_SESSION 401 Session ID is invalid.
AUTH_EXPIRED_PASSWORD 403 The password must be changed. Access only to password change resources.
AUTH_DISABLED_ACCOUNT 403 Account is either temporarily or permanently disabled.
AUTH_FORBIDDEN 403 User is not authorized to access the requested resource.
AUTH_INVALID_TOKEN 401 OAuth access token is invalid.
AUTH_EXPIRED_TOKEN 401 OAuth access token is expired.
AUTH_INVALID_CODE 401 OAuth access code is invalid.
AUTH_EXPIRED_CODE 401 OAuth access code is expired.
RESOURCE_NOT_FOUND 404 Requested resource was not found.
HTTP_INVALID_METHOD 405 Requested method is not available for this resource.
HTTP_INVALID_HEADER 400 An HTTP header was malformed.
REQUEST_INVALID_INPUT 400 Malformed input structure.
URI_INVALID_PARAMETER 400 URI parameter is not supported or malformed.
URI_MISSING_PARAMETER 400 Missing required parameter.