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

TemplateOptions.ImmutableTemplateOptions

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

RunScriptOptions.ImmutableRunScriptOptions

Field Summary

protected String	ipOnDefaultNetwork
protected Map<String,Long>	ipsToNetworks
protected String	keyPair
protected Set<Long>	networkIds
static CloudStackTemplateOptions	NONE
protected Set<Long>	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) authorize an rsa ssh key.
CloudStackTemplateOptions	blockOnPort(int port, int seconds) When the node is started, wait until the following port is active
CloudStackTemplateOptions	clone()
void	copyTo(TemplateOptions to)
String	getIpOnDefaultNetwork()
Map<String,Long>	getIpsToNetworks()
String	getKeyPair()
Set<Long>	getNetworkIds()
Set<Long>	getSecurityGroupIds()
CloudStackTemplateOptions	inboundPorts(int... ports) Opens the set of ports to public access.
CloudStackTemplateOptions	installPrivateKey(String privateKey) replaces the rsa ssh key used at login.
CloudStackTemplateOptions	ipOnDefaultNetwork(String ipOnDefaultNetwork)
CloudStackTemplateOptions	ipsToNetworks(Map<String,Long> ipsToNetworks)
CloudStackTemplateOptions	keyPair(String keyPair)
CloudStackTemplateOptions	networkId(long networkId)
CloudStackTemplateOptions	networkIds(Iterable<Long> networkIds)
CloudStackTemplateOptions	runScript(Payload script) Deprecated.
CloudStackTemplateOptions	securityGroupId(long securityGroupId)
CloudStackTemplateOptions	securityGroupIds(Iterable<Long> 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, overrideCredentialsWith, overrideLoginCredentials, overrideLoginCredentialWith, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, overrideLoginUserWith, runAsRoot, runScript, runScript, shouldBlockUntilRunning, tags, toString, wrapInInitScript

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

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

Methods inherited from class java.lang.Object

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

Field Detail

securityGroupIds

protected Set<Long> securityGroupIds

networkIds

protected Set<Long> networkIds

ipsToNetworks

protected Map<String,Long> 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 TemplateOptions

copyTo

public void copyTo(TemplateOptions to)

Overrides:

copyTo in class TemplateOptions

securityGroupId

public CloudStackTemplateOptions securityGroupId(long securityGroupId)

See Also:

DeployVirtualMachineOptions.securityGroupId(long)

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<Long> securityGroupIds)

See Also:

DeployVirtualMachineOptions.securityGroupIds(java.lang.Iterable)

getSecurityGroupIds

public Set<Long> getSecurityGroupIds()

networkId

public CloudStackTemplateOptions networkId(long networkId)

See Also:

DeployVirtualMachineOptions.networkId(long)

networkIds

public CloudStackTemplateOptions networkIds(Iterable<Long> networkIds)

See Also:

DeployVirtualMachineOptions.networkIds(java.lang.Iterable)

getNetworkIds

public Set<Long> 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,Long> ipsToNetworks)

See Also:

DeployVirtualMachineOptions.ipOnDefaultNetwork(String)

getIpsToNetworks

public Map<String,Long> getIpsToNetworks()

keyPair

public CloudStackTemplateOptions keyPair(String keyPair)

See Also:

DeployVirtualMachineOptions.keyPair(String)

getKeyPair

public String getKeyPair()

blockOnPort

public CloudStackTemplateOptions blockOnPort(int port,
                                             int seconds)

Description copied from class: RunScriptOptions

When the node is started, wait until the following port is active

Overrides:

blockOnPort in class TemplateOptions

See Also:

TemplateOptions.blockOnPort(int, int)

inboundPorts

public CloudStackTemplateOptions inboundPorts(int... ports)

Description copied from class: TemplateOptions

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

See Also:

TemplateOptions.inboundPorts(int...)

authorizePublicKey

public CloudStackTemplateOptions authorizePublicKey(String publicKey)

Description copied from class: TemplateOptions

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

See Also:

TemplateOptions.authorizePublicKey(String)

installPrivateKey

public CloudStackTemplateOptions installPrivateKey(String privateKey)

Description copied from class: TemplateOptions

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

See Also:

TemplateOptions.installPrivateKey(String)

runScript

@Deprecated
public CloudStackTemplateOptions runScript(Payload script)

Deprecated.

Description copied from class: TemplateOptions

to be removed in jclouds 1.4.0

Overrides:

runScript in class TemplateOptions

See Also:

TemplateOptions.runScript(Payload)

userMetadata

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

Overrides:

userMetadata in class TemplateOptions

Parameters:

userMetadata - user-defined metadata to assign to this server

userMetadata

public CloudStackTemplateOptions userMetadata(String key,
                                              String value)

Overrides:

userMetadata in class TemplateOptions

Parameters:

key - key to place into the metadata map

value - value to associate with that key