SCG: How to Collect SCG Health Status from API

Summary: How to collect Secure Connect Gateway (SCG) Health Status from an Application Programming Interface (API) query. This method is useful to analyze of the status of all SCG components (connectivity status, keepalive status, status of all services, connected devices system info). ...

This article applies to This article does not apply to This article is not tied to any specific product. Not all product versions are identified in this article.
Check out other resources

Instructions

This was tested on Secure Connect Gateway version 5.10.00.10.

Below are the steps necessary to perform an API query to SCG to collect all health information:
 

  1. Enable REST API interfaces in Secure Connect Gateway.
    You must enable REST API interfaces in SCG to allow integration with your data center tools and applications.
    To enable API interfaces, open the SCG panel on Web Browser (https://<IP_SCG>:5700), go to Settings > API settings, select the Enable API interfaces for this gateway checkbox and click Apply:Screenshot of enabling REST API in SCG
  2. Open an SSH session to the SCG gateway with the root user and performance the commands below:
    Generating the Auth Token with the SCG gateway - To perform all APIs queries to the SCG gateway is necessary before obtaining the authorization token. In this case, we will obtain the authorization token and store it on a system variable to facilitate the next API queries: 
    AUTH_TOKEN=`curl -k -s -L -i -X --header "Content-Type: application/json" --request POST --data '{"username":"admin","password":"admin_password"}' 'https://10.108.0.40:5700/SupportAssist/api/v2/auth/token?accessToken' | grep "accessToken" | awk -F ":" {'print $2'} | sed 's/,$//' | sed 's/^..//' | sed 's/.$//'`
    Where:
    • admin = admin user of SCG
    • admin_password = admin password of SCG
    • 10.108.0.40 = IP address of SCG
    Example: 
    scg:~ # AUTH_TOKEN=`curl -k -s -L -i -X --header "Content-Type: application/json" --request POST --data '{"username":"admin","password":"admin_password"}' 'https://10.108.0.40:5700/SupportAssist/api/v2/auth/token?accessToken' | grep "accessToken" | awk -F ":" {'print $2'} | sed 's/,$//' | sed 's/^..//' | sed 's/.$//'`

scg:~ # echo $AUTH_TOKEN
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwicm9sZSI6IlNDR0FkbWlucyIsInJlcXVlc3RpbmdJUCI6IjEwLjEwNy4wLjM5IiwiYXBwTW9kZSI6IkFQUExJQU5DRVMiLCJhcGlVc2FnZU1vZGUiOiJSZXN0IiwiaW5zdGFuY2VJRCI6ImJGMFhhdUk2MVI2REtZM3A5a0NKTHdVWlMwTGhPUjRNaVJydEhPTkgxamFxa2Zrb0xONDlGeXNraXB5ZVFjUmxsSlFyTFJQQkJtNlRZeGNTWGxleEJBPT0iLCJ0b2tlblR5cGUiOiJBQ0NFU1MiLCJ1dWlkIjoiZGFkYjYxY2EtNjNmZi00ODRlLWEwOGUtOTA0OGY0NzczYzJmIiwiaWF0IjoxNjQ4NzQzODk2LCJleHAiOjE2NDg3NDU2OTZ9.D2ziJJhc8dAyqiFIwXucluWLwsdKVSv1TqQAnt1b8KA
  3. Running the API query to get the SCG health status:
    With this API query, it is possible to see a lot of information about the SCG:
    - Status of connectivity
    - Status of keepalive
    - Status of each SCG service (esrshttpd, esrshttpdR, esrsconnectemc, networkConnectivity, and others)
    - Status of monitored devices

    Below is the API query to collect the health information status: 
    curl -k -X GET --header "Accept: application/json" --header "Authorization: Bearer $AUTH_TOKEN" https://10.108.0.40:5700/SupportAssist/api/v2/service/healthstatus?
    Example: 
    scg:~ # curl -k -X GET --header "Accept: application/json"  --header "Authorization: Bearer $AUTH_TOKEN" https://10.108.0.40:5700/SupportAssist/api/v2/service/healthstatus?

{
  "data" : {
    "runDate" : "Mar 31, 2022 12:03:57 -EDT",
    "gatewayInfo" : {
      "serialNumber" : "XXXXXXXXXX",
      "productModel" : "SECURECONNECTGATEWAY-APPLIANCE",
      "ipAddress" : "10.108.0.40",
      "gatewayVersion" : "5.00.07.10"
    },
    "connectivity" : {
      "mqttStatus" : {
        "state" : "CONNECTED",
        "updatedAt" : "2022-03-28T20:58:38.244+00:00",
        "recommendation" : ""
      },
      "keepaliveStatus" : {
        "state" : "CONNECTED",
        "updatedAt" : "2021-11-22T04:27:05.198+0000",
        "recommendation" : ""
      }
    },
    "services" : [ {
      "serviceName" : "esrshttpd",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "Service to securely transfer files between your devices and secure connect gateway",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrshttpdR",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A service that manages file transfers from your gateway to Dell Technologies, or to your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsconnectemc",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A service at Dell Technologies that receives alert data from your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsclientproxy",
      "criticality" : "Warning",
      "serviceType" : "Core service status",
      "description" : "A service for connectivity between devices and Dell Technologies",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrswatchdogservice",
      "criticality" : "Warning",
      "serviceType" : "Core service status",
      "description" : "A service that monitors whether or not other services are running or down. When services go down unexpectedly, the watchdog service will attempt to restart them so they start functioning normally again",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrshttpdftp",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A service at Dell Technologies that receives alert data from your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrshttpdlistener",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A service at Dell Technologies that receives alert data from your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "shibd",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A Service for remote secure credentials",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "apache2",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A Service for remote secure credentials",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsjcemc",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service at Dell Technologies that receives alert data from your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrskeepalive",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "Device service that sends heartbeat status from devices to Dell Technologies",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsmftauth",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service that transfers files between Dell, your gateway, and your devices",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsupdate",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service to retreives update information from Dell Technologies",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsdigitaltwinservice",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service for connectivity between devices and Dell Technologies",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsmqttclient",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service that monitors connectivity between the gateway and Dell",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsmosquitto",
      "criticality" : "Critical",
      "serviceType" : "Core service status",
      "description" : "A service that transfers files between your gateway local system to Dell",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "esrsmqttauth",
      "criticality" : "Critical",
      "serviceType" : "Restful service status",
      "description" : "A service that validates credentials for remote support activities",
      "status" : "Running",
      "recommendation" : ""
    }, {
      "serviceName" : "srsadapter",
      "description" : "A service that manages the communications between containers",
      "status" : "running"
    }, {
      "serviceName" : "secureconnectgateway",
      "description" : "A service that allows access to secure connect gateway's user interface.",
      "status" : "running"
    }, {
      "serviceName" : "cases",
      "description" : "A service that manages alerts, events, and support cases generated by your gateway.",
      "status" : "running"
    }, {
      "serviceName" : "auditlog",
      "description" : "A service that displays your gateway's activity history.",
      "status" : "running"
    }, {
      "serviceName" : "connectivity",
      "description" : "A service that manages connectivity with the Dell Technologies backend.",
      "status" : "running"
    }, {
      "serviceName" : "appsettings",
      "description" : "A service to save changes for configuration settings.",
      "status" : "running"
    }, {
      "serviceName" : "consoleadapter",
      "description" : "A service that manages connectivity with systems management consoles.",
      "status" : "running"
    }, {
      "serviceName" : "registration",
      "description" : "A service that registers your secure connect gateway.",
      "status" : "running"
    }, {
      "serviceName" : "collection",
      "description" : "A service that initiates collection of telemetry from devices, then retreives that telemetry and displays it in your gateway. ",
      "status" : "running"
    }, {
      "serviceName" : "inventory",
      "description" : "A service that retreives inventory information from devices.",
      "status" : "running"
    }, {
      "serviceName" : "secureconnectgatewaydb",
      "description" : "A service that allows access to secure connect gateway's database.",
      "status" : "running"
    }, {
      "serviceName" : "email",
      "description" : "A service that manages and sends emails from secure connect gateway.",
      "status" : "running"
    } ],
    "networkConnectivity" : [ {
      "hostName" : "esrs3-core.emc.com",
      "port443" : {
        "status" : "CONNECTED",
        "recommendation" : ""
      },
      "port8443" : {
        "status" : "CONNECTED",
        "recommendation" : ""
      }
    }, {
      "hostName" : "esrs3-coredr.emc.com",
      "port443" : {
        "status" : "CONNECTED",
        "recommendation" : ""
      },
      "port8443" : {
        "status" : "CONNECTED",
        "recommendation" : ""
      }
    } ],
    "systemInfo" : {
      "systemInfo" : "VMware, Inc.",
      "noOfProcessors" : 4,
      "memory" : {
        "memoryUsage" : "12.21 / 15.66 GB (78%)",
        "status" : "HEALTHY",
        "message" : ""
      },
      "cpu" : {
        "cpuLoad" : "2.65%",
        "status" : "HEALTHY"
      },
      "diskSpaceDetails" : [ {
        "partitionName" : "/dev/sda1",
        "availableDiskSpace" : "0.21 GB",
        "used" : "28%"
      }, {
        "partitionName" : "/dev/mapper/scgVG-LVRoot",
        "availableDiskSpace" : "13.31 GB",
        "used" : "13%"
      }, {
        "partitionName" : "/dev/mapper/scgVG-LVvar_lib_docker",
        "availableDiskSpace" : "86.77 GB",
        "used" : "8%"
      }, {
        "partitionName" : "/dev/mapper/scgVG-LVvar_log",
        "availableDiskSpace" : "7.35 GB",
        "used" : "6%"
      }, {
        "partitionName" : "/dev/mapper/scgVG-LVvar_lib_scgve",
        "availableDiskSpace" : "7.36 GB",
        "used" : "6%"
      }, {
        "partitionName" : "/dev/mapper/scgVG-LVopt_esrsve",
        "availableDiskSpace" : "7.35 GB",
        "used" : "6%"
      } ]
    },
    "smtp" : {
      "status" : "Connected"
    }
  },
  "email" : "Timed out after waiting 30000(ms) for a reply. address: __vertx.reply.1bd9b6f0-73e1-4f27-8f57-207c3c5577bb, repliedAddress: emailApplianceService.queue"
}scg:~ #

To save the report to a file:

curl -k -X GET --header "Accept: application/json" -o report_scg.txt --header "Authorization: Bearer $AUTH_TOKEN" https://10.108.0.40:5700/SupportAssist/api/v2/service/healthstatus?


Where:
-o report_scg.txt = This option is used to save the output in the "report_scg.txt" file.

Important - Authentication Mechanisms:
The authentication process starts when the client makes a request for a token from the server by providing its credentials. In response, Secure Connect Gateway returns an access token and a refresh token. The refresh token is valid for 24 hours, while the access token is valid for 30 minutes. After the access token expires, you can generate a new access token by using the refresh token.

Additional Information

Secure Connect Gateway REST API Guide:

Affected Products

VxRail, Secure Connect Gateway, Secure Connect Gateway - Virtual Edition, VxRail Appliance Family, VxRail Appliance Series
Article Properties
Article Number: 000197829
Article Type: How To
Last Modified: 18 Nov 2025
Version:  3
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.