com.cloudera.api.v17

Interface ClouderaManagerResourceV17

All Superinterfaces:

ClouderaManagerResource, ClouderaManagerResourceV11, ClouderaManagerResourceV12, ClouderaManagerResourceV14, ClouderaManagerResourceV15, ClouderaManagerResourceV16, ClouderaManagerResourceV2, ClouderaManagerResourceV3, ClouderaManagerResourceV6, ClouderaManagerResourceV7, ClouderaManagerResourceV8

All Known Subinterfaces:

ClouderaManagerResourceV18, ClouderaManagerResourceV19

public interface ClouderaManagerResourceV17
extends ClouderaManagerResourceV16

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	deleteCredentialsCommand() Delete existing Kerberos credentials.
ApiKerberosInfo	getKerberosInfo() Provides Cloudera Manager Kerberos information
ApiCommand	hostsOfflineOrDecommissionCommand(ApiHostNameList hostNameList, Long offlineTimeout) Decommission the given hosts.

Methods inherited from interface com.cloudera.api.v16.ClouderaManagerResourceV16

refreshParcelRepos

Methods inherited from interface com.cloudera.api.v15.ClouderaManagerResourceV15

getShutdownReadiness, hostsRecommissionWithStartCommand, updateConfig

Methods inherited from interface com.cloudera.api.v14.ClouderaManagerResourceV14

getScmDbInfo

Methods inherited from interface com.cloudera.api.v12.ClouderaManagerResourceV12

importClusterTemplate

Methods inherited from interface com.cloudera.api.v11.ClouderaManagerResourceV11

getCmPeersResource

Methods inherited from interface com.cloudera.api.v8.ClouderaManagerResourceV8

getMgmtServiceResource

Methods inherited from interface com.cloudera.api.v7.ClouderaManagerResourceV7

getKerberosPrincipals, importAdminCredentials, importKerberosPrincipal

Methods inherited from interface com.cloudera.api.v6.ClouderaManagerResourceV6

beginTrial, endTrial, getLicensedFeatureUsage, hostInstallCommand

Methods inherited from interface com.cloudera.api.v3.ClouderaManagerResourceV3

getAllHostsResource

Methods inherited from interface com.cloudera.api.v2.ClouderaManagerResourceV2

getDeployment, hostsDecommissionCommand, hostsRecommissionCommand, hostsStartRolesCommand, updateDeployment

Methods inherited from interface com.cloudera.api.v1.ClouderaManagerResource

collectDiagnosticDataCommand, generateCredentialsCommand, getConfig, getLog, getVersion, inspectHostsCommand, listActiveCommands, readLicense, updateConfig, updateLicense

Method Detail

getKerberosInfo

@Path(value="kerberosInfo")
ApiKerberosInfo getKerberosInfo()

Provides Cloudera Manager Kerberos information

Returns:

Cloudera Manager Kerberos information

deleteCredentialsCommand

@Path(value="/commands/deleteCredentials")
ApiCommand deleteCredentialsCommand()

Delete existing Kerberos credentials.

This command will affect all services that have been configured to use Kerberos, and have existing credentials.

Returns:

Information about the submitted command.

hostsOfflineOrDecommissionCommand

@Path(value="/commands/hostsOfflineOrDecommission")
ApiCommand hostsOfflineOrDecommissionCommand(ApiHostNameList hostNameList,
                                                Long offlineTimeout)

Decommission the given hosts. All slave roles on the hosts will be offlined or decommissioned with preference being offlined if supported by the service.

Currently the offline operation is only supported by HDFS, where the offline operation will put DataNodes into HDFS IN MAINTENANCE state which prevents unnecessary re-replication which could occur if decommissioned.

All other roles on the hosts will be stopped.

The offlineTimeout parameter is used to specify a timeout for offline. For HDFS, when the timeout expires, the DataNode will automatically transition out of HDFS IN MAINTENANCE state, back to HDFS IN SERVICE state.

Parameters:

hostNameList - list of host names to decommission.

offlineTimeout - offline timeout in seconds. Specify as null to get the default timeout (4 hours). Ignored if service does not support he offline operation.

Returns:

Information about the submitted command.