com.iland.core.web.rest.api

Interface VappNetworkResource

@Path(value="/vapp-networks")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VappNetworkResource

Vapp Network Resource Interface.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
VappNetworkDHCPServiceResponse	getDHCPService(String networkUuid) Get DHCP service for a given vapp network.
VappNetworkFirewallResponse	getFirewall(String networkUuid) Get a firewall for a given vapp network.
VappNetworkNATServiceResponse	getNATService(String networkUuid) Get NAT service for a given vapp and network.
VappNetworkStaticRoutingServiceResponse	getStaticRouting(String networkUuid) Get static routing service for a given vapp and network.
VappNetworkResponse	getVappNetwork(String networkUuid) Get a vApp network by UUID.
VappNetworkInterfaceListResponse	getVmInterfaces(String networkUuid) Get vApp Network VM interfaces that are tied to this vApp network.
TaskResponse	removeNetworkFromVapp(String networkUuid) Delete a vApp network.
TaskResponse	updateDHCP(String networkUuid, VappNetworkDHCPServiceUpdateRequest dhcpService) Update the DHCP service for a particular vApp.
TaskResponse	updateFirewall(String networkUuid, VappNetworkFirewallUpdateRequest firewall) Update a firewall for a particular vApp.
TaskResponse	updateNAT(String networkUuid, VappNetworkNATServiceUpdateRequest natService) Update the NAT service for a particular vApp.
TaskResponse	updateStaticRouting(String networkUuid, VappNetworkStaticRoutingServiceUpdateRequest staticRoutingService) Update the static routing service for a particular vApp.
TaskResponse	updateVappNetwork(String networkUuid, VappNetworkUpdateRequest vappNetwork) Update a vApp network's properties.

Method Detail

getVappNetwork

@GET
 @Path(value="/{networkUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkResponse getVappNetwork(@PathParam(value="networkUuid")
                                                                                                                                    String networkUuid)

Get a vApp network by UUID.

Parameters:

networkUuid - network uuid

Returns:

asynchronous task details

removeNetworkFromVapp

@DELETE
 @Path(value="/{networkUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse removeNetworkFromVapp(@PathParam(value="networkUuid")
                                                                                                                                       String networkUuid)

Delete a vApp network.

Parameters:

networkUuid - network uuid

Returns:

asynchronous task details

updateVappNetwork

@PUT
 @Path(value="/{networkUuid}")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateVappNetwork(@PathParam(value="networkUuid")
                                                                                                                                                                     String networkUuid,
                                                                                                                                                                     VappNetworkUpdateRequest vappNetwork)

Update a vApp network's properties. Note that vCloud Director changes the UUID of the network when it is updated.

Parameters:

networkUuid - network uuid

Returns:

asynchronous task details

getFirewall

@GET
 @Path(value="/{networkUuid}/firewall")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkFirewallResponse getFirewall(@PathParam(value="networkUuid")
                                                                                                                                                  String networkUuid)

Get a firewall for a given vapp network.

Parameters:

networkUuid - network uuid

Returns:

vapp newtork firewall

updateFirewall

@POST
 @Path(value="/{networkUuid}/actions/update-firewall")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateFirewall(@PathParam(value="networkUuid")
                                                                                                                                                                                           String networkUuid,
                                                                                                                                                                                           VappNetworkFirewallUpdateRequest firewall)

Update a firewall for a particular vApp.

Parameters:

networkUuid - network uuid

firewall - vapp firewall

Returns:

asynchronous task details

getDHCPService

@GET
 @Path(value="/{networkUuid}/dhcp")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkDHCPServiceResponse getDHCPService(@PathParam(value="networkUuid")
                                                                                                                                                    String networkUuid)

Get DHCP service for a given vapp network.

Parameters:

networkUuid - network uuid

Returns:

vapp DHCP service

updateDHCP

@POST
 @Path(value="/{networkUuid}/actions/update-dhcp")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateDHCP(@PathParam(value="networkUuid")
                                                                                                                                                                                   String networkUuid,
                                                                                                                                                                                   VappNetworkDHCPServiceUpdateRequest dhcpService)

Update the DHCP service for a particular vApp.

Parameters:

networkUuid - network uuid

dhcpService - vapp dhcp service

Returns:

asynchronous task details

updateStaticRouting

@POST
 @Path(value="/{networkUuid}/actions/update-static-routing")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateStaticRouting(@PathParam(value="networkUuid")
                                                                                                                                                                                                      String networkUuid,
                                                                                                                                                                                                      VappNetworkStaticRoutingServiceUpdateRequest staticRoutingService)

Update the static routing service for a particular vApp.

Parameters:

networkUuid - network uuid

staticRoutingService - vapp network static routing service

Returns:

asynchronous task details

getStaticRouting

@GET
 @Path(value="/{networkUuid}/static-routing")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkStaticRoutingServiceResponse getStaticRouting(@PathParam(value="networkUuid")
                                                                                                                                                                         String networkUuid)

Get static routing service for a given vapp and network.

Parameters:

networkUuid - network uuid

Returns:

vapp network static routing service

getVmInterfaces

@GET
 @Path(value="/{networkUuid}/vm-interfaces")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkInterfaceListResponse getVmInterfaces(@PathParam(value="networkUuid")
                                                                                                                                                                String networkUuid)

Get vApp Network VM interfaces that are tied to this vApp network.

This is a list of VM vnic interfaces that are currently tied to this vApp network. If the ip_translation_mappedfield is true it means the interface already has and IP translation rule currently mapped via NAT. Other fields return such as vm_local_id and vnic_id point to which VM the interface is attached to and in what VNIC spot.

Parameters:

networkUuid - network uuid

Returns:

vapp network VM network interfaces tied to this network

getNATService

@GET
 @Path(value="/{networkUuid}/nat")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkNATServiceResponse getNATService(@PathParam(value="networkUuid")
                                                                                                                                                 String networkUuid)

Get NAT service for a given vapp and network.

Parameters:

networkUuid - network uuid

Returns:

vapp network nat service

updateNAT

@POST
 @Path(value="/{networkUuid}/actions/update-nat")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse updateNAT(@PathParam(value="networkUuid")
                                                                                                                                                                                 String networkUuid,
                                                                                                                                                                                 VappNetworkNATServiceUpdateRequest natService)

Update the NAT service for a particular vApp.

Parameters:

networkUuid - network uuid

natService - vapp network nat service

Returns:

asynchronous task details