Child pages
  • WHM API 1 Functions - ea4_pre_migrate_check
Skip to end of metadata
Go to start of metadata

Description

This function lists blockers when you migrate from EasyApache 3 (EA3) to EasyApache 4 (EA4).

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API

/json-api/ea4_pre_migrate_check?api.version=1

 XML API
/xml-api/ea4_pre_migrate_check?api.version=1


 Command Line
whmapi1 ea4_pre_migrate_check
 Output (JSON)
{  
   "data":{  
      "ea4_pre_migrate_check":[  
         {  
            "desc":"Cpanel evaluates known issues such as network connectivty",
            "items":[  
               {  
                  "msg":""Cpanel::Easy::Apache::Fileprotect" ignored since it does not have an RPM.",
                  "status":1
               },
               {  
                  "status":1,
                  "msg":""Cpanel::Easy::Apache::SlowRestartPatch" ignored since it does not have an RPM."
               },
               {  
                  "msg":""Cpanel::Easy::PHP5::MagicQuotes" ignored since it does not have an RPM.",
                  "status":1
               },
               {  
                  "status":1,
                  "msg":""Cpanel::Easy::PHP5::MailHeaders" ignored since it does not have an RPM."
               }
            ],
            "name":"Cpanel Migrate Blocker",
            "vendor_id":"Cpanel",
            "version":1
         },
         {  
            "name":"Example",
            "items":[  
               {  
                  "msg":"Example item that means nothing",
                  "status":0
               }
            ],
            "desc":"Example to show you how",
            "vendor_id":"Example",
            "version":1
         },
         {  
            "version":1,
            "vendor_id":"Fail",
            "items":[  
               {  
                  "msg":"I block thee",
                  "status":2
               }
            ],
            "name":"Fail Blockers",
            "desc":"These are true blockers"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "result":1,
      "reason":"OK",
      "command":"ea4_pre_migrate_check"
   }
}
 Output (XML)
<xml>
    <data>
        <ea4_pre_migrate_check>
            <name>Cpanel Migrate Blocker</name>
            <desc>Cpanel evaluates known issues such as network connectivty</desc>
            <items>
                <msg>&#x201C;Cpanel::Easy::Apache::Fileprotect&#x201D; ignored since it does not have an RPM.</msg>
                <status>1</status>
            </items>
            <items>
                <msg>&#x201C;Cpanel::Easy::Apache::SlowRestartPatch&#x201D; ignored since it does not have an RPM.</msg>
                <status>1</status>
            </items>
            <items>
                <msg>&#x201C;Cpanel::Easy::PHP5::MagicQuotes&#x201D; ignored since it does not have an RPM.</msg>
                <status>1</status>
            </items>
            <items>
                <msg>&#x201C;Cpanel::Easy::PHP5::MailHeaders&#x201D; ignored since it does not have an RPM.</msg>
                <status>1</status>
            </items>
            <vendor_id>Cpanel</vendor_id>
            <version>1</version>
        </ea4_pre_migrate_check>
        <ea4_pre_migrate_check>
            <name>Example</name>
            <desc>Example to show you how</desc>
            <items>
                <msg>Example item that means nothing</msg>
                <status>0</status>
            </items>
            <vendor_id>Example</vendor_id>
            <version>1</version>
        </ea4_pre_migrate_check>
        <ea4_pre_migrate_check>
            <name>Fail Blockers</name>
            <desc>These are true blockers</desc>
            <items>
                <msg>I block thee</msg>
                <status>2</status>
            </items>
            <vendor_id>Fail</vendor_id>
            <version>1</version>
        </ea4_pre_migrate_check>
    </data>
    <metadata>
        <command>ea4_pre_migrate_check</command>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
    </metadata>
</xml>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
ea4_pre_migrate_check array of hashes

An array of hashes of EA4 migration check information.

 

This hash contains the name, desc, vendor_id, and version returns.

 

name

string

The name of a blocker.

The function returns this value in the ea4_pre_migrate_check array.

A valid name.cPanel Migrate Blocker

desc

string

The description of a blocker.

The function returns this value in the ea4_pre_migrate_check array.

A valid description. Cpanel evaluates known issues such as network connectivty.

vendor_id

string

The name or ID of a vendor.

The function returns this value in the ea4_pre_migrate_check array.

A valid ID name or vendor name.

cPanel

version

integerThe version number of a migration.

A positive integer that represents the version number of a migration.

1
items

array of hashes

An array of hashes of the items.This hash contains the msg and status returns. 

msg

string

The information that the system displays about a blocker, warning message, or general information.

The function returns this value in the items array.

A valid string.

Cpanel::Eeasy:PHP5::MagicQuotes ignored since it does not have an RPM.

status

integer

The type of message that the system displays.

The function returns this value in the items array.


  •  0 — Information displayed

  • 1 — Warning message

  • 2 — Blocker

1