com.emc.vipr.client.core

Class Hosts

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<HostRestRep>

com.emc.vipr.client.core.Hosts

All Implemented Interfaces:

BulkResources<HostRestRep>, Resources<HostRestRep>, TaskResources<HostRestRep>, TenantResources<HostRestRep>

public class Hosts
extends AbstractCoreBulkResources<HostRestRep>
implements TenantResources<HostRestRep>, TaskResources<HostRestRep>

Hosts resources.

Base URL: /compute/hosts

Constructor Summary

Constructors

Constructor and Description
Hosts(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<HostRestRep>	create(HostCreateParam input) Begins creating a host in the given tenant.
Task<HostRestRep>	create(HostCreateParam input, boolean validateConnection)
Task<HostRestRep>	deactivate(java.net.URI id) Deactivates a host.
Task<HostRestRep>	deactivate(java.net.URI id, boolean detachStorage) Deactivates a host.
Task<HostRestRep>	deactivate(java.net.URI id, boolean detachStorage, boolean deactivateBootVolume) Deactivates a host.
Task<HostRestRep>	detachStorage(java.net.URI id) Detaches storage from a host.
Task<HostRestRep>	discover(java.net.URI id) Begins discovery of the given host by ID.
Tasks<HostRestRep>	discoverHostArrayAffinity(ArrayAffinityHostParam param) Begins discovery of array affinity information on all supported arrays for the given host IDs.
java.util.List<HostRestRep>	getByCluster(java.net.URI clusterId) Gets the list of hosts in the given cluster.
java.util.List<HostRestRep>	getByDataCenter(java.net.URI dataCenterId) Gets the list of hosts in the given datacenter.
java.util.List<HostRestRep>	getByDataCenter(java.net.URI dataCenterId, ResourceFilter<HostRestRep> filter) Gets the list of hosts in a given datacenter, optionally filtering the results.
java.util.List<HostRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<HostRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<HostRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<HostRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<HostRestRep>	getByUserTenant(ResourceFilter<HostRestRep> filter) Convenience method for retrieving by user's current tenant.
Task<HostRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<HostRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	listByCluster(java.net.URI clusterId) Lists the hosts in the given cluster.
java.util.List<NamedRelatedResourceRep>	listByDataCenter(java.net.URI dataCenterId) Lists the hosts in the given datacenter.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists the hosts by tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
Task<HostRestRep>	osInstall(java.net.URI id, OsInstallParam input) Install OS on the given host.
Tasks<HostRestRep>	provisionBareMetalHosts(ProvisionBareMetalHostsParam param) Provision bare metal hosts.
Task<HostRestRep>	update(java.net.URI id, HostUpdateParam input) Begins updating a host.
Task<HostRestRep>	update(java.net.URI id, HostUpdateParam input, boolean validateConnection)
Task<HostRestRep>	update(java.net.URI id, HostUpdateParam input, boolean validateConnection, boolean updateExports) Updates a host by ID.
Hosts	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Hosts	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Constructor Detail

Hosts

public Hosts(ViPRCoreClient parent,
             RestClient client)

Method Detail

withInactive

public Hosts withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<HostRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Hosts withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<HostRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<HostRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<HostRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<HostRestRep> getTask(java.net.URI id,
                                 java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<HostRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Lists the hosts by tenant.

API Call: GET /compute/hosts?tenant={tenantId}

Specified by:

listByTenant in interface TenantResources<HostRestRep>

Parameters:

tenantId - the ID of the tenant.

Returns:

the list of host references.

listByUserTenant

public java.util.List<NamedRelatedResourceRep> listByUserTenant()

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<HostRestRep>

See Also:

TenantResources.listByTenant(URI)

getByTenant

public java.util.List<HostRestRep> getByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<HostRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByUserTenant

public java.util.List<HostRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<HostRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<HostRestRep> getByUserTenant(ResourceFilter<HostRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<HostRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

getByTenant

public java.util.List<HostRestRep> getByTenant(java.net.URI tenantId,
                                               ResourceFilter<HostRestRep> filter)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<HostRestRep>

Parameters:

tenantId - the tenant ID.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of resources for the tenant.

See Also:

Resources.getByRefs(java.util.Collection, ResourceFilter)

listByDataCenter

public java.util.List<NamedRelatedResourceRep> listByDataCenter(java.net.URI dataCenterId)

Lists the hosts in the given datacenter.

API Call: GET /compute/vcenter-data-centers/{dataCenterId}/hosts

Parameters:

dataCenterId - the ID of the datacenter.

Returns:

the list of host references.

getByDataCenter

public java.util.List<HostRestRep> getByDataCenter(java.net.URI dataCenterId)

Gets the list of hosts in the given datacenter.

Parameters:

dataCenterId - the ID of the datacenter.

Returns:

the list of hosts.

getByDataCenter

public java.util.List<HostRestRep> getByDataCenter(java.net.URI dataCenterId,
                                                   ResourceFilter<HostRestRep> filter)

Gets the list of hosts in a given datacenter, optionally filtering the results.

Parameters:

dataCenterId - the ID of the datacenter.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of hosts.

listByCluster

public java.util.List<NamedRelatedResourceRep> listByCluster(java.net.URI clusterId)

Lists the hosts in the given cluster.

API Call: GET /compute/clusters/{clusterId}/hosts

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of host references.

getByCluster

public java.util.List<HostRestRep> getByCluster(java.net.URI clusterId)

Gets the list of hosts in the given cluster.

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of hosts.

create

public Task<HostRestRep> create(HostCreateParam input)

Begins creating a host in the given tenant.

API Call: POST /compute/hosts

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

create

public Task<HostRestRep> create(HostCreateParam input,
                                boolean validateConnection)

update

public Task<HostRestRep> update(java.net.URI id,
                                HostUpdateParam input)

Begins updating a host.

API Call: PUT /compute/hosts/{id}

Parameters:

id - the ID of the host.

input - the update configuration.

Returns:

a task for monitoing the progress of the operation.

update

public Task<HostRestRep> update(java.net.URI id,
                                HostUpdateParam input,
                                boolean validateConnection,
                                boolean updateExports)

Updates a host by ID.

API Call: PUT /compute/hosts/{id}?validate_connection={validateConnection}&update_exports={updateExports}

Parameters:

id - the ID of the host to update.

input - the update configuration.

validateConnection - if true, also validate the host connection

updateExports - if true, will also update host exports.

update

public Task<HostRestRep> update(java.net.URI id,
                                HostUpdateParam input,
                                boolean validateConnection)

deactivate

public Task<HostRestRep> deactivate(java.net.URI id)

Deactivates a host.

API Call: POST /compute/hosts/{id}/deactivate

Parameters:

id - the ID of the host.

Returns:

deactivate

public Task<HostRestRep> deactivate(java.net.URI id,
                                    boolean detachStorage)

Deactivates a host.

API Call: POST /compute/hosts/{id}/deactivate?detach_storage={detachStorage}

Parameters:

id - the ID of the host to deactivate.

detachStorage - if true, will first detach storage.

deactivate

public Task<HostRestRep> deactivate(java.net.URI id,
                                    boolean detachStorage,
                                    boolean deactivateBootVolume)

Deactivates a host.

API Call: POST /compute/hosts/{id}/deactivate?detach_storage={detachStorage} deactivate_boot_volume={deactivateBootVolume}

Parameters:

id - the ID of the host to deactivate.

detachStorage - if true, will first detach storage.

deactivateBootVolume - if true, and if the host was provisioned by ViPR the associated boot volume (if exists) will be deactivated

detachStorage

public Task<HostRestRep> detachStorage(java.net.URI id)

Detaches storage from a host.

API Call: POST /compute/hosts/{id}/detach-storage

Parameters:

id - the ID of the host.

discover

public Task<HostRestRep> discover(java.net.URI id)

Begins discovery of the given host by ID.

API Call: POST /compute/hosts/{id}/discover

Parameters:

id - the ID of the host to discover.

Returns:

a task for monitoring the progress of the operation.

discoverHostArrayAffinity

public Tasks<HostRestRep> discoverHostArrayAffinity(ArrayAffinityHostParam param)

Begins discovery of array affinity information on all supported arrays for the given host IDs.

API Call: POST /compute/hosts/discover-array-affinity

Parameters:

param - ArrayAffinityHostParam containing host IDs.

Returns:

tasks for monitoring the progress of the operation.

provisionBareMetalHosts

public Tasks<HostRestRep> provisionBareMetalHosts(ProvisionBareMetalHostsParam param)

Provision bare metal hosts.

API Call: POST /compute/hosts/provision-bare-metal

Returns:

Tasks for monitoring the progress of the operation(s).

osInstall

public Task<HostRestRep> osInstall(java.net.URI id,
                                   OsInstallParam input)

Install OS on the given host.

API Call: PUT /compute/hosts/{id}/os-install

Parameters:

id - the ID of the host to install OS on.

input - the OS install information.

Returns:

a task for monitoring the progress of the operation.