Health (including Hardening) and Connectivity Status

This category covers the agent installation health, hardening, and the connectivity status. Installation health is based on SComC and SK service states (more details below). Both checks and control are provided for hardening and connectivity status.

Enumerations

enum HSDCHealth : DWORD { HSDCHealthUnknown = 0, HSDCHealthNotInstalled, HSDCHealthNotRunning, HSDCHealthOk }

enum HSDCHardening : DWORD { HSDCHardeningUnknown = 0, HSDCHardeningOff, HSDCHardeningRelaxed, HSDCHardeningOn }

enum HSDCConnectivityStatus : DWORD { HSDCStatusUnknown = 0, HSDCStatusOffline, HSDCStatusOnline }

Functions

HSDCError HSDCAPI HSDCGetHealth (DWORD *pHealth, DWORD *pHardening, char **pJstr)

Provides an aggregated health status of the agent installation.

HSDCError HSDCAPI HSDCRelaxHardening (const char *jstr, const unsigned char *signature, unsigned int signatureLength)

Relaxes hardening using a digitally signed JSON payload.

HSDCError HSDCAPI HSDCRelaxHardeningWithTicket (const wchar_t *filename)

Relaxes hardening using a digitally signed ticket. This format is a binary structure generated by the Device Control server, this approach should not be used in an agent integration.

HSDCError HSDCAPI HSDCGetConnectivityStatus (DWORD *pStatus, char **pJstr)

Gets the current connectivity status. The meaning depends on the option 60 ( oiOnlineAsWired) mode.

HSDCError HSDCAPI HSDCSetConnectivityStatus (DWORD status)

Sets the current connectivity status. This function has a meaning only when the option 60 ( oiOnlineAsWired) is set to manual.

HSDCError HSDCAPI HSDCGatherDiagnosticInfo (const wchar_t *const outputPath=nullptr)

Gathers a set of diagnostic information related to the agent's environment, policies, and status. It adds these items into an EsDiag folder within that path.

Enumeration Type Documentation

HSDCHealth

enum HSDCHealth : DWORD

Enumerators

HSDCHardening

enum HSDCHardening : DWORD

Enumerators

HSDCConnectivityStatus

enum HSDCConnectivityStatus : DWORD

Enumerators

Function Documentation

HSDCGetHealth()

HSDCError HSDCAPI HSDCGetHealth ( DWORD * pHealth, DWORD * pHardening, char ** pJstr )

Provides an aggregated health status of the agent installation.

Parameters

{
  "health": "ok",
  "hardening" : {
    "mode": "extended",
    "state" : "active",
    "salt" : "G88SJ-48WRA-3SQDH-DXRGM-N13AH"
  },
  "services" : [
         {
            "bitness" : "64",
            "filename" : "\\SystemRoot\\system32\\drivers\\sk.sys",
            "name" : "sk",
            "status" : "running",
            "version" : "5.3.39"
         },
         {
             "bitness" : "64",
             "filename" : "C:\\Program Files\\Ivanti\\Device and Application Control\\Client\\scomcd.exe",
             "name" : "scomc",
             "status" : "running",
             "version" : "5.3.715"
         },
         {
             "bitness" : "64",
             "filename" : "\\SystemRoot\\system32\\DRIVERS\\sk_ndis.sys",
             "name" : "sk-ndis-lwf",
             "status" : "running",
             "version" : "4.6.505"
         },
         {
             "bitness" : "64",
             "filename" : "\\SystemRoot\\system32\\drivers\\skfs.sys",
             "name" : "skfs",
             "status" : "running",
             "version" : "5.3.39"
        }
    ]
}

Returns

HSDCRelaxHardening()

HSDCError HSDCAPI HSDCRelaxHardening ( const char * jstr, const unsigned char * signature, unsigned int signatureLength )

Relaxes hardening using a digitally signed JSON payload.

Parameters

 {
    "version": "1",
    "salt": "G88SJ-48WRA-3SQDH-DXRGM-N13AH",
    "from": "2012-04-23T18:25:43.511Z",
    "until": "2012-04-23T20:25:43.511Z",
    "computers": [
        "machine.domain.com",
        "machine2"
    ],
    "users": [
        "S-1-5-21-812910569-3317027032-1161269547-7039",
        "S-1-5-32-544"
    ],
    "server": "server.domain.com",
    "admin": "Admin123",
    "comments": "LES 4.6 SR2 upgrade"
}

Returns

HSDCRelaxHardeningWithTicket()

HSDCError HSDCAPI HSDCRelaxHardeningWithTicket ( const wchar_t * filename )

Relaxes hardening using a digitally signed ticket. This format is a binary structure generated by the Device Control server, this approach should not be used in an agent integration.

An alternative is to copy the file in the Ticket folder specified during installation steps, but this will be asynchronous and will lack the feedback.

Parameters

Returns

HSDCGetConnectivityStatus()

HSDCError HSDCAPI HSDCGetConnectivityStatus ( DWORD * pStatus, char ** pJstr )

Gets the current connectivity status. The meaning depends on the option 60 ( oiOnlineAsWired) mode as described below:

• 0 "server": Online if the last agent communication with the device control server was successful, Offline otherwise
• 1 "wired" : Online if the network communication is performed though a wired NIC, Offline otherwise(WiFi, ...)
• 2 "manual": Online / Offline is controlled through the API

Parameters

{
   "mode": "wired"
   "status" : "online",
}

Returns

HSDCSetConnectivityStatus()

HSDCError HSDCAPI HSDCSetConnectivityStatus ( DWORD status )

Sets the current connectivity status. This function has a meaning only when the option 60 ( oiOnlineAsWired) is set to manual.

Parameters

Returns

HSDCGatherDiagnosticInfo()

HSDCError HSDCAPI HSDCGatherDiagnosticInfo ( const wchar_t *const outputPath = nullptr )

Gathers a set of diagnostic information related to the agent's environment, policies, and status. It adds these items into an EsDiag folder within that path.

Parameters

Returns