We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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 Web Server role, the system disables this function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ea4_pre_migrate_check?api.version=1


 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ea4_pre_migrate_check?api.version=1


 Command Line
whmapi1 ea4_pre_migrate_check


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"data": {
		"ea4_pre_migrate_check": [{
				"desc": "Cpanel evaluates known issues such as network connectivity",
				"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 that contain EA4 migration check information.


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

                

name

string

The name of a blocker.

The function returns this value in the ea4_pre_migrate_check array.

A valid blocker name.cPanel Migrate Blocker

desc

string

The blocker's description.

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 vendor's name or ID.

The function returns this value in the ea4_pre_migrate_check array.

A valid vendor ID or name.

cPanel

version

integer

The migration's version number.

The function returns this value in the ea4_pre_migrate_check array.

A positive integer that represents the migration's version number.

1

items

array of hashes

An array of hashes of each item in the blocker.

The function returns this value in the ea4_pre_migrate_check array.

This hash contains the msg and status returns.

msg

string

Information about a blocker, a warning message, or general information.

The function returns this value in the items array.

A valid string.

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

status

integer

The type of message.

The function returns this value in the items array.


  •  0 — The message is informational.

  • 1 — The message contains a warning.

  • 2 — The message is a blocker.

1