public interface HostTemplatesResource
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.
|
ApiHostTemplateList createHostTemplates(ApiHostTemplateList hostTemplates)
Host template names must be unique across clusters.
Available since API v3.
hostTemplates
- The list of host templates to create.ApiHostTemplateList readHostTemplates()
Available since API v3.
ApiHostTemplate readHostTemplate(String hostTemplateName)
Available since API v3.
ApiHostTemplate updateHostTemplate(String hostTemplateName, ApiHostTemplate hostTemplate)
Can be used to update the role config groups in a host template or rename it.
Available since API v3.
hostTemplateName
- Host template with updated fields.ApiHostTemplate deleteHostTemplate(String hostTemplateName)
Available since API v3.
hostTemplateName
- Host template to delete.ApiCommand applyHostTemplate(String hostTemplateName, ApiHostRefList hosts, boolean startRoles)
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.
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.Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.