org.jclouds.openstack.nova.v2_0.compute.options

Class NovaTemplateOptions

    • Field Detail

      • autoAssignFloatingIp

        protected boolean autoAssignFloatingIp

      • floatingIpPoolNames

        protected com.google.common.base.Optional<Set<String>> floatingIpPoolNames

      • generateKeyPair

        protected boolean generateKeyPair

      • keyPairName

        protected String keyPairName

      • userData

        protected byte[] userData

      • diskConfig

        protected String diskConfig

      • configDrive

        protected boolean configDrive

      • novaNetworks

        protected Set<Network> novaNetworks

      • availabilityZone

        protected String availabilityZone

    • Constructor Detail

      • NovaTemplateOptions

        public NovaTemplateOptions()

    • Method Detail

      • clone

        public NovaTemplateOptions clone()
        Overrides:
        clone in class org.jclouds.compute.options.TemplateOptions

      • copyTo

        public void copyTo(org.jclouds.compute.options.TemplateOptions to)
        Overrides:
        copyTo in class org.jclouds.compute.options.TemplateOptions

      • equals

        public boolean equals(Object o)
        Overrides:
        equals in class org.jclouds.compute.options.TemplateOptions

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.jclouds.compute.options.TemplateOptions

      • string

        public com.google.common.base.Objects.ToStringHelper string()
        Overrides:
        string in class org.jclouds.compute.options.TemplateOptions

      • shouldAutoAssignFloatingIp

        public boolean shouldAutoAssignFloatingIp()

        Note

        This requires that NovaApi#getExtensionForRegion(String) to return present
        Returns:
        true if auto assignment of a floating ip to each vm is enabled

      • availabilityZone

        public NovaTemplateOptions availabilityZone(String availabilityZone)
        See Also:
        CreateServerOptions#getAvailabilityZone()

      • getFloatingIpPoolNames

        public com.google.common.base.Optional<Set<String>> getFloatingIpPoolNames()
        The floating IP pool name(s) to use when allocating a FloatingIP. Applicable only if #shouldAutoAssignFloatingIp() returns true. If not set will attempt to use whatever FloatingIP(s) can be found regardless of which pool they originated from
        Returns:
        floating-ip-pool names to use

      • getKeyPairName

        public String getKeyPairName()
        Specifies the keypair used to run instances with
        Returns:
        the keypair to be used

      • shouldGenerateKeyPair

        public boolean shouldGenerateKeyPair()

        Note

        This requires that NovaApi#getKeyPairExtensionApi(String) to return present
        Returns:
        true if auto generation of keypairs is enabled

      • getSecurityGroupNames

        @Deprecated
public com.google.common.base.Optional<Set<String>> getSecurityGroupNames()
        Deprecated. Use TemplateOptions.getGroups() instead. To be removed in jclouds 2.0.
        if unset, generate a default group prefixed with jclouds# according to TemplateOptions.getInboundPorts()
        See Also:
        CreateServerOptions.getSecurityGroupNames()

      • getUserData

        public byte[] getUserData()

      • getDiskConfig

        public String getDiskConfig()
        See Also:
        CreateServerOptions#getDiskConfig()

      • getConfigDrive

        public boolean getConfigDrive()
        See Also:
        CreateServerOptions#getConfigDrive()

      • getNovaNetworks

        public Set<Network> getNovaNetworks()
        See Also:
        CreateServerOptions#getNetworks()

      • getAvailabilityZone

        public String getAvailabilityZone()
        See Also:
        CreateServerOptions#getAvailabilityZone()

      • blockOnPort

        public NovaTemplateOptions blockOnPort(int port,
                              int seconds)
        Overrides:
        blockOnPort in class org.jclouds.compute.options.TemplateOptions

      • inboundPorts

        public NovaTemplateOptions inboundPorts(int... ports)
        Overrides:
        inboundPorts in class org.jclouds.compute.options.TemplateOptions

      • authorizePublicKey

        public NovaTemplateOptions authorizePublicKey(String publicKey)
        Overrides:
        authorizePublicKey in class org.jclouds.compute.options.TemplateOptions

      • installPrivateKey

        public NovaTemplateOptions installPrivateKey(String privateKey)
        Overrides:
        installPrivateKey in class org.jclouds.compute.options.TemplateOptions

      • blockUntilRunning

        public NovaTemplateOptions blockUntilRunning(boolean blockUntilRunning)
        Overrides:
        blockUntilRunning in class org.jclouds.compute.options.TemplateOptions

      • dontAuthorizePublicKey

        public NovaTemplateOptions dontAuthorizePublicKey()
        Overrides:
        dontAuthorizePublicKey in class org.jclouds.compute.options.TemplateOptions

      • nameTask

        public NovaTemplateOptions nameTask(String name)
        Overrides:
        nameTask in class org.jclouds.compute.options.TemplateOptions

      • runAsRoot

        public NovaTemplateOptions runAsRoot(boolean runAsRoot)
        Overrides:
        runAsRoot in class org.jclouds.compute.options.TemplateOptions

      • runScript

        public NovaTemplateOptions runScript(org.jclouds.scriptbuilder.domain.Statement script)
        Overrides:
        runScript in class org.jclouds.compute.options.TemplateOptions

      • overrideLoginCredentials

        public NovaTemplateOptions overrideLoginCredentials(org.jclouds.domain.LoginCredentials overridingCredentials)
        Overrides:
        overrideLoginCredentials in class org.jclouds.compute.options.TemplateOptions

      • overrideLoginPassword

        public NovaTemplateOptions overrideLoginPassword(String password)
        Overrides:
        overrideLoginPassword in class org.jclouds.compute.options.TemplateOptions

      • overrideLoginPrivateKey

        public NovaTemplateOptions overrideLoginPrivateKey(String privateKey)
        Overrides:
        overrideLoginPrivateKey in class org.jclouds.compute.options.TemplateOptions

      • overrideLoginUser

        public NovaTemplateOptions overrideLoginUser(String loginUser)
        Overrides:
        overrideLoginUser in class org.jclouds.compute.options.TemplateOptions

      • overrideAuthenticateSudo

        public NovaTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)
        Overrides:
        overrideAuthenticateSudo in class org.jclouds.compute.options.TemplateOptions

      • userMetadata

        public NovaTemplateOptions userMetadata(String key,
                               String value)
        Overrides:
        userMetadata in class org.jclouds.compute.options.TemplateOptions

      • networks

        public NovaTemplateOptions networks(Iterable<String> networks)

        Ensures NovaTemplateOptions can work with networks specified as Strings. Also provides for compatibility with the abstraction layer.
        Overrides:
        networks in class org.jclouds.compute.options.TemplateOptions

      • networks

        public NovaTemplateOptions networks(String... networks)

        Ensures NovaTemplateOptions can work with networks specified as Strings. Also provides for compatibility with the abstraction layer.
        Overrides:
        networks in class org.jclouds.compute.options.TemplateOptions

      • userData

        public NovaTemplateOptions userData(byte[] userData)
        User data as bytes (not base64-encoded)

      • configDrive

        public NovaTemplateOptions configDrive(boolean configDrive)
        OpenStack can be configured to write metadata to a special configuration drive that will be attached to the instance when it boots. The instance can retrieve any information that would normally be available through the metadata service by mounting this disk and reading files from it. To enable the config drive, set this parameter to "true". This has to be enabled for user data cases.
        See Also:
        CreateServerOptions#getConfigDrive()

      • novaNetworks

        public NovaTemplateOptions novaNetworks(Set<Network> novaNetworks)
        Parameters:
        novaNetworks - The list of network declarations. Nova-specific network declarations allow for specifying network UUIDs, port UUIDs, and fixed IPs. Unline networks(Iterable) this supports setting additional network parameters and not just network UUIDs.
        See Also:
        CreateServerOptions#getNetworks()

Copyright © 2009-2016 The Apache Software Foundation. All Rights Reserved.