#System health API

1 messages · Page 1 of 1 (latest)

unreal sluice
#

Is there any ONTAP RestAPI related to the following commands,

  1. system health alert show
  2. system health subsystem show
    I cannot find any related API on the document.
sick perch
#

You can use below through private cli Rest calls

  1. https://CLUSTER_IP/api/private/cli/system/health/alert?fields=subsystem,indication_time,perceived_severity,probable_cause,probable_cause_description,corrective_actions,possible_effect,acknowledge,suppress,policy,acknowledger,suppressor,additional_info,alerting_resource_name,tags
  2. https://CLUSTER_IP/api/private/cli/system/health/subsystem?fields=health,subsystem,outstanding_alert_count,suppressed_alert_count,node,init_state

Harvest uses the second one (not all fields) to collect subsystem details already through Rest API
https://github.com/NetApp/harvest/blob/main/conf/rest/9.12.0/subsystem.yaml

outer crane
#

I am new to REST API. What can this API really do for me? It works for me, but can you please show me an example in what circumstances I need this?https://cluster_ip/api/private/cli/system/health/subsystem?fields=health,subsystem,outstanding_alert_count,suppressed_alert_count,node,init_state

sick perch
outer crane
#

Exactly, my question was, Why do I need to use REST API to achieve the same ONTAP cli can do?

sick perch
#

Rest API may come handy for automation purposes if you are making use of Rest calls.

outer crane
#

Right, I heard the same, but how? that "https://..." seems long and not easy to remember and cannot be programmed. How can I use it for automation? Can you please show me an example for a real use case? I can use bash for automation, why would I need REST API?

sick perch
wintry pewter
#

I used bash for "automating" before and can happily say that using the API is the way to go; everything becomes much easier with structured output. Be it with python, powershell, ansible or something else.

outer crane
#

@sick perch
Can I execute the 2nd link independently? If yes, how can I do that? Is it an Ansible code? what is the execution environment?

As you can tell, I am new to all these, I would appreciate it very much if you can help me to go through steps.

sick perch
#

Harvest is written in GO and can be installed in various ways as mentioned in above link.

outer crane
sick perch
#

You can always use curl to see the output of the Rest End Point.

outer crane
#

Can you please show me an example on using curl to run an REST API?

sick perch
#

sure. Just replace USER/PASSWORD and CLUSTER_IP in below
curl -k -uUSER:PASSWORD 'https://CLUSTER_IP/api/private/cli/system/health/subsystem?fields=health,subsystem,outstanding_alert_count,suppressed_alert_count,node,init_state'

#

sample output format will be like below

{
  "records": [
    {
      "subsystem": "sas_connect",
      "health": "ok",
      "init_state": "initialized",
      "outstanding_alert_count": 0,
      "suppressed_alert_count": 0,
      "node": [
        "umeng-aff300-01",
        "umeng-aff300-02"
      ]
    },
    {
      "subsystem": "environment",
      "health": "ok",
      "init_state": "initialized",
      "outstanding_alert_count": 0,
      "suppressed_alert_count": 0,
      "node": [
        "umeng-aff300-01",
        "umeng-aff300-02",
        "umeng-aff300-02"
      ]
    },
    {
      "subsystem": "memory",
      "health": "ok",
      "init_state": "initialized",
      "outstanding_alert_count": 0,
      "suppressed_alert_count": 0,
      "node": [
        "umeng-aff300-01",
        "umeng-aff300-02"
      ]
    },
}
outer crane
#

Works with ONTAP in Data Center. Thanks for leading me through! Some other follow-ups:

  1. If it is true that we should always use a programming language, like python, powershell etc together with REST API to automate tasks, it alone cannot do much for us?
  2. I noticed some REST API has .../private/.. in it. Some doesn't. What is the diffrence?
  3. I am not sure of if you are familiar with REST API for FSx ONTAP, but, it doesn't work from clients located in Data Center to FSx ONTAP. It works from client in VPC. Any idea of why?
sick perch
outer crane
#

A last question:
If I call "curl..." in my bash scripts, what is a good way to extract fields from JASON response body as the result?

sick perch
outer crane
#

One more last question:
Comparing ZAPI API and REST API, do you have an estimation on what percentage of all ZAPI API's can be all achieved by REST API's?

We have found something works in ZAPI API but not in REST API, let say ONTAP 9.11.1 or 9.12.1