ApiHostInstallArguments Data Model

Arguments to perform installation on one or more hosts

Properties
name data type description
hostNames array of string List of hosts to configure for use with Cloudera Manager. A host may be specified by a hostname (FQDN) or an IP address.
sshPort number SSH port. If unset, defaults to 22.
userName string The username used to authenticate with the hosts. Root access to your hosts is required to install Cloudera packages. The installer will connect to your hosts via SSH and log in either directly as root or as another user with password-less sudo privileges to become root.
password string The password used to authenticate with the hosts. Specify either this or a private key. For password-less login, use an empty string as password.
privateKey string The private key to authenticate with the hosts. Specify either this or a password.
The private key, if specified, needs to be a standard PEM-encoded key as a single string, with all line breaks replaced with the line-feed control character '\n'.
A value will typically look like the following string:
-----BEGIN RSA PRIVATE KEY-----\n[base-64 encoded key]\n-----END RSA PRIVATE KEY-----
passphrase string The passphrase associated with the private key used to authenticate with the hosts (optional).
parallelInstallCount number Number of simultaneous installations. Defaults to 10. Running a large number of installations at once can consume large amounts of network bandwidth and other system resources.
cmRepoUrl string The Cloudera Manager repository URL to use (optional). Example for SLES, Redhat or Debian based distributions: https://archive.cloudera.com/cm6/6.0.0
gpgKeyCustomUrl string The Cloudera Manager public GPG key (optional). Example for SLES, Redhat or other RPM based distributions: https://archive.cloudera.com/cm5/redhat/5/x86_64/cm/RPM-GPG-KEY-cloudera Example for Ubuntu or other Debian based distributions: https://archive.cloudera.com/cm5/ubuntu/lucid/amd64/cm/archive.key
javaInstallStrategy string Added in v8: Strategy to use for JDK installation. Valid values are
1. AUTO: Cloudera Manager will install the JDK versions that are required when the "AUTO" option is selected. This package will be downloaded from Cloudera repository. This operation may overwrite any of the existing JDK installations.
2. NONE(default): Cloudera Manager will not install any JDK when "NONE" option is selected. It should be used if an existing JDK installation can be used. NOTE: Selecting the "NONE" option makes it the customer's responsibility to ensure that the unlimited strength JCE policy files are installed and enabled on each host, as appropriate for the version of Java in use.
3. OS_PROVIDED_JDK: Option added in v40, Cloudera Manager will install OpenJDK packages provided by the [non-cloudera] Operating System repositories configured on each host. This operation may overwrite any of the existing JDK installations.
unlimitedJCE boolean Added in v8: Flag for unlimited strength JCE policy files installation If unset, defaults to false
Deprecated in CM 7.0.2: Flag for unlimited strength JCE policy files installation will be set to False. NOTE: With OpenJDK11 (and OpenJDK8 u232), JCE is installed and enabled by default.
gpgKeyOverrideBundle string The Cloudera Manager public GPG key (optional). This points to the actual bundle contents and not a URL.
agentReportedHostnames array of ApiMapEntry Optional. A map from hostname to reported_hostname value to be set in the agent configuration file.
subjectAltNames array of string

Example

{
  "hostNames" : [ "...", "..." ],
  "sshPort" : 12345,
  "userName" : "...",
  "password" : "...",
  "privateKey" : "...",
  "passphrase" : "...",
  "parallelInstallCount" : 12345,
  "cmRepoUrl" : "...",
  "gpgKeyCustomUrl" : "...",
  "javaInstallStrategy" : "...",
  "unlimitedJCE" : true,
  "gpgKeyOverrideBundle" : "...",
  "agentReportedHostnames" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "subjectAltNames" : [ "...", "..." ]
}