Generating a controller support report

The controller support report provides data, such as JVM metrics, that can be useful when troubleshooting.

The support command lists the controller support report.

Optionally you can specify one or more of the following parameters:

id

The list of contributors to include in the returned support report data. For example, to include only items reported by the controller JVM metrics, specify the following string:

id=jvm-metrics

fields

The set of fields to be returned in the report. For example, to include only the title and content fields, specify the following string:

fields=title,content

If you specify more than one parameter, the support report includes only those items that match all the parameters you specify.

If you do not specify a value for a parameter, the support report includes all items for that parameter.

Command form


curl --noproxy controller_ip -X GET \
--header "X-Auth-Token:token" --fail -ksSfL \
--url “https://controller_ip:8443/sdn/v2.0/support?id=id-string&fields=fields-string

Command example


curl --noproxy 10.1.1.9 -X GET \
--header "X-Auth-Token:3d61f0d3e61349359e6dbd82ec02c113" --fail -ksSfL \
--url “https://10.1.1.9:8443/sdn/v2.0/support"

Example output

The following example contains a partial listing of the support report returned by the previous command:

{
   "support_report":[
      {
         "title":"Alert Framework",
         "id":"alert",
         "content":[
            "Alert-Topics: licensing",
            "Alert-Count: 7",
            "Data Retention Age Out: 14 days",
            "Data Trim Interval: 24 hours",
            "Data Trim Enabled: true",
            "Last trim conducted at: Mon Sep 22 19:15:20 PDT 2014"
         ]},
      {
          "title":"Alert Topic Listener",
          "id":"alert_listener",
          "content":[
             "No registered alert topic listeners"
          ]},
      {
          "title":"App Manager",
          "id":"app-management",
          "content":["Installed Applications: 8",
             "Path Diagnostics, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "Link Manager, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "Node Manager, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "OpenFlow Link Discovery, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "OpenFlow Node Discovery, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "Path Daemon, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "Topology Manager, Version: 2.5.0.SNAPSHOT, State: ACTIVE",
             "Topology Viewer, Version: 2.5.0.SNAPSHOT, State: ACTIVE"
           ]},
.
.
.     {
          "title":"JVM Metrics",
          "id":"jvm-metrics",
          "content":[
             "Metric count:  44",
             "Last update time:  Wed, 24 Sep 2014 01:31:55 GMT",
             "Uptime:  10,037 minute(s)",
             "Memory",
             "  Total",
             "    Initial:  548,288 kB",
             "    Committed:  740,032 kB",
             "    Maximum:  4,301,824 kB",
             "    Used:  477,308 kB",
             "  Heap",
             "    Initial:  524,288 kB",
             "    Committed:  655,360 kB",
             "    Maximum:  3,728,384 kB",
             "    Used:  393,227 kB",
             "    Usage:  10.547 %",
             "  Non-Heap",
             "    Initial:  24,000 kB",
             "    Committed:  84,672 kB",
             "    Maximum:  573,440 kB",
             "    Used:  84,081 kB",
             "    Usage:  14.663 %",
             "NIO Buffer Memory",
             "  Direct",
             "    Capacity:  0 bytes",
             "    Used:  0 bytes",
             "    Buffers:  0",
             "  Mapped",
             "    Capacity:  0 bytes",
             "    Used:  0 bytes",
             "    Buffers:  0",
             "Garbage Collection (last 1 minute(s))",
             "  Executions:  0",
             "  Elapsed time:  0 ms",
             "Threads",
             "  Total count:  122",
             "  By Type",
             "    Daemon:  65",
             "    Non-daemon:  57",
             "  By State",
             "    Blocked:  0",
             "    Deadlocked:  0",
             "    New:  0",
             "    Runnable:  7",
             "    Terminated:  0",
             "    Timed waiting:  24",
             "    Waiting:  91",
             "Operating System",
             "  CPU Usage",
             "    System:  0.079 %",
             "    JVM:  0.058 %",
             "  File Descriptors",
             "    Maximum:  8,192",
             "    Open:  214",
             "    Usage:  2.612 %"
          ]},
.
.
.