org.jclouds.cloudstack.compute.options
Class CloudStackTemplateOptions

java.lang.Object
  org.jclouds.compute.options.RunScriptOptions
      org.jclouds.compute.options.TemplateOptions
          org.jclouds.cloudstack.compute.options.CloudStackTemplateOptions

All Implemented Interfaces:

Cloneable

public class CloudStackTemplateOptions
extends org.jclouds.compute.options.TemplateOptions
implements Cloneable

Contains options supported by the ComputeService.createNodesInGroup(String, int, TemplateOptions) and ComputeService.createNodesInGroup(String, int, TemplateOptions) operations on the gogrid provider.

Usage

The recommended way to instantiate a CloudStackTemplateOptions object is to statically import CloudStackTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

 import static org.jclouds.compute.options.CloudStackTemplateOptions.Builder.*;
 ComputeService client = // get connection
 templateBuilder.options(inboundPorts(22, 80, 8080, 443));
 Set<? extends NodeMetadata> set = client.createNodesInGroup(tag, 2, templateBuilder.build());
 

Author:

Adrian Cole

Nested Class Summary

static class

CloudStackTemplateOptions.Builder

Nested classes/interfaces inherited from class org.jclouds.compute.options.TemplateOptions

org.jclouds.compute.options.TemplateOptions.ImmutableTemplateOptions

Nested classes/interfaces inherited from class org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.RunScriptOptions.ImmutableRunScriptOptions

Field Summary

protected String	ipOnDefaultNetwork
protected Map<String,String>	ipsToNetworks
protected String	keyPair
protected Set<String>	networkIds
static CloudStackTemplateOptions	NONE
protected Set<String>	securityGroupIds
protected boolean	setupStaticNat

Fields inherited from class org.jclouds.compute.options.TemplateOptions

blockUntilRunning, inboundPorts, privateKey, publicKey, script, tags, userMetadata

Fields inherited from class org.jclouds.compute.options.RunScriptOptions

authenticateSudo, blockOnComplete, loginPassword, loginPrivateKey, loginUser, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

CloudStackTemplateOptions()

Method Summary

CloudStackTemplateOptions	authorizePublicKey(String publicKey)
CloudStackTemplateOptions	blockOnPort(int port, int seconds)
CloudStackTemplateOptions	clone()
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
String	getIpOnDefaultNetwork()
Map<String,String>	getIpsToNetworks()
String	getKeyPair()
Set<String>	getNetworkIds()
Set<String>	getSecurityGroupIds()
CloudStackTemplateOptions	inboundPorts(int... ports)
CloudStackTemplateOptions	installPrivateKey(String privateKey)
CloudStackTemplateOptions	ipOnDefaultNetwork(String ipOnDefaultNetwork)
CloudStackTemplateOptions	ipsToNetworks(Map<String,String> ipsToNetworks)
CloudStackTemplateOptions	keyPair(String keyPair)
CloudStackTemplateOptions	networkId(String networkId)
CloudStackTemplateOptions	networkIds(Iterable<String> networkIds)
CloudStackTemplateOptions	securityGroupId(String securityGroupId)
CloudStackTemplateOptions	securityGroupIds(Iterable<String> securityGroupIds)
CloudStackTemplateOptions	setupStaticNat(boolean setupStaticNat)
boolean	shouldSetupStaticNat()
CloudStackTemplateOptions	userMetadata(Map<String,String> userMetadata)
CloudStackTemplateOptions	userMetadata(String key, String value)

Methods inherited from class org.jclouds.compute.options.TemplateOptions

as, blockOnComplete, blockUntilRunning, dontAuthorizePublicKey, equals, getInboundPorts, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, hashCode, nameTask, overrideAuthenticateSudo, overrideLoginCredentials, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, runAsRoot, runScript, runScript, shouldBlockUntilRunning, string, tags, wrapInInitScript

Methods inherited from class org.jclouds.compute.options.RunScriptOptions

getLoginPassword, getLoginPrivateKey, getLoginUser, getPort, getSeconds, getTaskName, hasLoginPassword, hasLoginPasswordOption, hasLoginPrivateKey, hasLoginPrivateKeyOption, shouldAuthenticateSudo, shouldBlockOnComplete, shouldRunAsRoot, shouldWrapInInitScript, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

securityGroupIds

protected Set<String> securityGroupIds

networkIds

protected Set<String> networkIds

ipsToNetworks

protected Map<String,String> ipsToNetworks

ipOnDefaultNetwork

protected String ipOnDefaultNetwork

keyPair

protected String keyPair

setupStaticNat

protected boolean setupStaticNat

NONE

public static final CloudStackTemplateOptions NONE

Constructor Detail

CloudStackTemplateOptions

public CloudStackTemplateOptions()

Method Detail

clone

public CloudStackTemplateOptions clone()

Overrides:

clone in class org.jclouds.compute.options.TemplateOptions

copyTo

public void copyTo(org.jclouds.compute.options.TemplateOptions to)

Overrides:

copyTo in class org.jclouds.compute.options.TemplateOptions

securityGroupId

public CloudStackTemplateOptions securityGroupId(String securityGroupId)

See Also:

DeployVirtualMachineOptions.securityGroupId(java.lang.String)

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<String> securityGroupIds)

See Also:

DeployVirtualMachineOptions.securityGroupIds(java.lang.Iterable)

getSecurityGroupIds

public Set<String> getSecurityGroupIds()

networkId

public CloudStackTemplateOptions networkId(String networkId)

See Also:

DeployVirtualMachineOptions.networkId(java.lang.String)

networkIds

public CloudStackTemplateOptions networkIds(Iterable<String> networkIds)

See Also:

DeployVirtualMachineOptions.networkIds(java.lang.Iterable)

getNetworkIds

public Set<String> getNetworkIds()

setupStaticNat

public CloudStackTemplateOptions setupStaticNat(boolean setupStaticNat)

shouldSetupStaticNat

public boolean shouldSetupStaticNat()

ipOnDefaultNetwork

public CloudStackTemplateOptions ipOnDefaultNetwork(String ipOnDefaultNetwork)

See Also:

DeployVirtualMachineOptions.ipOnDefaultNetwork(java.lang.String)

getIpOnDefaultNetwork

public String getIpOnDefaultNetwork()

ipsToNetworks

public CloudStackTemplateOptions ipsToNetworks(Map<String,String> ipsToNetworks)

See Also:

DeployVirtualMachineOptions.ipOnDefaultNetwork(String)

getIpsToNetworks

public Map<String,String> getIpsToNetworks()

keyPair

public CloudStackTemplateOptions keyPair(String keyPair)

See Also:

DeployVirtualMachineOptions.keyPair(String)

getKeyPair

public String getKeyPair()

blockOnPort

public CloudStackTemplateOptions blockOnPort(int port,
                                             int seconds)

Overrides:

blockOnPort in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.blockOnPort(int, int)

inboundPorts

public CloudStackTemplateOptions inboundPorts(int... ports)

Overrides:

inboundPorts in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.inboundPorts(int...)

authorizePublicKey

public CloudStackTemplateOptions authorizePublicKey(String publicKey)

Overrides:

authorizePublicKey in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.authorizePublicKey(String)

installPrivateKey

public CloudStackTemplateOptions installPrivateKey(String privateKey)

Overrides:

installPrivateKey in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.installPrivateKey(String)

userMetadata

public CloudStackTemplateOptions userMetadata(Map<String,String> userMetadata)

Overrides:

userMetadata in class org.jclouds.compute.options.TemplateOptions

userMetadata

public CloudStackTemplateOptions userMetadata(String key,
                                              String value)

Overrides:

userMetadata in class org.jclouds.compute.options.TemplateOptions