Package org.jclouds.cloudstack.features

Interface GlobalPodApi

public interface GlobalPodApi

Provides synchronous access to CloudStack Pod features available to Global Admin users.

See Also:

Method Summary

Modifier and Type

Method

Description

Pod

createPod(String name, String zoneId, String startIp, String endIp, String gateway, String netmask, CreatePodOptions... createPodOptions)

Creates a new Pod.

Pod

createPod(String name, String zoneId, String startIp, String gateway, String netmask, CreatePodOptions... createPodOptions)

Creates a new Pod.

void

deletePod(String id)

Deletes a Pod.

Pod

getPod(String id)

get a specific pod by id

Set<Pod>

listPods(ListPodsOptions... options)

Lists pods

Pod

updatePod(String id, UpdatePodOptions... updatePodOptions)

Updates a Pod.

Method Details

listPods

@Named("listPods")
@GET
@Consumes("application/json")
Set<Pod> listPods(ListPodsOptions... options)

Lists pods

Parameters:

options - if present, how to constrain the list.

Returns:

pods matching query, or empty set, if no pods are found

getPod

@Named("listPods")
@GET
@Consumes("application/json")
Pod getPod(@QueryParam("id")
 String id)

get a specific pod by id

Parameters:

id - pod to get

Returns:

pod or null if not found

createPod

@Named("createPod")
@GET
@Consumes("application/json")
Pod createPod(@QueryParam("name")
 String name,
 @QueryParam("zoneid")
 String zoneId,
 @QueryParam("startip")
 String startIp,
 @QueryParam("endip")
 String endIp,
 @QueryParam("gateway")
 String gateway,
 @QueryParam("netmask")
 String netmask,
 CreatePodOptions... createPodOptions)

Creates a new Pod.

Parameters:

name - the name of the Pod

zoneId - the Zone ID in which the Pod will be created

startIp - the starting IP address for the Pod

endIp - the ending IP address for the Pod

gateway - the gateway for the Pod

netmask - the netmask for the Pod

createPodOptions - optional arguments

Returns:

the new Pod

createPod

@Named("createPod")
@GET
@Consumes("application/json")
Pod createPod(@QueryParam("name")
 String name,
 @QueryParam("zoneid")
 String zoneId,
 @QueryParam("startip")
 String startIp,
 @QueryParam("gateway")
 String gateway,
 @QueryParam("netmask")
 String netmask,
 CreatePodOptions... createPodOptions)

Creates a new Pod.

Parameters:

name - the name of the Pod

zoneId - the Zone ID in which the Pod will be created

startIp - the starting IP address for the Pod

gateway - the gateway for the Pod

netmask - the netmask for the Pod

createPodOptions - optional arguments

Returns:

the new Pod

deletePod

@Named("deletePod")
@GET
@Consumes("application/json")
void deletePod(@QueryParam("id")
 String id)

Deletes a Pod.

Parameters:

id - the ID of the Pod

updatePod

@Named("updatePod")
@GET
@Consumes("application/json")
Pod updatePod(@QueryParam("id")
 String id,
 UpdatePodOptions... updatePodOptions)

Updates a Pod.

Parameters:

id - the ID of the Pod

updatePodOptions - optional arguments

Returns:

the updated pod