org.jclouds.savvis.vpdc.features

Interface BrowsingApi

public interface BrowsingApi

Provides access to Symphony VPDC resources via their REST API.

Author:

Adrian Cole

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Network	getNetworkInVDC(String billingSiteId, String vpdcId, String networkTierName) Get Network API returns network detail
Org	getOrg(String billingSiteId) Get an organization, which can contain list of vDC entities
Task	getTask(String taskId) Gets an existing task.
VDC	getVDCInOrg(String billingSiteId, String vpdcId) VDC is a virtual data center ,the API returns a list of VAPPs own by given bill site Id.
VM	getVM(URI vm, GetVMOptions... options)
VM	getVMInVDC(String billingSiteId, String vpdcId, String vAppId, GetVMOptions... options) VAPP is a software solution, the API returns details of virtual machine configuration such as CPU,RAM Memory and hard drive.
FirewallService	listFirewallRules(String billingSiteId, String vpdcId) Gets Firewall Rules

Method Detail

getOrg

Org getOrg(@Nullable
         String billingSiteId)

Get an organization, which can contain list of vDC entities

Parameters:

billingSiteId - billing site Id, or null for default

Returns:

organization, or null if not present

getVDCInOrg

VDC getVDCInOrg(@Nullable
              String billingSiteId,
              String vpdcId)

VDC is a virtual data center ,the API returns a list of VAPPs own by given bill site Id.

Parameters:

billingSiteId - billing site Id, or null for default

vpdcId - vpdc Id

Returns:

a list of resource entity and VM configurations, or null if not present

getNetworkInVDC

Network getNetworkInVDC(String billingSiteId,
                      String vpdcId,
                      String networkTierName)

Get Network API returns network detail

Parameters:

billingSiteId - billing site Id, or null for default

vpdcId - vpdc Id

networkTierName - network tier name

Returns:

network detail if it used any one deployed VM and NetworkConfigSection defines various network features such NAT Public IP, Gateway and Netmask, or null if not present

getVMInVDC

VM getVMInVDC(String billingSiteId,
            String vpdcId,
            String vAppId,
            GetVMOptions... options)

VAPP is a software solution, the API returns details of virtual machine configuration such as CPU,RAM Memory and hard drive. The VM State is from the MW Database.

Parameters:

billingSiteId - billing site Id, or null for default

vpdcId - vpdc Id

vAppId - vApp ID

options - control whether or not to get real time state

Returns:

A virtual application (vApp) is a software solution comprising one or more virtual machines, all of which are deployed, managed, and maintained as a unit, or null if not present

getVM

VM getVM(URI vm,
       GetVMOptions... options)

getTask

Task getTask(String taskId)

Gets an existing task.

Parameters:

taskId - task id

Returns:

If the request is successful, caller could get the VM/VMDK details as specified in the result element and if the request is not successful, caller would get empty VAPP/VMDK URL and respective validation (error) message.

listFirewallRules

FirewallService listFirewallRules(String billingSiteId,
                                String vpdcId)

Gets Firewall Rules

Parameters:

billingSiteId - billing site Id, or null for default

vpdcId - vpdc Id

Returns:

If the request is successful, caller could get the firewall rules as specified in the result element and if the request is not successful, caller would get empty rules list and respective validation (error) message.