org.jclouds.cloudstack.features

Interface NetworkClient

public interface NetworkClient

Provides synchronous access to CloudStack network features.

Author:

Adrian Cole

See Also:

NetworkAsyncClient,

Method Summary

Methods

Modifier and Type	Method and Description
Network	createNetworkInZone(String zoneId, String networkOfferingId, String name, String displayText, CreateNetworkOptions... options) Creates a network
String	deleteNetwork(String id) Deletes a network
Network	getNetwork(String id) get a specific network by id
Set<Network>	listNetworks(ListNetworksOptions... options) Lists networks

Method Detail

listNetworks

Set<Network> listNetworks(ListNetworksOptions... options)

Lists networks

Parameters:

options - if present, how to constrain the list.

Returns:

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

getNetwork

Network getNetwork(String id)

get a specific network by id

Parameters:

id - network to get

Returns:

network or null if not found

createNetworkInZone

Network createNetworkInZone(String zoneId,
                          String networkOfferingId,
                          String name,
                          String displayText,
                          CreateNetworkOptions... options)

Creates a network

Parameters:

zoneId - the Zone ID for the Vlan ip range

networkOfferingId - the network offering id

name - the name of the network

displayText - the display text of the network

options - optional parameters

Returns:

newly created network

deleteNetwork

String deleteNetwork(String id)

Deletes a network

Parameters:

id - the ID of the network

Returns:

job id related to destroying the network, or null if resource was not found