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