Package org.jclouds.softlayer.compute.options

Class SoftLayerTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.softlayer.compute.options.SoftLayerTemplateOptions

All Implemented Interfaces:

Cloneable

public class SoftLayerTemplateOptions
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 SoftLayerTemplateOptions object is to statically import SoftLayerTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

 import static org.jclouds.compute.options.SoftLayerTemplateOptions.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	Description
static class	SoftLayerTemplateOptions.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	Description
protected List<Integer>	blockDevices
protected Boolean	dedicatedAccountHostOnlyFlag
protected String	diskType
protected String	domainName
protected Boolean	hourlyBillingFlag
protected Integer	portSpeed
protected String	postInstallScriptUri
protected Integer	primaryBackendNetworkComponentNetworkVlanId
protected Integer	primaryNetworkComponentNetworkVlanId
protected Boolean	privateNetworkOnlyFlag
protected List<Integer>	sshKeys
protected String	userData

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

blockUntilRunning, inboundPorts, networks, nodeNames, NONE, 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	Description
SoftLayerTemplateOptions()

Method Summary

Modifier and Type	Method	Description
SoftLayerTemplateOptions	authorizePublicKey(String publicKey)	authorize an rsa ssh key.
SoftLayerTemplateOptions	blockDevices(Integer... capacities)
SoftLayerTemplateOptions	blockDevices(Iterable<Integer> capacities)
SoftLayerTemplateOptions	blockOnPort(int port, int seconds)	When the node is started, wait until the following port is active
SoftLayerTemplateOptions	blockUntilRunning(boolean blockUntilRunning)	Note
SoftLayerTemplateOptions	clone()
void	copyTo(TemplateOptions to)
SoftLayerTemplateOptions	dedicatedAccountHostOnlyFlag(Boolean dedicatedAccountHostOnlyFlag)
SoftLayerTemplateOptions	diskType(String diskType)
SoftLayerTemplateOptions	domainName(String domainName)	will replace the default domain used when ordering virtual guests.
SoftLayerTemplateOptions	dontAuthorizePublicKey()
List<Integer>	getBlockDevices()
String	getDiskType()
String	getDomainName()
Integer	getPortSpeed()
String	getPostInstallScriptUri()
Integer	getPrimaryBackendNetworkComponentNetworkVlanId()
Integer	getPrimaryNetworkComponentNetworkVlanId()
List<Integer>	getSshKeys()
String	getUserData()
SoftLayerTemplateOptions	hourlyBillingFlag(Boolean hourlyBillingFlag)
SoftLayerTemplateOptions	inboundPorts(int... ports)	Opens the set of ports to public access.
SoftLayerTemplateOptions	installPrivateKey(String privateKey)	replaces the rsa ssh key used at login.
Boolean	isDedicatedAccountHostOnlyFlag()
Boolean	isHourlyBillingFlag()
Boolean	isPrivateNetworkOnlyFlag()
SoftLayerTemplateOptions	nameTask(String name)
SoftLayerTemplateOptions	networks(Iterable<String> networks)	Assigns the created nodes to these networks
SoftLayerTemplateOptions	nodeNames(Iterable<String> nodeNames)	specifies names to be used for the created nodes.
SoftLayerTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
SoftLayerTemplateOptions	overrideLoginCredentials(LoginCredentials overridingCredentials)
SoftLayerTemplateOptions	overrideLoginPassword(String password)
SoftLayerTemplateOptions	overrideLoginPrivateKey(String privateKey)
SoftLayerTemplateOptions	overrideLoginUser(String loginUser)
SoftLayerTemplateOptions	portSpeed(Integer portSpeed)
SoftLayerTemplateOptions	postInstallScriptUri(String postInstallScriptUri)
SoftLayerTemplateOptions	primaryBackendNetworkComponentNetworkVlanId(Integer primaryBackendNetworkComponentNetworkVlanId)
SoftLayerTemplateOptions	primaryNetworkComponentNetworkVlanId(Integer primaryNetworkComponentNetworkVlanId)
SoftLayerTemplateOptions	privateNetworkOnlyFlag(Boolean privateNetworkOnlyFlag)
SoftLayerTemplateOptions	runAsRoot(boolean runAsRoot)
SoftLayerTemplateOptions	runScript(Statement script)	This script will be executed as the root user upon system startup.
SoftLayerTemplateOptions	sshKeys(Integer... sshKeys)
SoftLayerTemplateOptions	sshKeys(Iterable<Integer> sshKeys)
SoftLayerTemplateOptions	userData(String userData)
SoftLayerTemplateOptions	userMetadata(String key, String value)
SoftLayerTemplateOptions	userMetadata(Map<String,String> userMetadata)

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

as, blockOnComplete, equals, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, hashCode, networks, runScript, securityGroups, securityGroups, shouldBlockUntilRunning, string, tags, wrapInInitScript

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

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

Methods inherited from class java.lang.Object

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

Field Detail

domainName

protected String domainName

blockDevices

protected List<Integer> blockDevices

diskType

protected String diskType

portSpeed

protected Integer portSpeed

userData

protected String userData

primaryNetworkComponentNetworkVlanId

protected Integer primaryNetworkComponentNetworkVlanId

primaryBackendNetworkComponentNetworkVlanId

protected Integer primaryBackendNetworkComponentNetworkVlanId

hourlyBillingFlag

protected Boolean hourlyBillingFlag

dedicatedAccountHostOnlyFlag

protected Boolean dedicatedAccountHostOnlyFlag

privateNetworkOnlyFlag

protected Boolean privateNetworkOnlyFlag

postInstallScriptUri

protected String postInstallScriptUri

sshKeys

protected List<Integer> sshKeys

Constructor Detail

SoftLayerTemplateOptions

public SoftLayerTemplateOptions()

Method Detail

clone

public SoftLayerTemplateOptions clone()

Overrides:

clone in class TemplateOptions

copyTo

public void copyTo(TemplateOptions to)

Overrides:

copyTo in class TemplateOptions

domainName

public SoftLayerTemplateOptions domainName(String domainName)

will replace the default domain used when ordering virtual guests. Note this needs to contain a public suffix!

See Also:

VirtualGuestApi.createVirtualGuest(org.jclouds.softlayer.domain.VirtualGuest), InternetDomainName.hasPublicSuffix()

blockDevices

public SoftLayerTemplateOptions blockDevices(Iterable<Integer> capacities)

blockDevices

public SoftLayerTemplateOptions blockDevices(Integer... capacities)

diskType

public SoftLayerTemplateOptions diskType(@Nullable
                                         String diskType)

portSpeed

public SoftLayerTemplateOptions portSpeed(@Nullable
                                          Integer portSpeed)

userData

public SoftLayerTemplateOptions userData(@Nullable
                                         String userData)

primaryNetworkComponentNetworkVlanId

public SoftLayerTemplateOptions primaryNetworkComponentNetworkVlanId(@Nullable
                                                                     Integer primaryNetworkComponentNetworkVlanId)

primaryBackendNetworkComponentNetworkVlanId

public SoftLayerTemplateOptions primaryBackendNetworkComponentNetworkVlanId(@Nullable
                                                                            Integer primaryBackendNetworkComponentNetworkVlanId)

hourlyBillingFlag

public SoftLayerTemplateOptions hourlyBillingFlag(@Nullable
                                                  Boolean hourlyBillingFlag)

dedicatedAccountHostOnlyFlag

public SoftLayerTemplateOptions dedicatedAccountHostOnlyFlag(@Nullable
                                                             Boolean dedicatedAccountHostOnlyFlag)

privateNetworkOnlyFlag

public SoftLayerTemplateOptions privateNetworkOnlyFlag(@Nullable
                                                       Boolean privateNetworkOnlyFlag)

postInstallScriptUri

public SoftLayerTemplateOptions postInstallScriptUri(@Nullable
                                                     String postInstallScriptUri)

sshKeys

public SoftLayerTemplateOptions sshKeys(Iterable<Integer> sshKeys)

sshKeys

public SoftLayerTemplateOptions sshKeys(Integer... sshKeys)

getDomainName

public String getDomainName()

getBlockDevices

public List<Integer> getBlockDevices()

getDiskType

public String getDiskType()

getPortSpeed

public Integer getPortSpeed()

getUserData

public String getUserData()

getPrimaryNetworkComponentNetworkVlanId

public Integer getPrimaryNetworkComponentNetworkVlanId()

getPrimaryBackendNetworkComponentNetworkVlanId

public Integer getPrimaryBackendNetworkComponentNetworkVlanId()

isHourlyBillingFlag

public Boolean isHourlyBillingFlag()

isDedicatedAccountHostOnlyFlag

public Boolean isDedicatedAccountHostOnlyFlag()

isPrivateNetworkOnlyFlag

public Boolean isPrivateNetworkOnlyFlag()

getPostInstallScriptUri

public String getPostInstallScriptUri()

getSshKeys

public List<Integer> getSshKeys()

blockOnPort

public SoftLayerTemplateOptions blockOnPort(int port,
                                            int seconds)

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

Overrides:

blockOnPort in class TemplateOptions

inboundPorts

public SoftLayerTemplateOptions inboundPorts(int... ports)

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

authorizePublicKey

public SoftLayerTemplateOptions authorizePublicKey(String publicKey)

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

installPrivateKey

public SoftLayerTemplateOptions installPrivateKey(String privateKey)

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

blockUntilRunning

public SoftLayerTemplateOptions blockUntilRunning(boolean blockUntilRunning)

Note

As of version 1.1.0, this option is incompatible with TemplateOptions.runScript(Statement) and RunScriptOptions.blockOnComplete(boolean), as all current implementations utilize ssh in order to execute scripts.

Overrides:

blockUntilRunning in class TemplateOptions

Parameters:

blockUntilRunning - (default true) whether to block until the nodes in this template are in Status#RUNNING state

dontAuthorizePublicKey

public SoftLayerTemplateOptions dontAuthorizePublicKey()

Overrides:

dontAuthorizePublicKey in class TemplateOptions

nameTask

public SoftLayerTemplateOptions nameTask(String name)

Overrides:

nameTask in class TemplateOptions

Returns:

What to call the task relating to this script; default jclouds-script-timestamp where timestamp is millis since epoch

runAsRoot

public SoftLayerTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class TemplateOptions

runScript

public SoftLayerTemplateOptions runScript(Statement script)

This script will be executed as the root user upon system startup. This script gets a prologue, so no #!/bin/bash required, path set up, etc

Overrides:

runScript in class TemplateOptions

overrideLoginCredentials

public SoftLayerTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

Overrides:

overrideLoginCredentials in class TemplateOptions

overrideLoginPassword

public SoftLayerTemplateOptions overrideLoginPassword(String password)

Overrides:

overrideLoginPassword in class TemplateOptions

overrideLoginPrivateKey

public SoftLayerTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

overrideLoginPrivateKey in class TemplateOptions

overrideLoginUser

public SoftLayerTemplateOptions overrideLoginUser(String loginUser)

Overrides:

overrideLoginUser in class TemplateOptions

overrideAuthenticateSudo

public SoftLayerTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

overrideAuthenticateSudo in class TemplateOptions

userMetadata

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

Overrides:

userMetadata in class TemplateOptions

Parameters:

userMetadata - user-defined metadata to assign to this server

userMetadata

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

nodeNames

public SoftLayerTemplateOptions nodeNames(Iterable<String> nodeNames)

specifies names to be used for the created nodes. Note that this does not guarantee uniqueness - if there are already existing nodes with a name specified here, there will still be a new node created with the same name. Also, if more nodes are to be created than there are names, subsequent names will use the default naming strategy for that cloud.

Overrides:

nodeNames in class TemplateOptions

networks

public SoftLayerTemplateOptions networks(Iterable<String> networks)

Assigns the created nodes to these networks

Overrides:

networks in class TemplateOptions