# ApiCdhUpgradeArgs Data Model

Arguments used for the CDH Upgrade command.

Properties
name | data type | description
--- | --- | ---
cdhParcelVersion | string | If using parcels, the full version of an already distributed parcel for the next major CDH version. Default is null, which indicates this is a package upgrade. Example versions are: '5.0.0-1.cdh5.0.0.p0.11' or '5.0.2-1.cdh5.0.2.p0.32'

cdhPackageVersion

string

If using packages, the full version of the CDH packages being upgraded to, such as "5.1.2". These packages must already be installed on the cluster before running the upgrade command. For backwards compatibility, if "5.0.0" is specified here, then the upgrade command will relax validation of installed packages to match v6 behavior, only checking major version.

Introduced in v9. Has no effect in older API versions, which assume "5.0.0"

rollingRestartArgs | ApiRollingUpgradeClusterArgs | If provided and rolling restart is available, will perform rolling restart with the requested arguments. If provided and rolling restart is not available, errors. If omitted, will do a regular restart. Introduced in v9. Has no effect in older API versions, which must always do a hard restart.
deployClientConfig | boolean | Not used starting in v9 - Client config is always deployed as part of upgrade. For older versions, determines whether client configuration should be deployed as part of upgrade. Default is true.
startAllServices | boolean | Not used starting in v9 - All servies are always started as part of upgrade. For older versions, determines whether all services should be started should be deployed as part of upgrade. Default is true.

Example

    {
      "cdhParcelVersion" : "...",
      "cdhPackageVersion" : "...",
      "rollingRestartArgs" : {
        "slaveBatchSize" : 12345,
        "sleepSeconds" : 12345,
        "slaveFailCountThreshold" : 12345
      }
    }