CloudStackTemplateOptions (Apache jclouds 2.0.0 API)

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

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`CloudStackTemplateOptions.Builder`

Field Summary
- 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 and Description

CloudStackTemplateOptions()

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`	`blockUntilRunning(boolean blockUntilRunning)` Note
`CloudStackTemplateOptions`	`clone()`
`void`	`copyTo(TemplateOptions to)`
`CloudStackTemplateOptions`	`dataDiskSize(int dataDiskSize)`
`CloudStackTemplateOptions`	`diskOfferingId(String diskOfferingId)`
`CloudStackTemplateOptions`	`domainId(String domainId)`
`CloudStackTemplateOptions`	`dontAuthorizePublicKey()`
`boolean`	`equals(Object o)`
`CloudStackTemplateOptions`	`generateKeyPair(boolean generateKeyPair)`
`CloudStackTemplateOptions`	`generateSecurityGroup(boolean generateSecurityGroup)`
`String`	`getAccount()`
`int`	`getDataDiskSize()`
`String`	`getDiskOfferingId()`
`String`	`getDomainId()`
`String`	`getIpOnDefaultNetwork()`
`Map<String,String>`	`getIpsToNetworks()`
`String`	`getKeyPair()`
`Set<String>`	`getSecurityGroupIds()`
`byte[]`	`getUserData()`
`int`	`hashCode()`
`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`	`nameTask(String name)`
`CloudStackTemplateOptions`	`networks(Iterable<String> networks)` Assigns the created nodes to these networks
`CloudStackTemplateOptions`	`nodeNames(Iterable<String> nodeNames)` specifies names to be used for the created nodes.
`CloudStackTemplateOptions`	`overrideAuthenticateSudo(boolean authenticateSudo)`
`CloudStackTemplateOptions`	`overrideLoginCredentials(LoginCredentials overridingCredentials)`
`CloudStackTemplateOptions`	`overrideLoginPassword(String password)`
`CloudStackTemplateOptions`	`overrideLoginPrivateKey(String privateKey)`
`CloudStackTemplateOptions`	`overrideLoginUser(String loginUser)`
`CloudStackTemplateOptions`	`runAsRoot(boolean runAsRoot)`
`CloudStackTemplateOptions`	`runScript(Statement script)` This script will be executed as the root user upon system startup.
`CloudStackTemplateOptions`	`securityGroupIds(Iterable<String> securityGroupIds)`
`CloudStackTemplateOptions`	`setupStaticNat(boolean setupStaticNat)`
`boolean`	`shouldGenerateKeyPair()`
`boolean`	`shouldGenerateSecurityGroup()`
`boolean`	`shouldSetupStaticNat()`
`String`	`toString()`
`CloudStackTemplateOptions`	`userData(byte[] userData)`
`CloudStackTemplateOptions`	`userData(String userData)`
`CloudStackTemplateOptions`	`userData(URL userDataUrl)`
`CloudStackTemplateOptions`	`userMetadata(Map<String,String> userMetadata)`
`CloudStackTemplateOptions`	`userMetadata(String key, String value)`

Methods inherited from class org.jclouds.compute.options.TemplateOptions
as, blockOnComplete, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, 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

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- CloudStackTemplateOptions
```
public CloudStackTemplateOptions()
```

Method Detail

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<String> securityGroupIds)

ipsToNetworks

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

ipOnDefaultNetwork

public CloudStackTemplateOptions ipOnDefaultNetwork(String ipOnDefaultNetwork)

keyPair

public CloudStackTemplateOptions keyPair(String keyPair)

setupStaticNat

public CloudStackTemplateOptions setupStaticNat(boolean setupStaticNat)

account

public CloudStackTemplateOptions account(String account)

domainId

public CloudStackTemplateOptions domainId(String domainId)

generateKeyPair

public CloudStackTemplateOptions generateKeyPair(boolean generateKeyPair)

generateSecurityGroup

public CloudStackTemplateOptions generateSecurityGroup(boolean generateSecurityGroup)

diskOfferingId

public CloudStackTemplateOptions diskOfferingId(String diskOfferingId)

dataDiskSize

public CloudStackTemplateOptions dataDiskSize(int dataDiskSize)

userData

public CloudStackTemplateOptions userData(byte[] userData)

userData

public CloudStackTemplateOptions userData(String userData)

userData

public CloudStackTemplateOptions userData(URL userDataUrl)
                                   throws IOException

Throws:: IOException

getSecurityGroupIds

public Set<String> getSecurityGroupIds()

getIpsToNetworks

public Map<String,String> getIpsToNetworks()

getIpOnDefaultNetwork
```
public String getIpOnDefaultNetwork()
```

getKeyPair
```
public String getKeyPair()
```

shouldSetupStaticNat
```
public boolean shouldSetupStaticNat()
```

getAccount
```
public String getAccount()
```

getDomainId
```
public String getDomainId()
```

shouldGenerateKeyPair

public boolean shouldGenerateKeyPair()

shouldGenerateSecurityGroup

public boolean shouldGenerateSecurityGroup()

getDiskOfferingId
```
public String getDiskOfferingId()
```

getDataDiskSize
```
public int getDataDiskSize()
```

getUserData
```
public byte[] getUserData()
```

clone

public CloudStackTemplateOptions clone()

Overrides:: clone in class TemplateOptions

copyTo
```
public void copyTo(TemplateOptions to)
```
Overrides:

copyTo in class TemplateOptions

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class TemplateOptions

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class TemplateOptions

toString
```
public String toString()
```
Overrides:

toString in class RunScriptOptions

blockOnPort
```
public CloudStackTemplateOptions blockOnPort(int port,
                                    int seconds)
```
When the node is started, wait until the following port is active

Overrides:

blockOnPort in class TemplateOptions

inboundPorts
```
public CloudStackTemplateOptions inboundPorts(int... ports)
```
Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

authorizePublicKey
```
public CloudStackTemplateOptions authorizePublicKey(String publicKey)
```
authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

installPrivateKey
```
public CloudStackTemplateOptions installPrivateKey(String privateKey)
```
replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

blockUntilRunning
```
public CloudStackTemplateOptions 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 CloudStackTemplateOptions dontAuthorizePublicKey()
```
Overrides:

dontAuthorizePublicKey in class TemplateOptions

nameTask
```
public CloudStackTemplateOptions 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 CloudStackTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:: runAsRoot in class TemplateOptions

runScript
```
public CloudStackTemplateOptions 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 CloudStackTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

Overrides:: overrideLoginCredentials in class TemplateOptions

overrideLoginPassword

public CloudStackTemplateOptions overrideLoginPassword(String password)

Overrides:: overrideLoginPassword in class TemplateOptions

overrideLoginPrivateKey

public CloudStackTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:: overrideLoginPrivateKey in class TemplateOptions

overrideLoginUser

public CloudStackTemplateOptions overrideLoginUser(String loginUser)

Overrides:: overrideLoginUser in class TemplateOptions

overrideAuthenticateSudo

public CloudStackTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:: overrideAuthenticateSudo in class TemplateOptions

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

nodeNames
```
public CloudStackTemplateOptions 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 CloudStackTemplateOptions networks(Iterable<String> networks)
```
Assigns the created nodes to these networks

Overrides:

networks in class TemplateOptions

Class CloudStackTemplateOptions

Usage

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

CloudStackTemplateOptions

Method Detail

securityGroupIds

ipsToNetworks

ipOnDefaultNetwork

keyPair

setupStaticNat

account

domainId

generateKeyPair

generateSecurityGroup

diskOfferingId

dataDiskSize

userData

userData

userData

getSecurityGroupIds

getIpsToNetworks

getIpOnDefaultNetwork

getKeyPair

shouldSetupStaticNat

getAccount

getDomainId

shouldGenerateKeyPair

shouldGenerateSecurityGroup

getDiskOfferingId

getDataDiskSize

getUserData

clone

copyTo

equals

hashCode

toString

blockOnPort

inboundPorts

authorizePublicKey

installPrivateKey

blockUntilRunning

Note

dontAuthorizePublicKey

nameTask

runAsRoot

runScript

overrideLoginCredentials

overrideLoginPassword

overrideLoginPrivateKey

overrideLoginUser

overrideAuthenticateSudo

userMetadata

userMetadata

nodeNames

networks