How to automate Engine's Orphaned File Check task using API calls

How to automate Engine's Orphaned File Check task using API calls

This article outlines a method to automate the Orphaned File Check task using a PowerShell script in combination with the CURL command.

Command formatting guidelines:

  • Each command includes a payload section, which can be customized depending on the POST command being used.

  • Replace the UserName:AccountPassword placeholder with the actual account name and password.

  • Substitute EMS_IP with the IP address of the EMS server.

  • Replace Cluster_FQDN with the fully qualified domain name of the server, as shown in the EMS server list.

A. To enable ophaned file detection and set the action to "delete":

  1. $payload = '
  2. {
  3. "autoDeletes":{"PRIMARY":true,"SECONDARY":true,"TERTIARY":true},
  4. "autoDeleteAction":1,
  5. "doFastCheck":true,
  6. "fastCheckTimeout":60000
  7. }'
  8. $url = "https://EMS_IP:9727/hbws/v4/server/Cluster_FQDN/data/FileStateMgr"

  10.    curl.exe -k -u "UserName:AccountPassword" `
  11.     -H "Content-Type: application/json" `
  12.     -d  $payload `
  13.   -X POST $url

B: To run the Orphaned File task on the first Passive:

  1. $payload = '{
  2. "server":"PRIMARY"
  3. }'
  4. $url = "https://EMS_IP:9727/hbws/v4/server/Cluster_FQDN/data/orphanedfilescheck"
  6.    curl.exe -k -u "UserName:AccountPassword" `
  7.     -H "Content-Type: application/json" `
  8.     -d  $payload `
  9.   -X POST $url

For example, to run an OrphanedFileCheck on the first Passive server using the NeverfailTest user account with the password Neverf@il, targeting the EMS server at 192.168.1.1 and the cluster named SqlServer.engine.lab, the code would be as follows:

  1. $payload = '{
  2. "server":"PRIMARY"
  3. }'
  4. $url = "https://192.168.1.1:9727/hbws/v4/server/SQLServer.engine.lab/data/orphanedfilescheck"

  6. curl.exe -k -u "NeverfailTest:Neverf@il" `
  7.     -H "Content-Type: application/json" `
  8.     -d  $payload `
  9.    -X POST $url






    • Related Articles

    • Engine Management Service API

      Summary This knowledgebase article provides information about Engine Management Service (EMS) API: frequently used API endpoints (applicable to all supported CE versions) procedure for enabling, capturing and viewing Swagger API documentation (valid ...

    • How to Create a Task In Neverfail Continuity Engine

      Summary This Knowledge base article provides general information about how to create Tasks in Neverfail Continuity Engine. More Information Tasks are a generalization and extension of start, stop, and monitor scripts. Task types are grouped by when ...

    • File Server Plugin v201.5.8 - Release Notes

      Summary This Knowledgebase article provides information about this specific release of the File Server Plugin. More information File Server Plugin automatically configures protection for all of your file shares as they are created, edited, or ...

    • File Server Plugin v201.5.7 - Release Notes

      Summary This Knowledgebase article provides information about this specific release of the File Server Plugin. More information File Server Plugin automatically configures protection for all of your file shares as they are created, edited, or ...

    • Check Continuity Engine Server Status

      This article describes how to check server status by reviewing several indicators, including the system tray icon, the Server Details page and Applications page in EMS, and Windows services. Check Server Status Learning objectives At the end of the ...