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

Methods

Modifier and Type	Method and Description
Pod	createPod(String name, String zoneId, String startIp, String gateway, String netmask, CreatePodOptions... createPodOptions) Creates a new Pod.
Pod	createPod(String name, String zoneId, String startIp, String endIp, 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 Detail

listPods

@Named(value="listPods")
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(value="listPods")
Pod getPod(String id)

get a specific pod by id

Parameters:

id - pod to get

Returns:

pod or null if not found

createPod

@Named(value="createPod")
Pod createPod(String name,
                  String zoneId,
                  String startIp,
                  String endIp,
                  String gateway,
                  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(value="createPod")
Pod createPod(String name,
                  String zoneId,
                  String startIp,
                  String gateway,
                  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(value="deletePod")
void deletePod(String id)

Deletes a Pod.

Parameters:

id - the ID of the Pod

updatePod

@Named(value="updatePod")
Pod updatePod(String id,
                  UpdatePodOptions... updatePodOptions)

Updates a Pod.

Parameters:

id - the ID of the Pod

updatePodOptions - optional arguments

Returns:

the updated pod