com.cloudera.api.v3

Interface HostTemplatesResource

public interface HostTemplatesResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	applyHostTemplate(String hostTemplateName, ApiHostRefList hosts, boolean startRoles) Applies a host template to a collection of hosts.
ApiHostTemplateList	createHostTemplates(ApiHostTemplateList hostTemplates) Creates new host templates.
ApiHostTemplate	deleteHostTemplate(String hostTemplateName) Deletes a host template.
ApiHostTemplate	readHostTemplate(String hostTemplateName) Retrieves information about a host template.
ApiHostTemplateList	readHostTemplates() Lists all host templates in a cluster.
ApiHostTemplate	updateHostTemplate(String hostTemplateName, ApiHostTemplate hostTemplate) Updates an existing host template.

Method Detail

createHostTemplates

@Path(value="/")
ApiHostTemplateList createHostTemplates(ApiHostTemplateList hostTemplates)

Creates new host templates.

Host template names must be unique across clusters.

Available since API v3.

Parameters:

hostTemplates - The list of host templates to create.

Returns:

The created host templates.

readHostTemplates

@Path(value="/")
ApiHostTemplateList readHostTemplates()

Lists all host templates in a cluster.

Available since API v3.

Returns:

List of host templates in the cluster.

readHostTemplate

@Path(value="/{hostTemplateName}")
ApiHostTemplate readHostTemplate(String hostTemplateName)

Retrieves information about a host template.

Available since API v3.

Returns:

The requested host template.

updateHostTemplate

@Path(value="/{hostTemplateName}")
ApiHostTemplate updateHostTemplate(String hostTemplateName,
                                      ApiHostTemplate hostTemplate)

Updates an existing host template.

Can be used to update the role config groups in a host template or rename it.

Available since API v3.

Parameters:

hostTemplateName - Host template with updated fields.

Returns:

The updated host template.

deleteHostTemplate

@Path(value="/{hostTemplateName}")
ApiHostTemplate deleteHostTemplate(String hostTemplateName)

Deletes a host template.

Available since API v3.

Parameters:

hostTemplateName - Host template to delete.

Returns:

Deleted host template.

applyHostTemplate

@Path(value="/{hostTemplateName}/commands/applyHostTemplate")
ApiCommand applyHostTemplate(String hostTemplateName,
                                ApiHostRefList hosts,
                                boolean startRoles)

Applies a host template to a collection of hosts. This will create a role for each role config group on each of the hosts.

The provided hosts must not have any existing roles on them and if the cluster is not using parcels, the hosts must have a CDH version matching that of the cluster version.

Available since API v3.

Parameters:

hostTemplateName - Host template to apply.

hosts - List of hosts to apply the host template to.

startRoles - Whether to start the newly created roles or not.

Returns:

Synchronous command result.