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

Nested Classes

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

Fields

Modifier and Type	Field and Description
protected String	account
protected String	domainId
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

Constructors

Constructor and Description
CloudStackTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CloudStackTemplateOptions	account(String account)
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)
CloudStackTemplateOptions	domainId(String domainId)
String	getAccount()
String	getDomainId()
String	getIpOnDefaultNetwork()
Map<String,String>	getIpsToNetworks()
String	getKeyPair()
Set<String>	getNetworkIds()
Set<String>	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,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

account

protected String account

domainId

protected String domainId

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

See Also:

DeployVirtualMachineOptions.securityGroupId(java.lang.String)

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<String> securityGroupIds)

See Also:

DeployVirtualMachineOptions.securityGroupIds(java.lang.Iterable<java.lang.String>)

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<java.lang.String>)

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

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)

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)

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