com.cloudera.api.v2

Interface ClouderaManagerResourceV2

All Superinterfaces:

ClouderaManagerResource

All Known Subinterfaces:

ClouderaManagerResourceV11, ClouderaManagerResourceV12, ClouderaManagerResourceV14, ClouderaManagerResourceV15, ClouderaManagerResourceV16, ClouderaManagerResourceV17, ClouderaManagerResourceV3, ClouderaManagerResourceV6, ClouderaManagerResourceV7, ClouderaManagerResourceV8

public interface ClouderaManagerResourceV2
extends ClouderaManagerResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiDeployment	getDeployment(DataView dataView) Retrieve full description of the entire Cloudera Manager deployment including all hosts, clusters, services, roles, users, settings, etc.
MgmtServiceResourceV2	getMgmtServiceResource() Return the Cloudera Management Services resource.
ApiCommand	hostsDecommissionCommand(ApiHostNameList hostNameList) Decommission the given hosts.
ApiCommand	hostsRecommissionCommand(ApiHostNameList hostNameList) Recommission the given hosts.
ApiCommand	hostsStartRolesCommand(ApiHostNameList hostNameList) Start all the roles on the given hosts.
ApiDeployment	updateDeployment(ApiDeployment deployment, Boolean deleteCurrentDeployment) Apply the supplied deployment description to the system.

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

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

Method Detail

getDeployment

@Path(value="/deployment")
ApiDeployment getDeployment(DataView dataView)

Retrieve full description of the entire Cloudera Manager deployment including all hosts, clusters, services, roles, users, settings, etc.

This object can be used to reconstruct your entire deployment

Note: Only users with sufficient privileges are allowed to call this.

• Full Administrators
• Cluster Administrators (but Navigator config will be redacted)

Note: starting with v3, the deployment information contains data about Cloudera Manager peers configured for the instance. This data contains plain text authentication information used to connect to the remote peer.

Parameters:

dataView - May be one of "export" (default) or "export_redacted". The latter replaces configurations that are sensitive with the word "REDACTED".

Returns:

A complete deployment description

updateDeployment

@Path(value="/deployment")
ApiDeployment updateDeployment(ApiDeployment deployment,
                                  Boolean deleteCurrentDeployment)

Apply the supplied deployment description to the system. This will create the clusters, services, hosts and other objects specified in the argument. This call does not allow for any merge conflicts. If an entity already exists in the system, this call will fail. You can request, however, that all entities in the system are deleted before instantiating the new ones.

You may specify a complete or partial deployment, e.g. you can provide host info with no clusters. However, if you request that the current deployment be deleted, you are required to specify at least one admin user or this call will fail. This is to protect you from creating a system that cannot be logged into again.

If there are any errors creating (or optionally deleting) a deployment, all changes will be rolled back leaving the system exactly as it was before calling this method. The system will never be left in a state where part of the deployment is created and other parts are not.

If the submitted deployment contains entities that require Cloudera Enterprise license, then the license should be provided to Cloudera Manager before making this API call.

Parameters:

deployment - The deployment to create

deleteCurrentDeployment - If true, the current deployment is deleted before the specified deployment is applied

Returns:

The system deployment info after successfully applying the given deployment.

hostsDecommissionCommand

@Path(value="/commands/hostsDecommission")
ApiCommand hostsDecommissionCommand(ApiHostNameList hostNameList)

Decommission the given hosts. All slave roles on the hosts will be decommissioned. All other roles will be stopped.

Returns:

Information about the submitted command.

hostsRecommissionCommand

@Path(value="/commands/hostsRecommission")
ApiCommand hostsRecommissionCommand(ApiHostNameList hostNameList)

Recommission the given hosts. All slave roles on the hosts will be recommissioned. Roles are not started after this command. Use hostsStartRoles command for that.

Returns:

Information about the submitted command.

hostsStartRolesCommand

@Path(value="/commands/hostsStartRoles")
ApiCommand hostsStartRolesCommand(ApiHostNameList hostNameList)

Start all the roles on the given hosts.

Returns:

Information about the submitted command.

getMgmtServiceResource

@Path(value="/service")
MgmtServiceResourceV2 getMgmtServiceResource()

Return the Cloudera Management Services resource.

Specified by:

getMgmtServiceResource in interface ClouderaManagerResource

Returns:

The Cloudera Management Services resource.