GlobalHostApi (Apache jclouds 2.1.0 API)

Methods
Modifier and Type	Method and Description
`Cluster`	`addCluster(String zoneId, String clusterName, Host.ClusterType clusterType, String hypervisor, AddClusterOptions... options)` Adds a new cluster.
`Host`	`addHost(String zoneId, String url, String hypervisor, String username, String password, AddHostOptions... options)` Adds a new host.
`Host`	`addSecondaryStorage(String url, AddSecondaryStorageOptions... options)` Adds secondary storage.
`String`	`cancelHostMaintenance(String hostId)` Cancels host maintenance.
`void`	`deleteCluster(String clusterId)` Deletes a cluster.
`void`	`deleteHost(String hostId, DeleteHostOptions... options)` Deletes a host.
`Set<Cluster>`	`listClusters(ListClustersOptions... options)`
`Set<Host>`	`listHosts(ListHostsOptions... options)` Lists hosts
`String`	`prepareHostForMaintenance(String hostId)` Prepares a host for maintenance.
`String`	`reconnectHost(String hostId)` Reconnects a host.
`Cluster`	`updateCluster(String clusterId, UpdateClusterOptions... options)` Updates an existing cluster.
`void`	`updateClusterPassword(String clusterId, String username, String password)` Update password of a cluster on management server.
`Host`	`updateHost(String hostId, UpdateHostOptions... options)` Updates a host.
`void`	`updateHostPassword(String hostId, String username, String password)` Update password of a host on management server.

```
public interface GlobalHostApi
```
Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

Cluster addCluster(String zoneId, String clusterName, Host.ClusterType clusterType, String hypervisor, AddClusterOptions... options)
Adds a new cluster.

Host addHost(String zoneId, String url, String hypervisor, String username, String password, AddHostOptions... options)
Adds a new host.

Host addSecondaryStorage(String url, AddSecondaryStorageOptions... options)
Adds secondary storage.

String cancelHostMaintenance(String hostId)
Cancels host maintenance.

void deleteCluster(String clusterId)
Deletes a cluster.

void deleteHost(String hostId, DeleteHostOptions... options)
Deletes a host.

Set<Cluster> listClusters(ListClustersOptions... options)

Set<Host> listHosts(ListHostsOptions... options)
Lists hosts

String prepareHostForMaintenance(String hostId)
Prepares a host for maintenance.

String reconnectHost(String hostId)
Reconnects a host.

Cluster updateCluster(String clusterId, UpdateClusterOptions... options)
Updates an existing cluster.

void updateClusterPassword(String clusterId, String username, String password)
Update password of a cluster on management server.

Host updateHost(String hostId, UpdateHostOptions... options)
Updates a host.

void updateHostPassword(String hostId, String username, String password)
Update password of a host on management server.

Method Detail

listHosts
```
@Named(value="listHosts")
@GET
@Consumes(value="application/json")
Set<Host> listHosts(ListHostsOptions... options)
```
Lists hosts

Parameters:
options - if present, how to constrain the list.

Returns:
hosts matching query, or empty set, if no service offerings are found

addHost

@Named(value="addHost")
@GET
@Consumes(value="application/json")
Host addHost(@QueryParam(value="zoneid")
                              String zoneId,
                              @QueryParam(value="url")
                              String url,
                              @QueryParam(value="hypervisor")
                              String hypervisor,
                              @QueryParam(value="username")
                              String username,
                              @QueryParam(value="password")
                              String password,
                              AddHostOptions... options)

Adds a new host.

Parameters:: zoneId - the Zone ID for the host; url - the host URL; hypervisor - hypervisor type of the host; username - the username for the host; password - the password for the host; options - optional arguments
Returns:: the new host.

updateHost

@Named(value="updateHost")
@GET
@Consumes(value="application/json")
Host updateHost(@QueryParam(value="id")
                                 String hostId,
                                 UpdateHostOptions... options)

Updates a host.

Parameters:: hostId - the ID of the host to update; options - optional arguments
Returns:: the modified host.

updateHostPassword

@Named(value="updateHostPassword")
@GET
@Consumes(value="application/json")
void updateHostPassword(@QueryParam(value="hostid")
                                         String hostId,
                                         @QueryParam(value="username")
                                         String username,
                                         @QueryParam(value="password")
                                         String password)

Update password of a host on management server.

Parameters:: hostId - the host ID; username - the username for the host; password - the password for the host

deleteHost

@Named(value="deleteHost")
@GET
@Consumes(value="application/json")
void deleteHost(@QueryParam(value="id")
                                 String hostId,
                                 DeleteHostOptions... options)

Deletes a host.

Parameters:: hostId - the host ID; options - optional arguments

prepareHostForMaintenance

@Named(value="prepareHostForMaintenance")
@GET
@Consumes(value="application/json")
String prepareHostForMaintenance(@QueryParam(value="id")
                                                  String hostId)

Prepares a host for maintenance.

Parameters:: hostId - the host ID
Returns:: a job reference number for tracking this asynchronous job.

cancelHostMaintenance

@Named(value="cancelHostMaintenance")
@GET
@Consumes(value="application/json")
String cancelHostMaintenance(@QueryParam(value="id")
                                              String hostId)

Cancels host maintenance.

Parameters:: hostId - the host ID
Returns:: a job reference number for tracking this asynchronous job.

reconnectHost

@Named(value="reconnectHost")
@GET
@Consumes(value="application/json")
String reconnectHost(@QueryParam(value="id")
                                      String hostId)

Reconnects a host.

Parameters:: hostId -
Returns:: a job reference number for tracking this asynchronous job.

addSecondaryStorage

@Named(value="addSecondaryStorage")
@GET
@Consumes(value="application/json")
Host addSecondaryStorage(@QueryParam(value="url")
                                          String url,
                                          AddSecondaryStorageOptions... options)

Adds secondary storage.

Parameters:: url - the URL for the secondary storage; options - optional arguments
Returns:: the host of the storage.

listClusters

@Named(value="listClusters")
@GET
@Consumes(value="application/json")
Set<Cluster> listClusters(ListClustersOptions... options)

See Also:: listClusters(org.jclouds.cloudstack.options.ListClustersOptions...)

addCluster

@Named(value="addCluster")
@GET
@Consumes(value="application/json")
Cluster addCluster(@QueryParam(value="zoneid")
                                    String zoneId,
                                    @QueryParam(value="clustername")
                                    String clusterName,
                                    @QueryParam(value="clustertype")
                                    Host.ClusterType clusterType,
                                    @QueryParam(value="hypervisor")
                                    String hypervisor,
                                    AddClusterOptions... options)

Adds a new cluster.

Parameters:: zoneId - the Zone ID for the cluster; clusterName - the cluster name; clusterType - type of the cluster; hypervisor - hypervisor type of the cluster; options - optional arguments
Returns:: the new cluster.

updateCluster

@Named(value="updateCluster")
@GET
@Consumes(value="application/json")
Cluster updateCluster(@QueryParam(value="id")
                                       String clusterId,
                                       UpdateClusterOptions... options)

Updates an existing cluster.

Parameters:: clusterId - the ID of the cluster; options - optional arguments
Returns:: the modified cluster

updateClusterPassword

@Named(value="updateHostPassword")
@GET
@Consumes(value="application/json")
void updateClusterPassword(@QueryParam(value="clusterid")
                                            String clusterId,
                                            @QueryParam(value="username")
                                            String username,
                                            @QueryParam(value="password")
                                            String password)

Update password of a cluster on management server.

Parameters:: clusterId - the cluster ID; username - the username for the cluster; password - the password for the cluster

deleteCluster

@Named(value="deleteCluster")
@GET
@Consumes(value="application/json")
void deleteCluster(@QueryParam(value="id")
                                    String clusterId)

Deletes a cluster.

Parameters:: clusterId - the cluster ID

Interface GlobalHostApi

Method Summary