Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

NodeTemplate

Provides a Rancher v2 Node Template resource. This can be used to create Node Template for Rancher v2 and retrieve their information.

amazonec2, azure, digitalocean, linode, opennebula, openstack, hetzner, and vsphere drivers are supported for node templates.

Note If you are upgrading to Rancher v2.3.3, please take a look to final section

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 Node Template up to Rancher 2.1.x
        var foo = new Rancher2.NodeTemplate("foo", new Rancher2.NodeTemplateArgs
        {
            Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
            {
                AccessKey = "AWS_ACCESS_KEY",
                Ami = "<AMI_ID>",
                Region = "<REGION>",
                SecretKey = "<AWS_SECRET_KEY>",
                SecurityGroups = 
                {
                    "<AWS_SECURITY_GROUP>",
                },
                SubnetId = "<SUBNET_ID>",
                VpcId = "<VPC_ID>",
                Zone = "<ZONE>",
            },
            Description = "foo test",
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewNodeTemplate(ctx, "foo", &rancher2.NodeTemplateArgs{
            Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
                AccessKey: pulumi.String("AWS_ACCESS_KEY"),
                Ami:       pulumi.String("<AMI_ID>"),
                Region:    pulumi.String("<REGION>"),
                SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
                SecurityGroups: pulumi.StringArray{
                    pulumi.String("<AWS_SECURITY_GROUP>"),
                },
                SubnetId: pulumi.String("<SUBNET_ID>"),
                VpcId:    pulumi.String("<VPC_ID>"),
                Zone:     pulumi.String("<ZONE>"),
            },
            Description: pulumi.String("foo test"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Template up to Rancher 2.1.x
foo = rancher2.NodeTemplate("foo",
    amazonec2_config=rancher2.NodeTemplateAmazonec2ConfigArgs(
        access_key="AWS_ACCESS_KEY",
        ami="<AMI_ID>",
        region="<REGION>",
        secret_key="<AWS_SECRET_KEY>",
        security_groups=["<AWS_SECURITY_GROUP>"],
        subnet_id="<SUBNET_ID>",
        vpc_id="<VPC_ID>",
        zone="<ZONE>",
    ),
    description="foo test")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Template up to Rancher 2.1.x
const foo = new rancher2.NodeTemplate("foo", {
    amazonec2Config: {
        accessKey: "AWS_ACCESS_KEY",
        ami: "<AMI_ID>",
        region: "<REGION>",
        secretKey: "<AWS_SECRET_KEY>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
    description: "foo test",
});

Using the Hetzner Node Driver

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 Node Template using hetzner node_driver
        var hetznerNodeDriver = new Rancher2.NodeDriver("hetznerNodeDriver", new Rancher2.NodeDriverArgs
        {
            Active = true,
            Builtin = false,
            UiUrl = "https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js",
            Url = "https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.0.0/docker-machine-driver-hetzner_3.0.0_linux_amd64.tar.gz",
            WhitelistDomains = 
            {
                "storage.googleapis.com",
            },
        });
        var myHetznerNodeTemplate = new Rancher2.NodeTemplate("myHetznerNodeTemplate", new Rancher2.NodeTemplateArgs
        {
            DriverId = hetznerNodeDriver.Id,
            HetznerConfig = new Rancher2.Inputs.NodeTemplateHetznerConfigArgs
            {
                ApiToken = "XXXXXXXXXX",
                Image = "ubuntu-18.04",
                ServerLocation = "nbg1",
                ServerType = "cx11",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        hetznerNodeDriver, err := rancher2.NewNodeDriver(ctx, "hetznerNodeDriver", &rancher2.NodeDriverArgs{
            Active:  pulumi.Bool(true),
            Builtin: pulumi.Bool(false),
            UiUrl:   pulumi.String("https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js"),
            Url:     pulumi.String("https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.0.0/docker-machine-driver-hetzner_3.0.0_linux_amd64.tar.gz"),
            WhitelistDomains: pulumi.StringArray{
                pulumi.String("storage.googleapis.com"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rancher2.NewNodeTemplate(ctx, "myHetznerNodeTemplate", &rancher2.NodeTemplateArgs{
            DriverId: hetznerNodeDriver.ID(),
            HetznerConfig: &rancher2.NodeTemplateHetznerConfigArgs{
                ApiToken:       pulumi.String("XXXXXXXXXX"),
                Image:          pulumi.String("ubuntu-18.04"),
                ServerLocation: pulumi.String("nbg1"),
                ServerType:     pulumi.String("cx11"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Template using hetzner node_driver
hetzner_node_driver = rancher2.NodeDriver("hetznerNodeDriver",
    active=True,
    builtin=False,
    ui_url="https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js",
    url="https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.0.0/docker-machine-driver-hetzner_3.0.0_linux_amd64.tar.gz",
    whitelist_domains=["storage.googleapis.com"])
my_hetzner_node_template = rancher2.NodeTemplate("myHetznerNodeTemplate",
    driver_id=hetzner_node_driver.id,
    hetzner_config=rancher2.NodeTemplateHetznerConfigArgs(
        api_token="XXXXXXXXXX",
        image="ubuntu-18.04",
        server_location="nbg1",
        server_type="cx11",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Template using hetzner node_driver
const hetznerNodeDriver = new rancher2.NodeDriver("hetznerNodeDriver", {
    active: true,
    builtin: false,
    uiUrl: "https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js",
    url: "https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.0.0/docker-machine-driver-hetzner_3.0.0_linux_amd64.tar.gz",
    whitelistDomains: ["storage.googleapis.com"],
});
const myHetznerNodeTemplate = new rancher2.NodeTemplate("myHetznerNodeTemplate", {
    driverId: hetznerNodeDriver.id,
    hetznerConfig: {
        apiToken: "XXXXXXXXXX",
        image: "ubuntu-18.04",
        serverLocation: "nbg1",
        serverType: "cx11",
    },
});

Create a NodeTemplate Resource

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: CustomResourceOptions);
def NodeTemplate(resource_name: str, opts: Optional[ResourceOptions] = None, amazonec2_config: Optional[NodeTemplateAmazonec2ConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, auth_certificate_authority: Optional[str] = None, auth_key: Optional[str] = None, azure_config: Optional[NodeTemplateAzureConfigArgs] = None, cloud_credential_id: Optional[str] = None, description: Optional[str] = None, digitalocean_config: Optional[NodeTemplateDigitaloceanConfigArgs] = None, driver_id: Optional[str] = None, engine_env: Optional[Mapping[str, Any]] = None, engine_insecure_registries: Optional[Sequence[str]] = None, engine_install_url: Optional[str] = None, engine_label: Optional[Mapping[str, Any]] = None, engine_opt: Optional[Mapping[str, Any]] = None, engine_registry_mirrors: Optional[Sequence[str]] = None, engine_storage_driver: Optional[str] = None, hetzner_config: Optional[NodeTemplateHetznerConfigArgs] = None, labels: Optional[Mapping[str, Any]] = None, linode_config: Optional[NodeTemplateLinodeConfigArgs] = None, name: Optional[str] = None, opennebula_config: Optional[NodeTemplateOpennebulaConfigArgs] = None, openstack_config: Optional[NodeTemplateOpenstackConfigArgs] = None, use_internal_ip_address: Optional[bool] = None, vsphere_config: Optional[NodeTemplateVsphereConfigArgs] = None)
func NewNodeTemplate(ctx *Context, name string, args *NodeTemplateArgs, opts ...ResourceOption) (*NodeTemplate, error)
public NodeTemplate(string name, NodeTemplateArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NodeTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args NodeTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NodeTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

NodeTemplate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NodeTemplate resource accepts the following input properties:

Amazonec2Config NodeTemplateAmazonec2ConfigArgs

AWS config for the Node Template (list maxitems:1)

Annotations Dictionary<string, object>

Annotations for Node Template object (map)

AuthCertificateAuthority string

Auth certificate authority for the Node Template (string)

AuthKey string

Auth key for the Node Template (string)

AzureConfig NodeTemplateAzureConfigArgs

Azure config for the Node Template (list maxitems:1)

CloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

Description string

Description for the Node Template (string)

DigitaloceanConfig NodeTemplateDigitaloceanConfigArgs

Digitalocean config for the Node Template (list maxitems:1)

DriverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

EngineEnv Dictionary<string, object>

Engine environment for the node template (string)

EngineInsecureRegistries List<string>

Insecure registry for the node template (list)

EngineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

EngineLabel Dictionary<string, object>

Engine label for the node template (string)

EngineOpt Dictionary<string, object>

Engine options for the node template (map)

EngineRegistryMirrors List<string>

Engine registry mirror for the node template (list)

EngineStorageDriver string

Engine storage driver for the node template (string)

HetznerConfig NodeTemplateHetznerConfigArgs

Hetzner config for the Node Template (list maxitems:1)

Labels Dictionary<string, object>

Labels for Node Template object (map)

LinodeConfig NodeTemplateLinodeConfigArgs

Linode config for the Node Template (list maxitems:1)

Name string

The name of the Node Template (string)

OpennebulaConfig NodeTemplateOpennebulaConfigArgs

Opennebula config for the Node Template (list maxitems:1)

OpenstackConfig NodeTemplateOpenstackConfigArgs

Openstack config for the Node Template (list maxitems:1)

UseInternalIpAddress bool

Engine storage driver for the node template (bool)

VsphereConfig NodeTemplateVsphereConfigArgs

vSphere config for the Node Template (list maxitems:1)

Amazonec2Config NodeTemplateAmazonec2Config

AWS config for the Node Template (list maxitems:1)

Annotations map[string]interface{}

Annotations for Node Template object (map)

AuthCertificateAuthority string

Auth certificate authority for the Node Template (string)

AuthKey string

Auth key for the Node Template (string)

AzureConfig NodeTemplateAzureConfig

Azure config for the Node Template (list maxitems:1)

CloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

Description string

Description for the Node Template (string)

DigitaloceanConfig NodeTemplateDigitaloceanConfig

Digitalocean config for the Node Template (list maxitems:1)

DriverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

EngineEnv map[string]interface{}

Engine environment for the node template (string)

EngineInsecureRegistries []string

Insecure registry for the node template (list)

EngineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

EngineLabel map[string]interface{}

Engine label for the node template (string)

EngineOpt map[string]interface{}

Engine options for the node template (map)

EngineRegistryMirrors []string

Engine registry mirror for the node template (list)

EngineStorageDriver string

Engine storage driver for the node template (string)

HetznerConfig NodeTemplateHetznerConfig

Hetzner config for the Node Template (list maxitems:1)

Labels map[string]interface{}

Labels for Node Template object (map)

LinodeConfig NodeTemplateLinodeConfig

Linode config for the Node Template (list maxitems:1)

Name string

The name of the Node Template (string)

OpennebulaConfig NodeTemplateOpennebulaConfig

Opennebula config for the Node Template (list maxitems:1)

OpenstackConfig NodeTemplateOpenstackConfig

Openstack config for the Node Template (list maxitems:1)

UseInternalIpAddress bool

Engine storage driver for the node template (bool)

VsphereConfig NodeTemplateVsphereConfig

vSphere config for the Node Template (list maxitems:1)

amazonec2Config NodeTemplateAmazonec2Config

AWS config for the Node Template (list maxitems:1)

annotations {[key: string]: any}

Annotations for Node Template object (map)

authCertificateAuthority string

Auth certificate authority for the Node Template (string)

authKey string

Auth key for the Node Template (string)

azureConfig NodeTemplateAzureConfig

Azure config for the Node Template (list maxitems:1)

cloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

description string

Description for the Node Template (string)

digitaloceanConfig NodeTemplateDigitaloceanConfig

Digitalocean config for the Node Template (list maxitems:1)

driverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

engineEnv {[key: string]: any}

Engine environment for the node template (string)

engineInsecureRegistries string[]

Insecure registry for the node template (list)

engineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

engineLabel {[key: string]: any}

Engine label for the node template (string)

engineOpt {[key: string]: any}

Engine options for the node template (map)

engineRegistryMirrors string[]

Engine registry mirror for the node template (list)

engineStorageDriver string

Engine storage driver for the node template (string)

hetznerConfig NodeTemplateHetznerConfig

Hetzner config for the Node Template (list maxitems:1)

labels {[key: string]: any}

Labels for Node Template object (map)

linodeConfig NodeTemplateLinodeConfig

Linode config for the Node Template (list maxitems:1)

name string

The name of the Node Template (string)

opennebulaConfig NodeTemplateOpennebulaConfig

Opennebula config for the Node Template (list maxitems:1)

openstackConfig NodeTemplateOpenstackConfig

Openstack config for the Node Template (list maxitems:1)

useInternalIpAddress boolean

Engine storage driver for the node template (bool)

vsphereConfig NodeTemplateVsphereConfig

vSphere config for the Node Template (list maxitems:1)

amazonec2_config NodeTemplateAmazonec2ConfigArgs

AWS config for the Node Template (list maxitems:1)

annotations Mapping[str, Any]

Annotations for Node Template object (map)

auth_certificate_authority str

Auth certificate authority for the Node Template (string)

auth_key str

Auth key for the Node Template (string)

azure_config NodeTemplateAzureConfigArgs

Azure config for the Node Template (list maxitems:1)

cloud_credential_id str

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

description str

Description for the Node Template (string)

digitalocean_config NodeTemplateDigitaloceanConfigArgs

Digitalocean config for the Node Template (list maxitems:1)

driver_id str

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

engine_env Mapping[str, Any]

Engine environment for the node template (string)

engine_insecure_registries Sequence[str]

Insecure registry for the node template (list)

engine_install_url str

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

engine_label Mapping[str, Any]

Engine label for the node template (string)

engine_opt Mapping[str, Any]

Engine options for the node template (map)

engine_registry_mirrors Sequence[str]

Engine registry mirror for the node template (list)

engine_storage_driver str

Engine storage driver for the node template (string)

hetzner_config NodeTemplateHetznerConfigArgs

Hetzner config for the Node Template (list maxitems:1)

labels Mapping[str, Any]

Labels for Node Template object (map)

linode_config NodeTemplateLinodeConfigArgs

Linode config for the Node Template (list maxitems:1)

name str

The name of the Node Template (string)

opennebula_config NodeTemplateOpennebulaConfigArgs

Opennebula config for the Node Template (list maxitems:1)

openstack_config NodeTemplateOpenstackConfigArgs

Openstack config for the Node Template (list maxitems:1)

use_internal_ip_address bool

Engine storage driver for the node template (bool)

vsphere_config NodeTemplateVsphereConfigArgs

vSphere config for the Node Template (list maxitems:1)

Outputs

All input properties are implicitly available as output properties. Additionally, the NodeTemplate resource produces the following output properties:

Driver string

(Computed) The driver of the node template (string)

Id string
The provider-assigned unique ID for this managed resource.
Driver string

(Computed) The driver of the node template (string)

Id string
The provider-assigned unique ID for this managed resource.
driver string

(Computed) The driver of the node template (string)

id string
The provider-assigned unique ID for this managed resource.
driver str

(Computed) The driver of the node template (string)

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing NodeTemplate Resource

Get an existing NodeTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NodeTemplateState, opts?: CustomResourceOptions): NodeTemplate
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, amazonec2_config: Optional[NodeTemplateAmazonec2ConfigArgs] = None, annotations: Optional[Mapping[str, Any]] = None, auth_certificate_authority: Optional[str] = None, auth_key: Optional[str] = None, azure_config: Optional[NodeTemplateAzureConfigArgs] = None, cloud_credential_id: Optional[str] = None, description: Optional[str] = None, digitalocean_config: Optional[NodeTemplateDigitaloceanConfigArgs] = None, driver: Optional[str] = None, driver_id: Optional[str] = None, engine_env: Optional[Mapping[str, Any]] = None, engine_insecure_registries: Optional[Sequence[str]] = None, engine_install_url: Optional[str] = None, engine_label: Optional[Mapping[str, Any]] = None, engine_opt: Optional[Mapping[str, Any]] = None, engine_registry_mirrors: Optional[Sequence[str]] = None, engine_storage_driver: Optional[str] = None, hetzner_config: Optional[NodeTemplateHetznerConfigArgs] = None, labels: Optional[Mapping[str, Any]] = None, linode_config: Optional[NodeTemplateLinodeConfigArgs] = None, name: Optional[str] = None, opennebula_config: Optional[NodeTemplateOpennebulaConfigArgs] = None, openstack_config: Optional[NodeTemplateOpenstackConfigArgs] = None, use_internal_ip_address: Optional[bool] = None, vsphere_config: Optional[NodeTemplateVsphereConfigArgs] = None) -> NodeTemplate
func GetNodeTemplate(ctx *Context, name string, id IDInput, state *NodeTemplateState, opts ...ResourceOption) (*NodeTemplate, error)
public static NodeTemplate Get(string name, Input<string> id, NodeTemplateState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Amazonec2Config NodeTemplateAmazonec2ConfigArgs

AWS config for the Node Template (list maxitems:1)

Annotations Dictionary<string, object>

Annotations for Node Template object (map)

AuthCertificateAuthority string

Auth certificate authority for the Node Template (string)

AuthKey string

Auth key for the Node Template (string)

AzureConfig NodeTemplateAzureConfigArgs

Azure config for the Node Template (list maxitems:1)

CloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

Description string

Description for the Node Template (string)

DigitaloceanConfig NodeTemplateDigitaloceanConfigArgs

Digitalocean config for the Node Template (list maxitems:1)

Driver string

(Computed) The driver of the node template (string)

DriverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

EngineEnv Dictionary<string, object>

Engine environment for the node template (string)

EngineInsecureRegistries List<string>

Insecure registry for the node template (list)

EngineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

EngineLabel Dictionary<string, object>

Engine label for the node template (string)

EngineOpt Dictionary<string, object>

Engine options for the node template (map)

EngineRegistryMirrors List<string>

Engine registry mirror for the node template (list)

EngineStorageDriver string

Engine storage driver for the node template (string)

HetznerConfig NodeTemplateHetznerConfigArgs

Hetzner config for the Node Template (list maxitems:1)

Labels Dictionary<string, object>

Labels for Node Template object (map)

LinodeConfig NodeTemplateLinodeConfigArgs

Linode config for the Node Template (list maxitems:1)

Name string

The name of the Node Template (string)

OpennebulaConfig NodeTemplateOpennebulaConfigArgs

Opennebula config for the Node Template (list maxitems:1)

OpenstackConfig NodeTemplateOpenstackConfigArgs

Openstack config for the Node Template (list maxitems:1)

UseInternalIpAddress bool

Engine storage driver for the node template (bool)

VsphereConfig NodeTemplateVsphereConfigArgs

vSphere config for the Node Template (list maxitems:1)

Amazonec2Config NodeTemplateAmazonec2Config

AWS config for the Node Template (list maxitems:1)

Annotations map[string]interface{}

Annotations for Node Template object (map)

AuthCertificateAuthority string

Auth certificate authority for the Node Template (string)

AuthKey string

Auth key for the Node Template (string)

AzureConfig NodeTemplateAzureConfig

Azure config for the Node Template (list maxitems:1)

CloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

Description string

Description for the Node Template (string)

DigitaloceanConfig NodeTemplateDigitaloceanConfig

Digitalocean config for the Node Template (list maxitems:1)

Driver string

(Computed) The driver of the node template (string)

DriverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

EngineEnv map[string]interface{}

Engine environment for the node template (string)

EngineInsecureRegistries []string

Insecure registry for the node template (list)

EngineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

EngineLabel map[string]interface{}

Engine label for the node template (string)

EngineOpt map[string]interface{}

Engine options for the node template (map)

EngineRegistryMirrors []string

Engine registry mirror for the node template (list)

EngineStorageDriver string

Engine storage driver for the node template (string)

HetznerConfig NodeTemplateHetznerConfig

Hetzner config for the Node Template (list maxitems:1)

Labels map[string]interface{}

Labels for Node Template object (map)

LinodeConfig NodeTemplateLinodeConfig

Linode config for the Node Template (list maxitems:1)

Name string

The name of the Node Template (string)

OpennebulaConfig NodeTemplateOpennebulaConfig

Opennebula config for the Node Template (list maxitems:1)

OpenstackConfig NodeTemplateOpenstackConfig

Openstack config for the Node Template (list maxitems:1)

UseInternalIpAddress bool

Engine storage driver for the node template (bool)

VsphereConfig NodeTemplateVsphereConfig

vSphere config for the Node Template (list maxitems:1)

amazonec2Config NodeTemplateAmazonec2Config

AWS config for the Node Template (list maxitems:1)

annotations {[key: string]: any}

Annotations for Node Template object (map)

authCertificateAuthority string

Auth certificate authority for the Node Template (string)

authKey string

Auth key for the Node Template (string)

azureConfig NodeTemplateAzureConfig

Azure config for the Node Template (list maxitems:1)

cloudCredentialId string

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

description string

Description for the Node Template (string)

digitaloceanConfig NodeTemplateDigitaloceanConfig

Digitalocean config for the Node Template (list maxitems:1)

driver string

(Computed) The driver of the node template (string)

driverId string

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

engineEnv {[key: string]: any}

Engine environment for the node template (string)

engineInsecureRegistries string[]

Insecure registry for the node template (list)

engineInstallUrl string

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

engineLabel {[key: string]: any}

Engine label for the node template (string)

engineOpt {[key: string]: any}

Engine options for the node template (map)

engineRegistryMirrors string[]

Engine registry mirror for the node template (list)

engineStorageDriver string

Engine storage driver for the node template (string)

hetznerConfig NodeTemplateHetznerConfig

Hetzner config for the Node Template (list maxitems:1)

labels {[key: string]: any}

Labels for Node Template object (map)

linodeConfig NodeTemplateLinodeConfig

Linode config for the Node Template (list maxitems:1)

name string

The name of the Node Template (string)

opennebulaConfig NodeTemplateOpennebulaConfig

Opennebula config for the Node Template (list maxitems:1)

openstackConfig NodeTemplateOpenstackConfig

Openstack config for the Node Template (list maxitems:1)

useInternalIpAddress boolean

Engine storage driver for the node template (bool)

vsphereConfig NodeTemplateVsphereConfig

vSphere config for the Node Template (list maxitems:1)

amazonec2_config NodeTemplateAmazonec2ConfigArgs

AWS config for the Node Template (list maxitems:1)

annotations Mapping[str, Any]

Annotations for Node Template object (map)

auth_certificate_authority str

Auth certificate authority for the Node Template (string)

auth_key str

Auth key for the Node Template (string)

azure_config NodeTemplateAzureConfigArgs

Azure config for the Node Template (list maxitems:1)

cloud_credential_id str

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

description str

Description for the Node Template (string)

digitalocean_config NodeTemplateDigitaloceanConfigArgs

Digitalocean config for the Node Template (list maxitems:1)

driver str

(Computed) The driver of the node template (string)

driver_id str

The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)

engine_env Mapping[str, Any]

Engine environment for the node template (string)

engine_insecure_registries Sequence[str]

Insecure registry for the node template (list)

engine_install_url str

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

engine_label Mapping[str, Any]

Engine label for the node template (string)

engine_opt Mapping[str, Any]

Engine options for the node template (map)

engine_registry_mirrors Sequence[str]

Engine registry mirror for the node template (list)

engine_storage_driver str

Engine storage driver for the node template (string)

hetzner_config NodeTemplateHetznerConfigArgs

Hetzner config for the Node Template (list maxitems:1)

labels Mapping[str, Any]

Labels for Node Template object (map)

linode_config NodeTemplateLinodeConfigArgs

Linode config for the Node Template (list maxitems:1)

name str

The name of the Node Template (string)

opennebula_config NodeTemplateOpennebulaConfigArgs

Opennebula config for the Node Template (list maxitems:1)

openstack_config NodeTemplateOpenstackConfigArgs

Openstack config for the Node Template (list maxitems:1)

use_internal_ip_address bool

Engine storage driver for the node template (bool)

vsphere_config NodeTemplateVsphereConfigArgs

vSphere config for the Node Template (list maxitems:1)

Supporting Types

NodeTemplateAmazonec2Config

Ami string

AWS machine image (string)

Region string

OpenStack region name (string)

SecurityGroups List<string>

AWS VPC security group. (list)

SubnetId string

AWS VPC subnet id (string)

VpcId string

AWS VPC id. (string)

Zone string

AWS zone for instance (i.e. a,b,c,d,e) (string)

AccessKey string

AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

BlockDurationMinutes string

AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)

DeviceName string

AWS root device name. Default /dev/sda1 (string)

EncryptEbsVolume bool

Encrypt EBS volume. Default false (bool)

Endpoint string

Optional endpoint URL (hostname only or fully qualified URI) (string)

IamInstanceProfile string

AWS IAM Instance Profile (string)

InsecureTransport bool

Disable SSL when sending requests (bool)

InstanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

KeypairName string

OpenStack keypair to use to SSH to the instance (string)

KmsKey string

Custom KMS key ID using the AWS Managed CMK (string)

Monitoring bool

Enable monitoring for droplet. Default false (bool)

OpenPorts List<string>

Make the specified port number accessible from the Internet. (list)

PrivateAddressOnly bool

Only use a private IP address. Default false (bool)

RequestSpotInstance bool

Set this flag to request spot instance. Default false (bool)

Retries string

Set retry count for recoverable failures (use -1 to disable). Default 5 (string)

RootSize string

AWS root disk size (in GB). Default 16 (string)

SecretKey string

AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

SecurityGroupReadonly bool

Skip adding default rules to security groups (bool)

SessionToken string

AWS Session Token (string)

SpotPrice string

AWS spot instance bid price (in dollar). Default 0.50 (string)

SshKeypath string

SSH Key for Instance (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

UseEbsOptimizedInstance bool

Create an EBS optimized instance. Default false (bool)

UsePrivateAddress bool

Force the usage of private IP address. Default false (bool)

Userdata string

Path to file with cloud-init user-data (string)

VolumeType string

Amazon EBS volume type. Default gp2 (string)

Ami string

AWS machine image (string)

Region string

OpenStack region name (string)

SecurityGroups []string

AWS VPC security group. (list)

SubnetId string

AWS VPC subnet id (string)

VpcId string

AWS VPC id. (string)

Zone string

AWS zone for instance (i.e. a,b,c,d,e) (string)

AccessKey string

AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

BlockDurationMinutes string

AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)

DeviceName string

AWS root device name. Default /dev/sda1 (string)

EncryptEbsVolume bool

Encrypt EBS volume. Default false (bool)

Endpoint string

Optional endpoint URL (hostname only or fully qualified URI) (string)

IamInstanceProfile string

AWS IAM Instance Profile (string)

InsecureTransport bool

Disable SSL when sending requests (bool)

InstanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

KeypairName string

OpenStack keypair to use to SSH to the instance (string)

KmsKey string

Custom KMS key ID using the AWS Managed CMK (string)

Monitoring bool

Enable monitoring for droplet. Default false (bool)

OpenPorts []string

Make the specified port number accessible from the Internet. (list)

PrivateAddressOnly bool

Only use a private IP address. Default false (bool)

RequestSpotInstance bool

Set this flag to request spot instance. Default false (bool)

Retries string

Set retry count for recoverable failures (use -1 to disable). Default 5 (string)

RootSize string

AWS root disk size (in GB). Default 16 (string)

SecretKey string

AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

SecurityGroupReadonly bool

Skip adding default rules to security groups (bool)

SessionToken string

AWS Session Token (string)

SpotPrice string

AWS spot instance bid price (in dollar). Default 0.50 (string)

SshKeypath string

SSH Key for Instance (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

UseEbsOptimizedInstance bool

Create an EBS optimized instance. Default false (bool)

UsePrivateAddress bool

Force the usage of private IP address. Default false (bool)

Userdata string

Path to file with cloud-init user-data (string)

VolumeType string

Amazon EBS volume type. Default gp2 (string)

ami string

AWS machine image (string)

region string

OpenStack region name (string)

securityGroups string[]

AWS VPC security group. (list)

subnetId string

AWS VPC subnet id (string)

vpcId string

AWS VPC id. (string)

zone string

AWS zone for instance (i.e. a,b,c,d,e) (string)

accessKey string

AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

blockDurationMinutes string

AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)

deviceName string

AWS root device name. Default /dev/sda1 (string)

encryptEbsVolume boolean

Encrypt EBS volume. Default false (bool)

endpoint string

Optional endpoint URL (hostname only or fully qualified URI) (string)

iamInstanceProfile string

AWS IAM Instance Profile (string)

insecureTransport boolean

Disable SSL when sending requests (bool)

instanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

keypairName string

OpenStack keypair to use to SSH to the instance (string)

kmsKey string

Custom KMS key ID using the AWS Managed CMK (string)

monitoring boolean

Enable monitoring for droplet. Default false (bool)

openPorts string[]

Make the specified port number accessible from the Internet. (list)

privateAddressOnly boolean

Only use a private IP address. Default false (bool)

requestSpotInstance boolean

Set this flag to request spot instance. Default false (bool)

retries string

Set retry count for recoverable failures (use -1 to disable). Default 5 (string)

rootSize string

AWS root disk size (in GB). Default 16 (string)

secretKey string

AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

securityGroupReadonly boolean

Skip adding default rules to security groups (bool)

sessionToken string

AWS Session Token (string)

spotPrice string

AWS spot instance bid price (in dollar). Default 0.50 (string)

sshKeypath string

SSH Key for Instance (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

useEbsOptimizedInstance boolean

Create an EBS optimized instance. Default false (bool)

usePrivateAddress boolean

Force the usage of private IP address. Default false (bool)

userdata string

Path to file with cloud-init user-data (string)

volumeType string

Amazon EBS volume type. Default gp2 (string)

ami str

AWS machine image (string)

region str

OpenStack region name (string)

security_groups Sequence[str]

AWS VPC security group. (list)

subnet_id str

AWS VPC subnet id (string)

vpc_id str

AWS VPC id. (string)

zone str

AWS zone for instance (i.e. a,b,c,d,e) (string)

access_key str

AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

block_duration_minutes str

AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)

device_name str

AWS root device name. Default /dev/sda1 (string)

encrypt_ebs_volume bool

Encrypt EBS volume. Default false (bool)

endpoint str

Optional endpoint URL (hostname only or fully qualified URI) (string)

iam_instance_profile str

AWS IAM Instance Profile (string)

insecure_transport bool

Disable SSL when sending requests (bool)

instance_type str

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

keypair_name str

OpenStack keypair to use to SSH to the instance (string)

kms_key str

Custom KMS key ID using the AWS Managed CMK (string)

monitoring bool

Enable monitoring for droplet. Default false (bool)

open_ports Sequence[str]

Make the specified port number accessible from the Internet. (list)

private_address_only bool

Only use a private IP address. Default false (bool)

request_spot_instance bool

Set this flag to request spot instance. Default false (bool)

retries str

Set retry count for recoverable failures (use -1 to disable). Default 5 (string)

root_size str

AWS root disk size (in GB). Default 16 (string)

secret_key str

AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

security_group_readonly bool

Skip adding default rules to security groups (bool)

session_token str

AWS Session Token (string)

spot_price str

AWS spot instance bid price (in dollar). Default 0.50 (string)

ssh_keypath str

SSH Key for Instance (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tags str

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

use_ebs_optimized_instance bool

Create an EBS optimized instance. Default false (bool)

use_private_address bool

Force the usage of private IP address. Default false (bool)

userdata str

Path to file with cloud-init user-data (string)

volume_type str

Amazon EBS volume type. Default gp2 (string)

NodeTemplateAzureConfig

AvailabilitySet string

Azure Availability Set to place the virtual machine into. Default docker-machine (string)

ClientId string

Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

ClientSecret string

Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

CustomData string

Path to file with custom-data (string)

DiskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

Dns string

A unique DNS label for the public IP adddress (string)

DockerPort string

Docker Port. Default 2376 (string)

Environment string

Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string)

FaultDomainCount string

Fault domain count to use for availability set. Default 3 (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Location string

Azure region to create the virtual machine. Default westus (string)

ManagedDisks bool

Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)

NoPublicIp bool

Do not create a public IP address for the machine. Default false (bool)

Nsg string

Azure Network Security Group to assign this node to (accepts either a name or resource ID, default is to create a new NSG for each machine). Default docker-machine-nsg (string)

OpenPorts List<string>

Make the specified port number accessible from the Internet. (list)

PrivateIpAddress string

Specify a static private IP address for the machine. (string)

ResourceGroup string

Azure Resource Group name (will be created if missing). Default docker-machine (string)

Size string

Digital Ocean size. Default s-1vcpu-1gb (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

StaticPublicIp bool

Assign a static public IP address to the machine. Default false (bool)

StorageType string

Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)

Subnet string

Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)

SubnetPrefix string

Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)

SubscriptionId string

Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

UpdateDomainCount string

Update domain count to use for availability set. Default 5 (string)

UsePrivateIp bool

Use private IP address of the machine to connect. Default false (bool)

Vnet string

Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

AvailabilitySet string

Azure Availability Set to place the virtual machine into. Default docker-machine (string)

ClientId string

Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

ClientSecret string

Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

CustomData string

Path to file with custom-data (string)

DiskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

Dns string

A unique DNS label for the public IP adddress (string)

DockerPort string

Docker Port. Default 2376 (string)

Environment string

Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string)

FaultDomainCount string

Fault domain count to use for availability set. Default 3 (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Location string

Azure region to create the virtual machine. Default westus (string)

ManagedDisks bool

Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)

NoPublicIp bool

Do not create a public IP address for the machine. Default false (bool)

Nsg string

Azure Network Security Group to assign this node to (accepts either a name or resource ID, default is to create a new NSG for each machine). Default docker-machine-nsg (string)

OpenPorts []string

Make the specified port number accessible from the Internet. (list)

PrivateIpAddress string

Specify a static private IP address for the machine. (string)

ResourceGroup string

Azure Resource Group name (will be created if missing). Default docker-machine (string)

Size string

Digital Ocean size. Default s-1vcpu-1gb (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

StaticPublicIp bool

Assign a static public IP address to the machine. Default false (bool)

StorageType string

Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)

Subnet string

Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)

SubnetPrefix string

Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)

SubscriptionId string

Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

UpdateDomainCount string

Update domain count to use for availability set. Default 5 (string)

UsePrivateIp bool

Use private IP address of the machine to connect. Default false (bool)

Vnet string

Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

availabilitySet string

Azure Availability Set to place the virtual machine into. Default docker-machine (string)

clientId string

Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

clientSecret string

Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

customData string

Path to file with custom-data (string)

diskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

dns string

A unique DNS label for the public IP adddress (string)

dockerPort string

Docker Port. Default 2376 (string)

environment string

Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string)

faultDomainCount string

Fault domain count to use for availability set. Default 3 (string)

image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

location string

Azure region to create the virtual machine. Default westus (string)

managedDisks boolean

Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)

noPublicIp boolean

Do not create a public IP address for the machine. Default false (bool)

nsg string

Azure Network Security Group to assign this node to (accepts either a name or resource ID, default is to create a new NSG for each machine). Default docker-machine-nsg (string)

openPorts string[]

Make the specified port number accessible from the Internet. (list)

privateIpAddress string

Specify a static private IP address for the machine. (string)

resourceGroup string

Azure Resource Group name (will be created if missing). Default docker-machine (string)

size string

Digital Ocean size. Default s-1vcpu-1gb (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

staticPublicIp boolean

Assign a static public IP address to the machine. Default false (bool)

storageType string

Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)

subnet string

Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)

subnetPrefix string

Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)

subscriptionId string

Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

updateDomainCount string

Update domain count to use for availability set. Default 5 (string)

usePrivateIp boolean

Use private IP address of the machine to connect. Default false (bool)

vnet string

Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

availability_set str

Azure Availability Set to place the virtual machine into. Default docker-machine (string)

client_id str

Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

client_secret str

Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

custom_data str

Path to file with custom-data (string)

disk_size str

vSphere size of disk for docker VM (in MB). Default 20480 (string)

dns str

A unique DNS label for the public IP adddress (string)

docker_port str

Docker Port. Default 2376 (string)

environment str

Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string)

fault_domain_count str

Fault domain count to use for availability set. Default 3 (string)

image str

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

location str

Azure region to create the virtual machine. Default westus (string)

managed_disks bool

Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)

no_public_ip bool

Do not create a public IP address for the machine. Default false (bool)

nsg str

Azure Network Security Group to assign this node to (accepts either a name or resource ID, default is to create a new NSG for each machine). Default docker-machine-nsg (string)

open_ports Sequence[str]

Make the specified port number accessible from the Internet. (list)

private_ip_address str

Specify a static private IP address for the machine. (string)

resource_group str

Azure Resource Group name (will be created if missing). Default docker-machine (string)

size str

Digital Ocean size. Default s-1vcpu-1gb (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

static_public_ip bool

Assign a static public IP address to the machine. Default false (bool)

storage_type str

Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)

subnet str

Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)

subnet_prefix str

Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)

subscription_id str

Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

update_domain_count str

Update domain count to use for availability set. Default 5 (string)

use_private_ip bool

Use private IP address of the machine to connect. Default false (bool)

vnet str

Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

NodeTemplateDigitaloceanConfig

AccessToken string

Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

Backups bool

Enable backups for droplet. Default false (bool)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Ipv6 bool

Enable ipv6 for droplet. Default false (bool)

Monitoring bool

Enable monitoring for droplet. Default false (bool)

PrivateNetworking bool

Enable private networking for droplet. Default false (bool)

Region string

OpenStack region name (string)

Size string

Digital Ocean size. Default s-1vcpu-1gb (string)

SshKeyFingerprint string

SSH key fingerprint (string)

SshKeyPath string

SSH private key path (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Userdata string

Path to file with cloud-init user-data (string)

AccessToken string

Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

Backups bool

Enable backups for droplet. Default false (bool)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Ipv6 bool

Enable ipv6 for droplet. Default false (bool)

Monitoring bool

Enable monitoring for droplet. Default false (bool)

PrivateNetworking bool

Enable private networking for droplet. Default false (bool)

Region string

OpenStack region name (string)

Size string

Digital Ocean size. Default s-1vcpu-1gb (string)

SshKeyFingerprint string

SSH key fingerprint (string)

SshKeyPath string

SSH private key path (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Userdata string

Path to file with cloud-init user-data (string)

accessToken string

Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

backups boolean

Enable backups for droplet. Default false (bool)

image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

ipv6 boolean

Enable ipv6 for droplet. Default false (bool)

monitoring boolean

Enable monitoring for droplet. Default false (bool)

privateNetworking boolean

Enable private networking for droplet. Default false (bool)

region string

OpenStack region name (string)

size string

Digital Ocean size. Default s-1vcpu-1gb (string)

sshKeyFingerprint string

SSH key fingerprint (string)

sshKeyPath string

SSH private key path (string)

sshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

userdata string

Path to file with cloud-init user-data (string)

access_token str

Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

backups bool

Enable backups for droplet. Default false (bool)

image str

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

ipv6 bool

Enable ipv6 for droplet. Default false (bool)

monitoring bool

Enable monitoring for droplet. Default false (bool)

private_networking bool

Enable private networking for droplet. Default false (bool)

region str

OpenStack region name (string)

size str

Digital Ocean size. Default s-1vcpu-1gb (string)

ssh_key_fingerprint str

SSH key fingerprint (string)

ssh_key_path str

SSH private key path (string)

ssh_port str

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tags str

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

userdata str

Path to file with cloud-init user-data (string)

NodeTemplateHetznerConfig

ApiToken string

Hetzner Cloud project API token (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Networks string

Comma-separated list of network IDs or names which should be attached to the server private network interface (string)

ServerLocation string

Hetzner Cloud datacenter. Default nbg1 (string)

ServerType string

Hetzner Cloud server type. Default cx11 (string)

UsePrivateNetworks bool

Use private network. Default false (bool)

Userdata string

Path to file with cloud-init user-data (string)

Volumes string

Comma-separated list of volume IDs or names which should be attached to the server (string)

ApiToken string

Hetzner Cloud project API token (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

Networks string

Comma-separated list of network IDs or names which should be attached to the server private network interface (string)

ServerLocation string

Hetzner Cloud datacenter. Default nbg1 (string)

ServerType string

Hetzner Cloud server type. Default cx11 (string)

UsePrivateNetworks bool

Use private network. Default false (bool)

Userdata string

Path to file with cloud-init user-data (string)

Volumes string

Comma-separated list of volume IDs or names which should be attached to the server (string)

apiToken string

Hetzner Cloud project API token (string)

image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

networks string

Comma-separated list of network IDs or names which should be attached to the server private network interface (string)

serverLocation string

Hetzner Cloud datacenter. Default nbg1 (string)

serverType string

Hetzner Cloud server type. Default cx11 (string)

usePrivateNetworks boolean

Use private network. Default false (bool)

userdata string

Path to file with cloud-init user-data (string)

volumes string

Comma-separated list of volume IDs or names which should be attached to the server (string)

api_token str

Hetzner Cloud project API token (string)

image str

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

networks str

Comma-separated list of network IDs or names which should be attached to the server private network interface (string)

server_location str

Hetzner Cloud datacenter. Default nbg1 (string)

server_type str

Hetzner Cloud server type. Default cx11 (string)

use_private_networks bool

Use private network. Default false (bool)

userdata str

Path to file with cloud-init user-data (string)

volumes str

Comma-separated list of volume IDs or names which should be attached to the server (string)

NodeTemplateLinodeConfig

AuthorizedUsers string

Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)

CreatePrivateIp bool

Create private IP for the instance. Default false (bool)

DockerPort string

Docker Port. Default 2376 (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

InstanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

Label string

Linode Instance Label. (string)

Region string

OpenStack region name (string)

RootPass string

Root Password (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Stackscript string

Specifies the Linode StackScript to use to create the instance. (string)

StackscriptData string

A JSON string specifying data for the selected StackScript. (string)

SwapSize string

Linode Instance Swap Size (MB). Default 512 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Token string

Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

UaPrefix string

Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

AuthorizedUsers string

Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)

CreatePrivateIp bool

Create private IP for the instance. Default false (bool)

DockerPort string

Docker Port. Default 2376 (string)

Image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

InstanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

Label string

Linode Instance Label. (string)

Region string

OpenStack region name (string)

RootPass string

Root Password (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

Stackscript string

Specifies the Linode StackScript to use to create the instance. (string)

StackscriptData string

A JSON string specifying data for the selected StackScript. (string)

SwapSize string

Linode Instance Swap Size (MB). Default 512 (string)

Tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Token string

Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

UaPrefix string

Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

authorizedUsers string

Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)

createPrivateIp boolean

Create private IP for the instance. Default false (bool)

dockerPort string

Docker Port. Default 2376 (string)

image string

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

instanceType string

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

label string

Linode Instance Label. (string)

region string

OpenStack region name (string)

rootPass string

Root Password (string)

sshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

stackscript string

Specifies the Linode StackScript to use to create the instance. (string)

stackscriptData string

A JSON string specifying data for the selected StackScript. (string)

swapSize string

Linode Instance Swap Size (MB). Default 512 (string)

tags string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

token string

Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

uaPrefix string

Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

authorized_users str

Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)

create_private_ip bool

Create private IP for the instance. Default false (bool)

docker_port str

Docker Port. Default 2376 (string)

image str

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

instance_type str

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

label str

Linode Instance Label. (string)

region str

OpenStack region name (string)

root_pass str

Root Password (string)

ssh_port str

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

stackscript str

Specifies the Linode StackScript to use to create the instance. (string)

stackscript_data str

A JSON string specifying data for the selected StackScript. (string)

swap_size str

Linode Instance Swap Size (MB). Default 512 (string)

tags str

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

token str

Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

ua_prefix str

Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

NodeTemplateOpennebulaConfig

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

User string

Set the user for the XML-RPC API authentication (string)

XmlRpcUrl string

Set the url for the Opennebula XML-RPC API (string)

B2dSize string

Size of the Volatile disk in MB - only for b2d (string)

Cpu string

CPU value for the VM (string)

DevPrefix string

Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)

DisableVnc bool

VNC is enabled by default. Disable it with this flag (bool)

DiskResize string

Size of the disk for the VM in MB (string)

ImageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

ImageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

ImageOwner string

Owner of the image to use as the VM OS (string)

Memory string

Size of the memory for the VM in MB (string)

NetworkId string

Opennebula network ID to connect the machine to. Conflicts with network_name (string)

NetworkName string

Opennebula network to connect the machine to. Conflicts with network_id (string)

NetworkOwner string

Opennebula user ID of the Network to connect the machine to (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

TemplateId string

Opennebula template ID to use. Conflicts with template_name (string)

TemplateName string

Name of the Opennbula template to use. Conflicts with template_id (string)

Vcpu string

VCPUs for the VM (string)

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

User string

Set the user for the XML-RPC API authentication (string)

XmlRpcUrl string

Set the url for the Opennebula XML-RPC API (string)

B2dSize string

Size of the Volatile disk in MB - only for b2d (string)

Cpu string

CPU value for the VM (string)

DevPrefix string

Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)

DisableVnc bool

VNC is enabled by default. Disable it with this flag (bool)

DiskResize string

Size of the disk for the VM in MB (string)

ImageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

ImageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

ImageOwner string

Owner of the image to use as the VM OS (string)

Memory string

Size of the memory for the VM in MB (string)

NetworkId string

Opennebula network ID to connect the machine to. Conflicts with network_name (string)

NetworkName string

Opennebula network to connect the machine to. Conflicts with network_id (string)

NetworkOwner string

Opennebula user ID of the Network to connect the machine to (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

TemplateId string

Opennebula template ID to use. Conflicts with template_name (string)

TemplateName string

Name of the Opennbula template to use. Conflicts with template_id (string)

Vcpu string

VCPUs for the VM (string)

password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

user string

Set the user for the XML-RPC API authentication (string)

xmlRpcUrl string

Set the url for the Opennebula XML-RPC API (string)

b2dSize string

Size of the Volatile disk in MB - only for b2d (string)

cpu string

CPU value for the VM (string)

devPrefix string

Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)

disableVnc boolean

VNC is enabled by default. Disable it with this flag (bool)

diskResize string

Size of the disk for the VM in MB (string)

imageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

imageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

imageOwner string

Owner of the image to use as the VM OS (string)

memory string

Size of the memory for the VM in MB (string)

networkId string

Opennebula network ID to connect the machine to. Conflicts with network_name (string)

networkName string

Opennebula network to connect the machine to. Conflicts with network_id (string)

networkOwner string

Opennebula user ID of the Network to connect the machine to (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

templateId string

Opennebula template ID to use. Conflicts with template_name (string)

templateName string

Name of the Opennbula template to use. Conflicts with template_id (string)

vcpu string

VCPUs for the VM (string)

password str

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

user str

Set the user for the XML-RPC API authentication (string)

xml_rpc_url str

Set the url for the Opennebula XML-RPC API (string)

b2d_size str

Size of the Volatile disk in MB - only for b2d (string)

cpu str

CPU value for the VM (string)

dev_prefix str

Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)

disable_vnc bool

VNC is enabled by default. Disable it with this flag (bool)

disk_resize str

Size of the disk for the VM in MB (string)

image_id str

OpenStack image id to use for the instance. Conflicts with image_name (string)

image_name str

OpenStack image name to use for the instance. Conflicts with image_id (string)

image_owner str

Owner of the image to use as the VM OS (string)

memory str

Size of the memory for the VM in MB (string)

network_id str

Opennebula network ID to connect the machine to. Conflicts with network_name (string)

network_name str

Opennebula network to connect the machine to. Conflicts with network_id (string)

network_owner str

Opennebula user ID of the Network to connect the machine to (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

template_id str

Opennebula template ID to use. Conflicts with template_name (string)

template_name str

Name of the Opennbula template to use. Conflicts with template_id (string)

vcpu str

VCPUs for the VM (string)

NodeTemplateOpenstackConfig

AuthUrl string

OpenStack authentication URL (string)

AvailabilityZone string

OpenStack availability zone (string)

Region string

OpenStack region name (string)

ActiveTimeout string

OpenStack active timeout Default 200 (string)

ApplicationCredentialId string

OpenStack application credential id. Conflicts with application_credential_name (string)

ApplicationCredentialName string

OpenStack application credential name. Conflicts with application_credential_id (string)

ApplicationCredentialSecret string

OpenStack application credential secret (string)

Cacert string

CA certificate bundle to verify against (string)

ConfigDrive bool

Enables the OpenStack config drive for the instance. Default false (bool)

DomainId string

OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)

DomainName string

OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)

EndpointType string

OpenStack endpoint type. adminURL, internalURL or publicURL (string)

FlavorId string

OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)

FlavorName string

OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)

FloatingIpPool string

OpenStack floating IP pool to get an IP from to assign to the instance (string)

ImageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

ImageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

Insecure bool

Disable TLS credential checking. Default false (bool)

IpVersion string

OpenStack version of IP address assigned for the machine Default 4 (string)

KeypairName string

OpenStack keypair to use to SSH to the instance (string)

NetId string

OpenStack network id the machine will be connected on. Conflicts with net_name (string)

NetName string

OpenStack network name the machine will be connected on. Conflicts with net_id (string)

NovaNetwork bool

Use the nova networking services instead of neutron (string)

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

PrivateKeyFile string

Private key content to use for SSH (string)

SecGroups string

OpenStack comma separated security groups for the machine (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

TenantId string

OpenStack tenant id. Conflicts with tenant_name (string)

TenantName string

OpenStack tenant name. Conflicts with tenant_id (string)

UserDataFile string

File containing an openstack userdata script (string)

Username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

AuthUrl string

OpenStack authentication URL (string)

AvailabilityZone string

OpenStack availability zone (string)

Region string

OpenStack region name (string)

ActiveTimeout string

OpenStack active timeout Default 200 (string)

ApplicationCredentialId string

OpenStack application credential id. Conflicts with application_credential_name (string)

ApplicationCredentialName string

OpenStack application credential name. Conflicts with application_credential_id (string)

ApplicationCredentialSecret string

OpenStack application credential secret (string)

Cacert string

CA certificate bundle to verify against (string)

ConfigDrive bool

Enables the OpenStack config drive for the instance. Default false (bool)

DomainId string

OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)

DomainName string

OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)

EndpointType string

OpenStack endpoint type. adminURL, internalURL or publicURL (string)

FlavorId string

OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)

FlavorName string

OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)

FloatingIpPool string

OpenStack floating IP pool to get an IP from to assign to the instance (string)

ImageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

ImageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

Insecure bool

Disable TLS credential checking. Default false (bool)

IpVersion string

OpenStack version of IP address assigned for the machine Default 4 (string)

KeypairName string

OpenStack keypair to use to SSH to the instance (string)

NetId string

OpenStack network id the machine will be connected on. Conflicts with net_name (string)

NetName string

OpenStack network name the machine will be connected on. Conflicts with net_id (string)

NovaNetwork bool

Use the nova networking services instead of neutron (string)

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

PrivateKeyFile string

Private key content to use for SSH (string)

SecGroups string

OpenStack comma separated security groups for the machine (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

TenantId string

OpenStack tenant id. Conflicts with tenant_name (string)

TenantName string

OpenStack tenant name. Conflicts with tenant_id (string)

UserDataFile string

File containing an openstack userdata script (string)

Username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

authUrl string

OpenStack authentication URL (string)

availabilityZone string

OpenStack availability zone (string)

region string

OpenStack region name (string)

activeTimeout string

OpenStack active timeout Default 200 (string)

applicationCredentialId string

OpenStack application credential id. Conflicts with application_credential_name (string)

applicationCredentialName string

OpenStack application credential name. Conflicts with application_credential_id (string)

applicationCredentialSecret string

OpenStack application credential secret (string)

cacert string

CA certificate bundle to verify against (string)

configDrive boolean

Enables the OpenStack config drive for the instance. Default false (bool)

domainId string

OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)

domainName string

OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)

endpointType string

OpenStack endpoint type. adminURL, internalURL or publicURL (string)

flavorId string

OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)

flavorName string

OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)

floatingIpPool string

OpenStack floating IP pool to get an IP from to assign to the instance (string)

imageId string

OpenStack image id to use for the instance. Conflicts with image_name (string)

imageName string

OpenStack image name to use for the instance. Conflicts with image_id (string)

insecure boolean

Disable TLS credential checking. Default false (bool)

ipVersion string

OpenStack version of IP address assigned for the machine Default 4 (string)

keypairName string

OpenStack keypair to use to SSH to the instance (string)

netId string

OpenStack network id the machine will be connected on. Conflicts with net_name (string)

netName string

OpenStack network name the machine will be connected on. Conflicts with net_id (string)

novaNetwork boolean

Use the nova networking services instead of neutron (string)

password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

privateKeyFile string

Private key content to use for SSH (string)

secGroups string

OpenStack comma separated security groups for the machine (string)

sshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tenantId string

OpenStack tenant id. Conflicts with tenant_name (string)

tenantName string

OpenStack tenant name. Conflicts with tenant_id (string)

userDataFile string

File containing an openstack userdata script (string)

username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

auth_url str

OpenStack authentication URL (string)

availability_zone str

OpenStack availability zone (string)

region str

OpenStack region name (string)

active_timeout str

OpenStack active timeout Default 200 (string)

application_credential_id str

OpenStack application credential id. Conflicts with application_credential_name (string)

application_credential_name str

OpenStack application credential name. Conflicts with application_credential_id (string)

application_credential_secret str

OpenStack application credential secret (string)

cacert str

CA certificate bundle to verify against (string)

config_drive bool

Enables the OpenStack config drive for the instance. Default false (bool)

domain_id str

OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)

domain_name str

OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)

endpoint_type str

OpenStack endpoint type. adminURL, internalURL or publicURL (string)

flavor_id str

OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)

flavor_name str

OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)

floating_ip_pool str

OpenStack floating IP pool to get an IP from to assign to the instance (string)

image_id str

OpenStack image id to use for the instance. Conflicts with image_name (string)

image_name str

OpenStack image name to use for the instance. Conflicts with image_id (string)

insecure bool

Disable TLS credential checking. Default false (bool)

ip_version str

OpenStack version of IP address assigned for the machine Default 4 (string)

keypair_name str

OpenStack keypair to use to SSH to the instance (string)

net_id str

OpenStack network id the machine will be connected on. Conflicts with net_name (string)

net_name str

OpenStack network name the machine will be connected on. Conflicts with net_id (string)

nova_network bool

Use the nova networking services instead of neutron (string)

password str

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

private_key_file str

Private key content to use for SSH (string)

sec_groups str

OpenStack comma separated security groups for the machine (string)

ssh_port str

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

tenant_id str

OpenStack tenant id. Conflicts with tenant_name (string)

tenant_name str

OpenStack tenant name. Conflicts with tenant_id (string)

user_data_file str

File containing an openstack userdata script (string)

username str

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

NodeTemplateVsphereConfig

Boot2dockerUrl string

vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)

Cfgparams List<string>

vSphere vm configuration parameters (used for guestinfo) (list)

CloneFrom string

If you choose creation type vm (clone vm) a name of what vm you want to clone is required. From Rancher v2.3.3 (string)

CloudConfig string

Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)

Cloudinit string

vSphere cloud-init file or url to set in the guestinfo (string)

ContentLibrary string

If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)

CpuCount string

vSphere CPU number for docker VM. Default 2 (string)

CreationType string

Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)

CustomAttributes List<string>

vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)

Datacenter string

vSphere datacenter for docker VM (string)

Datastore string

vSphere datastore for docker VM (string)

DatastoreCluster string

vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)

DiskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

Folder string

vSphere folder for the docker VM. This folder must already exist in the datacenter (string)

Hostsystem string

vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)

MemorySize string

vSphere size of memory for docker VM (in MB). Default 2048 (string)

Networks List<string>

vSphere network where the docker VM will be attached (list)

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

Pool string

vSphere resource pool for docker VM (string)

SshPassword string

If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

SshUserGroup string

If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)

Tags List<string>

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

VappIpAllocationPolicy string

vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)

VappIpProtocol string

vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)

VappProperties List<string>

vSphere vApp properties (list)

VappTransport string

vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)

Vcenter string

vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

VcenterPort string

vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x. Default 443 (string)

Boot2dockerUrl string

vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)

Cfgparams []string

vSphere vm configuration parameters (used for guestinfo) (list)

CloneFrom string

If you choose creation type vm (clone vm) a name of what vm you want to clone is required. From Rancher v2.3.3 (string)

CloudConfig string

Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)

Cloudinit string

vSphere cloud-init file or url to set in the guestinfo (string)

ContentLibrary string

If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)

CpuCount string

vSphere CPU number for docker VM. Default 2 (string)

CreationType string

Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)

CustomAttributes []string

vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)

Datacenter string

vSphere datacenter for docker VM (string)

Datastore string

vSphere datastore for docker VM (string)

DatastoreCluster string

vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)

DiskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

Folder string

vSphere folder for the docker VM. This folder must already exist in the datacenter (string)

Hostsystem string

vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)

MemorySize string

vSphere size of memory for docker VM (in MB). Default 2048 (string)

Networks []string

vSphere network where the docker VM will be attached (list)

Password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

Pool string

vSphere resource pool for docker VM (string)

SshPassword string

If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)

SshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

SshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

SshUserGroup string

If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)

Tags []string

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

Username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

VappIpAllocationPolicy string

vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)

VappIpProtocol string

vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)

VappProperties []string

vSphere vApp properties (list)

VappTransport string

vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)

Vcenter string

vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

VcenterPort string

vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x. Default 443 (string)

boot2dockerUrl string

vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)

cfgparams string[]

vSphere vm configuration parameters (used for guestinfo) (list)

cloneFrom string

If you choose creation type vm (clone vm) a name of what vm you want to clone is required. From Rancher v2.3.3 (string)

cloudConfig string

Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)

cloudinit string

vSphere cloud-init file or url to set in the guestinfo (string)

contentLibrary string

If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)

cpuCount string

vSphere CPU number for docker VM. Default 2 (string)

creationType string

Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)

customAttributes string[]

vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)

datacenter string

vSphere datacenter for docker VM (string)

datastore string

vSphere datastore for docker VM (string)

datastoreCluster string

vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)

diskSize string

vSphere size of disk for docker VM (in MB). Default 20480 (string)

folder string

vSphere folder for the docker VM. This folder must already exist in the datacenter (string)

hostsystem string

vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)

memorySize string

vSphere size of memory for docker VM (in MB). Default 2048 (string)

networks string[]

vSphere network where the docker VM will be attached (list)

password string

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

pool string

vSphere resource pool for docker VM (string)

sshPassword string

If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)

sshPort string

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

sshUser string

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

sshUserGroup string

If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)

tags string[]

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

username string

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

vappIpAllocationPolicy string

vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)

vappIpProtocol string

vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)

vappProperties string[]

vSphere vApp properties (list)

vappTransport string

vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)

vcenter string

vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

vcenterPort string

vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x. Default 443 (string)

boot2docker_url str

vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)

cfgparams Sequence[str]

vSphere vm configuration parameters (used for guestinfo) (list)

clone_from str

If you choose creation type vm (clone vm) a name of what vm you want to clone is required. From Rancher v2.3.3 (string)

cloud_config str

Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)

cloudinit str

vSphere cloud-init file or url to set in the guestinfo (string)

content_library str

If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)

cpu_count str

vSphere CPU number for docker VM. Default 2 (string)

creation_type str

Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)

custom_attributes Sequence[str]

vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)

datacenter str

vSphere datacenter for docker VM (string)

datastore str

vSphere datastore for docker VM (string)

datastore_cluster str

vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)

disk_size str

vSphere size of disk for docker VM (in MB). Default 20480 (string)

folder str

vSphere folder for the docker VM. This folder must already exist in the datacenter (string)

hostsystem str

vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)

memory_size str

vSphere size of memory for docker VM (in MB). Default 2048 (string)

networks Sequence[str]

vSphere network where the docker VM will be attached (list)

password str

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

pool str

vSphere resource pool for docker VM (string)

ssh_password str

If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)

ssh_port str

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

ssh_user str

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

ssh_user_group str

If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)

tags Sequence[str]

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

username str

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

vapp_ip_allocation_policy str

vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)

vapp_ip_protocol str

vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)

vapp_properties Sequence[str]

vSphere vApp properties (list)

vapp_transport str

vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)

vcenter str

vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)

vcenter_port str

vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x. Default 443 (string)

Import

Node Template can be imported using the Rancher Node Template ID

 $ pulumi import rancher2:index/nodeTemplate:NodeTemplate foo &lt;node_template_id&gt;

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.