Status - Host Group Summary

Request URL: /rest/status/hostgroup

URL parameters:

When include_cluster_health is set an additional cstatus field is returned in the output for each hostgroup entry. The value returned will be one of:

Value Meaning
not set all hosts underneath have no collector problems
1 has a host underneath which is monitored by a degraded cluster
2 has a host underneath which is monitored by an offline cluster
3 has a collector underneath and is degraded
4 has a collector underneath and is offline

Note

When using fromhostgroupid, previous versions of Opsview were counting hosts and services multiple times in the summary - from 6.0, this will be the correct total number.

Example output:

    {
       "summary" : {
          "handled" : "27",
          "unhandled" : "37",
          "service" : {
             "ok" : "4",
             "critical" : "3",
             "handled" : "10",
             "unhandled" : "35",
             "unknown" : "38",
             "total" : "45"
          },
          "total" : "64",
          "totalhgs" : "4",
          "host" : {
             "handled" : "17",
             "unhandled" : "2",
             "up" : "15",
             "down" : "4",
             "total" : "19"
          }
       },
       "list" : [
          {
             "hosts" : {
                "handled" : "7",
                "unhandled" : "1",
                "up" : {
                   "handled" : "6"
                },
                "down" : {
                   "handled" : "1",
                   "unhandled" : "1"
                },
                "total" : "8"
             },
             "hostgroupid" : "4",
             "services" : {
                "ok" : {
                   "handled" : "1"
                },
                "handled" : "4",
                "computed_state" : "unknown",
                "unhandled" : "15",
                "unknown" : {
                   "handled" : "3",
                   "unhandled" : "15"
                },
                "total" : "19"
             },
             "matpath" : [
                {
                   "name" : "Opsview",
                   "id" : "1"
                },
                {
                   "name" : "UK",
                   "id" : "3"
                }
             ],
             "computed_state" : "critical",
             "downtime" : "2",
             "name" : "Leaf",
             "leaf" : "0"
          },
          {
             "hosts" : {
                "handled" : "10",
                "unhandled" : "1",
                "up" : {
                   "handled" : "9"
                },
                "down" : {
                   "handled" : "1",
                   "unhandled" : "1"
                },
                "total" : "11"
             },
             "hostgroupid" : "1",
             "services" : {
                "ok" : {
                   "handled" : "3"
                },
                "critical" : {
                   "unhandled" : "3"
                },
                "handled" : "6",
                "computed_state" : "critical",
                "unhandled" : "20",
                "unknown" : {
                   "handled" : "3",
                   "unhandled" : "17"
                },
                "total" : "26"
             },
             "computed_state" : "critical",
             "matpath" : [],
             "downtime" : "2",
             "name" : "Opsview",
             "leaf" : "0"
          }
       ]
    }

Note

The computed_state keyword represents the highest state based on host state and service state. Specifically, this will return critical if the host is down or unreachable otherwise the service computed_state. This is available from Opsview 3.13.0.

The summary.totalhgs value represents the number of host groups in this request, without any filtering. This means that if the value is > 0, the user has access to see host groups from this part of the host group tree. If the value is 0, then the user does not have access to this part of the host group tree.

["Opsview On-premises"] ["API", "Technical Reference"]

Was this topic helpful?