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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
protected String	account
protected int	dataDiskSize
protected String	diskOfferingId
protected String	domainId
protected boolean	generateKeyPair
protected boolean	generateSecurityGroup
protected String	ipOnDefaultNetwork
protected Map<String,String>	ipsToNetworks
protected String	keyPair
static CloudStackTemplateOptions	NONE
protected Set<String>	securityGroupIds
protected boolean	setupStaticNat

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

blockUntilRunning, inboundPorts, networks, nodeNames, privateKey, publicKey, script, securityGroups, tags, userMetadata

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

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

Constructor Summary

Constructors

Constructor and Description
CloudStackTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CloudStackTemplateOptions	account(String account)
CloudStackTemplateOptions	authorizePublicKey(String publicKey)
CloudStackTemplateOptions	blockOnPort(int port, int seconds)
CloudStackTemplateOptions	clone()
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
CloudStackTemplateOptions	dataDiskSize(int dataDiskSize)
CloudStackTemplateOptions	diskOfferingId(String diskOfferingId)
CloudStackTemplateOptions	domainId(String domainId)
CloudStackTemplateOptions	generateKeyPair(boolean enable)
CloudStackTemplateOptions	generateSecurityGroup(boolean enable)
String	getAccount()
int	getDataDiskSize()
String	getDiskOfferingId()
String	getDomainId()
String	getIpOnDefaultNetwork()
Map<String,String>	getIpsToNetworks()
String	getKeyPair()
Set<String>	getNetworkIds() Deprecated. See TemplateOptions#getNetworks
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) Deprecated. See TemplateOptions#networks
CloudStackTemplateOptions	networkIds(Iterable<String> networkIds) Deprecated. See TemplateOptions#networks
CloudStackTemplateOptions	networks(Iterable<String> networks)
CloudStackTemplateOptions	networks(String... networks)
CloudStackTemplateOptions	nodeNames(Iterable<String> nodeNames)
CloudStackTemplateOptions	securityGroupId(String securityGroupId)
CloudStackTemplateOptions	securityGroupIds(Iterable<String> securityGroupIds)
CloudStackTemplateOptions	setupStaticNat(boolean setupStaticNat)
boolean	shouldGenerateKeyPair()
boolean	shouldGenerateSecurityGroup()
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, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, hashCode, nameTask, overrideAuthenticateSudo, overrideLoginCredentials, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, runAsRoot, runScript, runScript, securityGroups, securityGroups, 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

ipsToNetworks

protected Map<String,String> ipsToNetworks

ipOnDefaultNetwork

protected String ipOnDefaultNetwork

keyPair

protected String keyPair

setupStaticNat

protected boolean setupStaticNat

account

protected String account

domainId

protected String domainId

generateKeyPair

protected boolean generateKeyPair

generateSecurityGroup

protected boolean generateSecurityGroup

diskOfferingId

protected String diskOfferingId

dataDiskSize

protected int dataDiskSize

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

diskOfferingId

public CloudStackTemplateOptions diskOfferingId(String diskOfferingId)

See Also:

DeployVirtualMachineOptions.diskOfferingId(java.lang.String)

getDiskOfferingId

public String getDiskOfferingId()

dataDiskSize

public CloudStackTemplateOptions dataDiskSize(int dataDiskSize)

See Also:

DeployVirtualMachineOptions#dataDiskSize

getDataDiskSize

public int getDataDiskSize()

securityGroupId

public CloudStackTemplateOptions securityGroupId(String securityGroupId)

See Also:

DeployVirtualMachineOptions#securityGroupId

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<String> securityGroupIds)

See Also:

DeployVirtualMachineOptions#securityGroupIds

getSecurityGroupIds

public Set<String> getSecurityGroupIds()

generateSecurityGroup

public CloudStackTemplateOptions generateSecurityGroup(boolean enable)

See Also:

shouldGenerateKeyPair()

shouldGenerateSecurityGroup

public boolean shouldGenerateSecurityGroup()

Returns:

true if auto generation of keypairs is enabled

networkId

@Deprecated
public CloudStackTemplateOptions networkId(String networkId)

Deprecated. See TemplateOptions#networks

See Also:

DeployVirtualMachineOptions#networkId

networkIds

@Deprecated
public CloudStackTemplateOptions networkIds(Iterable<String> networkIds)

Deprecated. See TemplateOptions#networks

See Also:

DeployVirtualMachineOptions#networkIds

getNetworkIds

@Deprecated
public Set<String> getNetworkIds()

Deprecated. See TemplateOptions#getNetworks

setupStaticNat

public CloudStackTemplateOptions setupStaticNat(boolean setupStaticNat)

shouldSetupStaticNat

public boolean shouldSetupStaticNat()

ipOnDefaultNetwork

public CloudStackTemplateOptions ipOnDefaultNetwork(String ipOnDefaultNetwork)

See Also:

DeployVirtualMachineOptions#ipOnDefaultNetwork

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()

generateKeyPair

public CloudStackTemplateOptions generateKeyPair(boolean enable)

See Also:

shouldGenerateKeyPair()

shouldGenerateKeyPair

public boolean shouldGenerateKeyPair()

Returns:

true if auto generation of keypairs is enabled

account

public CloudStackTemplateOptions account(String account)

See Also:

DeployVirtualMachineOptions#accountInDomain(String,String)

getAccount

public String getAccount()

domainId

public CloudStackTemplateOptions domainId(String domainId)

See Also:

DeployVirtualMachineOptions#accountInDomain(String,String), DeployVirtualMachineOptions#domainId(String)

getDomainId

public String getDomainId()

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

nodeNames

public CloudStackTemplateOptions nodeNames(Iterable<String> nodeNames)

Overrides:

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

networks

public CloudStackTemplateOptions networks(Iterable<String> networks)

Overrides:

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

networks

public CloudStackTemplateOptions networks(String... networks)

Overrides:

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