Description

This function lists RPMs that the server needs, but the server owner has not yet installed.

 When you call this function, it performs the same actions as the following command:

/usr/local/cpanel/scripts/check_cpanel_rpms --list-only --targets[target]

For more information, read our The rpm.versions System documentation.

Examples 




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




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




whmapi1 list_rpms



{
  "data" : {
      "rpms" : [
         "cpanel-pcre"
      ]
   }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "list_rpms"
  }
}




<result>
    <data>
        <rpms>cpanel-pcre</rpms>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_rpms</command>
    </metadata>
</result>



   

Parameters

ParameterTypeDescriptionPossible valuesExample
targetstring

The target that depends on the uninstalled RPMs.

If you do not specify a value, the function will list all of the required but uninstalled RPMs for all RPM targets.

A valid RPM target.

3rdparty

Returns

ReturnTypeDescriptionPossible valuesExample

rpms

array of strings

A list of all RPM dependencies that the server owner has not yet installed.

A valid RPM or list of valid RPMs.cpanel-pcre