1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. NodeTemplate
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi

rancher2.NodeTemplate

Explore with Pulumi AI

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, harvester, linode, opennebula, openstack, outscale, 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

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", {
    name: "foo",
    description: "foo test",
    amazonec2Config: {
        accessKey: "AWS_ACCESS_KEY",
        secretKey: "<AWS_SECRET_KEY>",
        ami: "<AMI_ID>",
        region: "<REGION>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Template up to Rancher 2.1.x
foo = rancher2.NodeTemplate("foo",
    name="foo",
    description="foo test",
    amazonec2_config={
        "access_key": "AWS_ACCESS_KEY",
        "secret_key": "<AWS_SECRET_KEY>",
        "ami": "<AMI_ID>",
        "region": "<REGION>",
        "security_groups": ["<AWS_SECURITY_GROUP>"],
        "subnet_id": "<SUBNET_ID>",
        "vpc_id": "<VPC_ID>",
        "zone": "<ZONE>",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Node Template up to Rancher 2.1.x
		_, err := rancher2.NewNodeTemplate(ctx, "foo", &rancher2.NodeTemplateArgs{
			Name:        pulumi.String("foo"),
			Description: pulumi.String("foo test"),
			Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
				AccessKey: pulumi.String("AWS_ACCESS_KEY"),
				SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
				Ami:       pulumi.String("<AMI_ID>"),
				Region:    pulumi.String("<REGION>"),
				SecurityGroups: pulumi.StringArray{
					pulumi.String("<AWS_SECURITY_GROUP>"),
				},
				SubnetId: pulumi.String("<SUBNET_ID>"),
				VpcId:    pulumi.String("<VPC_ID>"),
				Zone:     pulumi.String("<ZONE>"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Node Template up to Rancher 2.1.x
    var foo = new Rancher2.NodeTemplate("foo", new()
    {
        Name = "foo",
        Description = "foo test",
        Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
        {
            AccessKey = "AWS_ACCESS_KEY",
            SecretKey = "<AWS_SECRET_KEY>",
            Ami = "<AMI_ID>",
            Region = "<REGION>",
            SecurityGroups = new[]
            {
                "<AWS_SECURITY_GROUP>",
            },
            SubnetId = "<SUBNET_ID>",
            VpcId = "<VPC_ID>",
            Zone = "<ZONE>",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.NodeTemplate;
import com.pulumi.rancher2.NodeTemplateArgs;
import com.pulumi.rancher2.inputs.NodeTemplateAmazonec2ConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 Node Template up to Rancher 2.1.x
        var foo = new NodeTemplate("foo", NodeTemplateArgs.builder()
            .name("foo")
            .description("foo test")
            .amazonec2Config(NodeTemplateAmazonec2ConfigArgs.builder()
                .accessKey("AWS_ACCESS_KEY")
                .secretKey("<AWS_SECRET_KEY>")
                .ami("<AMI_ID>")
                .region("<REGION>")
                .securityGroups("<AWS_SECURITY_GROUP>")
                .subnetId("<SUBNET_ID>")
                .vpcId("<VPC_ID>")
                .zone("<ZONE>")
                .build())
            .build());

    }
}
Copy
resources:
  # Create a new rancher2 Node Template up to Rancher 2.1.x
  foo:
    type: rancher2:NodeTemplate
    properties:
      name: foo
      description: foo test
      amazonec2Config:
        accessKey: AWS_ACCESS_KEY
        secretKey: <AWS_SECRET_KEY>
        ami: <AMI_ID>
        region: <REGION>
        securityGroups:
          - <AWS_SECURITY_GROUP>
        subnetId: <SUBNET_ID>
        vpcId: <VPC_ID>
        zone: <ZONE>
Copy
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Template from Rancher 2.2.x
const foo = new rancher2.CloudCredential("foo", {
    name: "foo",
    description: "foo test",
    amazonec2CredentialConfig: {
        accessKey: "<AWS_ACCESS_KEY>",
        secretKey: "<AWS_SECRET_KEY>",
    },
});
const fooNodeTemplate = new rancher2.NodeTemplate("foo", {
    name: "foo",
    description: "foo test",
    cloudCredentialId: foo.id,
    amazonec2Config: {
        ami: "<AMI_ID>",
        region: "<REGION>",
        securityGroups: ["<AWS_SECURITY_GROUP>"],
        subnetId: "<SUBNET_ID>",
        vpcId: "<VPC_ID>",
        zone: "<ZONE>",
    },
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Template from Rancher 2.2.x
foo = rancher2.CloudCredential("foo",
    name="foo",
    description="foo test",
    amazonec2_credential_config={
        "access_key": "<AWS_ACCESS_KEY>",
        "secret_key": "<AWS_SECRET_KEY>",
    })
foo_node_template = rancher2.NodeTemplate("foo",
    name="foo",
    description="foo test",
    cloud_credential_id=foo.id,
    amazonec2_config={
        "ami": "<AMI_ID>",
        "region": "<REGION>",
        "security_groups": ["<AWS_SECURITY_GROUP>"],
        "subnet_id": "<SUBNET_ID>",
        "vpc_id": "<VPC_ID>",
        "zone": "<ZONE>",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Node Template from Rancher 2.2.x
		foo, err := rancher2.NewCloudCredential(ctx, "foo", &rancher2.CloudCredentialArgs{
			Name:        pulumi.String("foo"),
			Description: pulumi.String("foo test"),
			Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
				AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
				SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rancher2.NewNodeTemplate(ctx, "foo", &rancher2.NodeTemplateArgs{
			Name:              pulumi.String("foo"),
			Description:       pulumi.String("foo test"),
			CloudCredentialId: foo.ID(),
			Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
				Ami:    pulumi.String("<AMI_ID>"),
				Region: pulumi.String("<REGION>"),
				SecurityGroups: pulumi.StringArray{
					pulumi.String("<AWS_SECURITY_GROUP>"),
				},
				SubnetId: pulumi.String("<SUBNET_ID>"),
				VpcId:    pulumi.String("<VPC_ID>"),
				Zone:     pulumi.String("<ZONE>"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Node Template from Rancher 2.2.x
    var foo = new Rancher2.CloudCredential("foo", new()
    {
        Name = "foo",
        Description = "foo test",
        Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
        {
            AccessKey = "<AWS_ACCESS_KEY>",
            SecretKey = "<AWS_SECRET_KEY>",
        },
    });

    var fooNodeTemplate = new Rancher2.NodeTemplate("foo", new()
    {
        Name = "foo",
        Description = "foo test",
        CloudCredentialId = foo.Id,
        Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
        {
            Ami = "<AMI_ID>",
            Region = "<REGION>",
            SecurityGroups = new[]
            {
                "<AWS_SECURITY_GROUP>",
            },
            SubnetId = "<SUBNET_ID>",
            VpcId = "<VPC_ID>",
            Zone = "<ZONE>",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.CloudCredential;
import com.pulumi.rancher2.CloudCredentialArgs;
import com.pulumi.rancher2.inputs.CloudCredentialAmazonec2CredentialConfigArgs;
import com.pulumi.rancher2.NodeTemplate;
import com.pulumi.rancher2.NodeTemplateArgs;
import com.pulumi.rancher2.inputs.NodeTemplateAmazonec2ConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 Node Template from Rancher 2.2.x
        var foo = new CloudCredential("foo", CloudCredentialArgs.builder()
            .name("foo")
            .description("foo test")
            .amazonec2CredentialConfig(CloudCredentialAmazonec2CredentialConfigArgs.builder()
                .accessKey("<AWS_ACCESS_KEY>")
                .secretKey("<AWS_SECRET_KEY>")
                .build())
            .build());

        var fooNodeTemplate = new NodeTemplate("fooNodeTemplate", NodeTemplateArgs.builder()
            .name("foo")
            .description("foo test")
            .cloudCredentialId(foo.id())
            .amazonec2Config(NodeTemplateAmazonec2ConfigArgs.builder()
                .ami("<AMI_ID>")
                .region("<REGION>")
                .securityGroups("<AWS_SECURITY_GROUP>")
                .subnetId("<SUBNET_ID>")
                .vpcId("<VPC_ID>")
                .zone("<ZONE>")
                .build())
            .build());

    }
}
Copy
resources:
  # Create a new rancher2 Node Template from Rancher 2.2.x
  foo:
    type: rancher2:CloudCredential
    properties:
      name: foo
      description: foo test
      amazonec2CredentialConfig:
        accessKey: <AWS_ACCESS_KEY>
        secretKey: <AWS_SECRET_KEY>
  fooNodeTemplate:
    type: rancher2:NodeTemplate
    name: foo
    properties:
      name: foo
      description: foo test
      cloudCredentialId: ${foo.id}
      amazonec2Config:
        ami: <AMI_ID>
        region: <REGION>
        securityGroups:
          - <AWS_SECURITY_GROUP>
        subnetId: <SUBNET_ID>
        vpcId: <VPC_ID>
        zone: <ZONE>
Copy

Using the Harvester Node Driver

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Get imported harvester cluster info
const foo_harvester = rancher2.getClusterV2({
    name: "foo-harvester",
});
// Create a new Cloud Credential for an imported Harvester cluster
const foo_harvesterCloudCredential = new rancher2.CloudCredential("foo-harvester", {
    name: "foo-harvester",
    harvesterCredentialConfig: {
        clusterId: foo_harvester.then(foo_harvester => foo_harvester.clusterV1Id),
        clusterType: "imported",
        kubeconfigContent: foo_harvester.then(foo_harvester => foo_harvester.kubeConfig),
    },
});
// Create a new rancher2 Node Template using harvester node_driver
const foo_harvesterNodeTemplate = new rancher2.NodeTemplate("foo-harvester", {
    name: "foo-harvester",
    cloudCredentialId: foo_harvesterCloudCredential.id,
    engineInstallUrl: "https://releases.rancher.com/install-docker/20.10.sh",
    harvesterConfig: {
        vmNamespace: "default",
        cpuCount: "2",
        memorySize: "4",
        diskInfo: `    {
        "disks": [{
            "imageName": "harvester-public/image-57hzg",
            "size": 40,
            "bootOrder": 1
        }]
    }
`,
        networkInfo: `    {
        "interfaces": [{
            "networkName": "harvester-public/vlan1"
        }]
    }
`,
        sshUser: "ubuntu",
        userData: `    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
`,
    },
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Get imported harvester cluster info
foo_harvester = rancher2.get_cluster_v2(name="foo-harvester")
# Create a new Cloud Credential for an imported Harvester cluster
foo_harvester_cloud_credential = rancher2.CloudCredential("foo-harvester",
    name="foo-harvester",
    harvester_credential_config={
        "cluster_id": foo_harvester.cluster_v1_id,
        "cluster_type": "imported",
        "kubeconfig_content": foo_harvester.kube_config,
    })
# Create a new rancher2 Node Template using harvester node_driver
foo_harvester_node_template = rancher2.NodeTemplate("foo-harvester",
    name="foo-harvester",
    cloud_credential_id=foo_harvester_cloud_credential.id,
    engine_install_url="https://releases.rancher.com/install-docker/20.10.sh",
    harvester_config={
        "vm_namespace": "default",
        "cpu_count": "2",
        "memory_size": "4",
        "disk_info": """    {
        "disks": [{
            "imageName": "harvester-public/image-57hzg",
            "size": 40,
            "bootOrder": 1
        }]
    }
""",
        "network_info": """    {
        "interfaces": [{
            "networkName": "harvester-public/vlan1"
        }]
    }
""",
        "ssh_user": "ubuntu",
        "user_data": """    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
""",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get imported harvester cluster info
		foo_harvester, err := rancher2.LookupClusterV2(ctx, &rancher2.LookupClusterV2Args{
			Name: "foo-harvester",
		}, nil)
		if err != nil {
			return err
		}
		// Create a new Cloud Credential for an imported Harvester cluster
		foo_harvesterCloudCredential, err := rancher2.NewCloudCredential(ctx, "foo-harvester", &rancher2.CloudCredentialArgs{
			Name: pulumi.String("foo-harvester"),
			HarvesterCredentialConfig: &rancher2.CloudCredentialHarvesterCredentialConfigArgs{
				ClusterId:         pulumi.String(foo_harvester.ClusterV1Id),
				ClusterType:       pulumi.String("imported"),
				KubeconfigContent: pulumi.String(foo_harvester.KubeConfig),
			},
		})
		if err != nil {
			return err
		}
		// Create a new rancher2 Node Template using harvester node_driver
		_, err = rancher2.NewNodeTemplate(ctx, "foo-harvester", &rancher2.NodeTemplateArgs{
			Name:              pulumi.String("foo-harvester"),
			CloudCredentialId: foo_harvesterCloudCredential.ID(),
			EngineInstallUrl:  pulumi.String("https://releases.rancher.com/install-docker/20.10.sh"),
			HarvesterConfig: &rancher2.NodeTemplateHarvesterConfigArgs{
				VmNamespace: pulumi.String("default"),
				CpuCount:    pulumi.String("2"),
				MemorySize:  pulumi.String("4"),
				DiskInfo: pulumi.String(`    {
        "disks": [{
            "imageName": "harvester-public/image-57hzg",
            "size": 40,
            "bootOrder": 1
        }]
    }
`),
				NetworkInfo: pulumi.String(`    {
        "interfaces": [{
            "networkName": "harvester-public/vlan1"
        }]
    }
`),
				SshUser: pulumi.String("ubuntu"),
				UserData: pulumi.String(`    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
`),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Get imported harvester cluster info
    var foo_harvester = Rancher2.GetClusterV2.Invoke(new()
    {
        Name = "foo-harvester",
    });

    // Create a new Cloud Credential for an imported Harvester cluster
    var foo_harvesterCloudCredential = new Rancher2.CloudCredential("foo-harvester", new()
    {
        Name = "foo-harvester",
        HarvesterCredentialConfig = new Rancher2.Inputs.CloudCredentialHarvesterCredentialConfigArgs
        {
            ClusterId = foo_harvester.Apply(foo_harvester => foo_harvester.Apply(getClusterV2Result => getClusterV2Result.ClusterV1Id)),
            ClusterType = "imported",
            KubeconfigContent = foo_harvester.Apply(foo_harvester => foo_harvester.Apply(getClusterV2Result => getClusterV2Result.KubeConfig)),
        },
    });

    // Create a new rancher2 Node Template using harvester node_driver
    var foo_harvesterNodeTemplate = new Rancher2.NodeTemplate("foo-harvester", new()
    {
        Name = "foo-harvester",
        CloudCredentialId = foo_harvesterCloudCredential.Id,
        EngineInstallUrl = "https://releases.rancher.com/install-docker/20.10.sh",
        HarvesterConfig = new Rancher2.Inputs.NodeTemplateHarvesterConfigArgs
        {
            VmNamespace = "default",
            CpuCount = "2",
            MemorySize = "4",
            DiskInfo = @"    {
        ""disks"": [{
            ""imageName"": ""harvester-public/image-57hzg"",
            ""size"": 40,
            ""bootOrder"": 1
        }]
    }
",
            NetworkInfo = @"    {
        ""interfaces"": [{
            ""networkName"": ""harvester-public/vlan1""
        }]
    }
",
            SshUser = "ubuntu",
            UserData = @"    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Rancher2Functions;
import com.pulumi.rancher2.inputs.GetClusterV2Args;
import com.pulumi.rancher2.CloudCredential;
import com.pulumi.rancher2.CloudCredentialArgs;
import com.pulumi.rancher2.inputs.CloudCredentialHarvesterCredentialConfigArgs;
import com.pulumi.rancher2.NodeTemplate;
import com.pulumi.rancher2.NodeTemplateArgs;
import com.pulumi.rancher2.inputs.NodeTemplateHarvesterConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Get imported harvester cluster info
        final var foo-harvester = Rancher2Functions.getClusterV2(GetClusterV2Args.builder()
            .name("foo-harvester")
            .build());

        // Create a new Cloud Credential for an imported Harvester cluster
        var foo_harvesterCloudCredential = new CloudCredential("foo-harvesterCloudCredential", CloudCredentialArgs.builder()
            .name("foo-harvester")
            .harvesterCredentialConfig(CloudCredentialHarvesterCredentialConfigArgs.builder()
                .clusterId(foo_harvester.clusterV1Id())
                .clusterType("imported")
                .kubeconfigContent(foo_harvester.kubeConfig())
                .build())
            .build());

        // Create a new rancher2 Node Template using harvester node_driver
        var foo_harvesterNodeTemplate = new NodeTemplate("foo-harvesterNodeTemplate", NodeTemplateArgs.builder()
            .name("foo-harvester")
            .cloudCredentialId(foo_harvesterCloudCredential.id())
            .engineInstallUrl("https://releases.rancher.com/install-docker/20.10.sh")
            .harvesterConfig(NodeTemplateHarvesterConfigArgs.builder()
                .vmNamespace("default")
                .cpuCount("2")
                .memorySize("4")
                .diskInfo("""
    {
        "disks": [{
            "imageName": "harvester-public/image-57hzg",
            "size": 40,
            "bootOrder": 1
        }]
    }
                """)
                .networkInfo("""
    {
        "interfaces": [{
            "networkName": "harvester-public/vlan1"
        }]
    }
                """)
                .sshUser("ubuntu")
                .userData("""
    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
                """)
                .build())
            .build());

    }
}
Copy
resources:
  # Create a new Cloud Credential for an imported Harvester cluster
  foo-harvesterCloudCredential:
    type: rancher2:CloudCredential
    name: foo-harvester
    properties:
      name: foo-harvester
      harvesterCredentialConfig:
        clusterId: ${["foo-harvester"].clusterV1Id}
        clusterType: imported
        kubeconfigContent: ${["foo-harvester"].kubeConfig}
  # Create a new rancher2 Node Template using harvester node_driver
  foo-harvesterNodeTemplate:
    type: rancher2:NodeTemplate
    name: foo-harvester
    properties:
      name: foo-harvester
      cloudCredentialId: ${["foo-harvesterCloudCredential"].id}
      engineInstallUrl: https://releases.rancher.com/install-docker/20.10.sh
      harvesterConfig:
        vmNamespace: default
        cpuCount: '2'
        memorySize: '4'
        diskInfo: |2
              {
                  "disks": [{
                      "imageName": "harvester-public/image-57hzg",
                      "size": 40,
                      "bootOrder": 1
                  }]
              }
        networkInfo: |2
              {
                  "interfaces": [{
                      "networkName": "harvester-public/vlan1"
                  }]
              }
        sshUser: ubuntu
        userData: |2
              package_update: true
              packages:
                - qemu-guest-agent
                - iptables
              runcmd:
                - - systemctl
                  - enable
                  - '--now'
                  - qemu-guest-agent.service
variables:
  # Get imported harvester cluster info
  foo-harvester:
    fn::invoke:
      function: rancher2:getClusterV2
      arguments:
        name: foo-harvester
Copy

Using the Hetzner Node Driver

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("hetzner_node_driver", {
    active: true,
    builtin: false,
    name: "Hetzner",
    uiUrl: "https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js",
    url: "https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz",
    whitelistDomains: ["storage.googleapis.com"],
});
const myHetznerNodeTemplate = new rancher2.NodeTemplate("my_hetzner_node_template", {
    name: "my-hetzner-node-template",
    driverId: hetznerNodeDriver.id,
    hetznerConfig: {
        apiToken: "XXXXXXXXXX",
        image: "ubuntu-18.04",
        serverLocation: "nbg1",
        serverType: "cx11",
    },
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Template using hetzner node_driver
hetzner_node_driver = rancher2.NodeDriver("hetzner_node_driver",
    active=True,
    builtin=False,
    name="Hetzner",
    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.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz",
    whitelist_domains=["storage.googleapis.com"])
my_hetzner_node_template = rancher2.NodeTemplate("my_hetzner_node_template",
    name="my-hetzner-node-template",
    driver_id=hetzner_node_driver.id,
    hetzner_config={
        "api_token": "XXXXXXXXXX",
        "image": "ubuntu-18.04",
        "server_location": "nbg1",
        "server_type": "cx11",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Node Template using hetzner node_driver
		hetznerNodeDriver, err := rancher2.NewNodeDriver(ctx, "hetzner_node_driver", &rancher2.NodeDriverArgs{
			Active:  pulumi.Bool(true),
			Builtin: pulumi.Bool(false),
			Name:    pulumi.String("Hetzner"),
			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.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz"),
			WhitelistDomains: pulumi.StringArray{
				pulumi.String("storage.googleapis.com"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rancher2.NewNodeTemplate(ctx, "my_hetzner_node_template", &rancher2.NodeTemplateArgs{
			Name:     pulumi.String("my-hetzner-node-template"),
			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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 Node Template using hetzner node_driver
    var hetznerNodeDriver = new Rancher2.NodeDriver("hetzner_node_driver", new()
    {
        Active = true,
        Builtin = false,
        Name = "Hetzner",
        UiUrl = "https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js",
        Url = "https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz",
        WhitelistDomains = new[]
        {
            "storage.googleapis.com",
        },
    });

    var myHetznerNodeTemplate = new Rancher2.NodeTemplate("my_hetzner_node_template", new()
    {
        Name = "my-hetzner-node-template",
        DriverId = hetznerNodeDriver.Id,
        HetznerConfig = new Rancher2.Inputs.NodeTemplateHetznerConfigArgs
        {
            ApiToken = "XXXXXXXXXX",
            Image = "ubuntu-18.04",
            ServerLocation = "nbg1",
            ServerType = "cx11",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.NodeDriver;
import com.pulumi.rancher2.NodeDriverArgs;
import com.pulumi.rancher2.NodeTemplate;
import com.pulumi.rancher2.NodeTemplateArgs;
import com.pulumi.rancher2.inputs.NodeTemplateHetznerConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 Node Template using hetzner node_driver
        var hetznerNodeDriver = new NodeDriver("hetznerNodeDriver", NodeDriverArgs.builder()
            .active(true)
            .builtin(false)
            .name("Hetzner")
            .uiUrl("https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js")
            .url("https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz")
            .whitelistDomains("storage.googleapis.com")
            .build());

        var myHetznerNodeTemplate = new NodeTemplate("myHetznerNodeTemplate", NodeTemplateArgs.builder()
            .name("my-hetzner-node-template")
            .driverId(hetznerNodeDriver.id())
            .hetznerConfig(NodeTemplateHetznerConfigArgs.builder()
                .apiToken("XXXXXXXXXX")
                .image("ubuntu-18.04")
                .serverLocation("nbg1")
                .serverType("cx11")
                .build())
            .build());

    }
}
Copy
resources:
  # Create a new rancher2 Node Template using hetzner node_driver
  hetznerNodeDriver:
    type: rancher2:NodeDriver
    name: hetzner_node_driver
    properties:
      active: true
      builtin: false
      name: Hetzner
      uiUrl: https://storage.googleapis.com/hcloud-rancher-v2-ui-driver/component.js
      url: https://github.com/JonasProgrammer/docker-machine-driver-hetzner/releases/download/3.6.0/docker-machine-driver-hetzner_3.6.0_linux_amd64.tar.gz
      whitelistDomains:
        - storage.googleapis.com
  myHetznerNodeTemplate:
    type: rancher2:NodeTemplate
    name: my_hetzner_node_template
    properties:
      name: my-hetzner-node-template
      driverId: ${hetznerNodeDriver.id}
      hetznerConfig:
        apiToken: XXXXXXXXXX
        image: ubuntu-18.04
        serverLocation: nbg1
        serverType: cx11
Copy

Upgrading to Rancher v2.3.3

Important This process could update rancher2.NodeTemplate data on tfstate file. Be sure to save a copy of tfstate file before proceed

Due to this feature included on Rancher v2.3.3, rancher2.NodeTemplate are now global scoped objects with RBAC around them, instead of user scoped objects as they were. This means that existing node templates id field is changing on upgrade. Provider implements fixNodeTemplateID() that will update tfstate with proper id.

Create NodeTemplate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: CustomResourceOptions);
@overload
def NodeTemplate(resource_name: str,
                 args: Optional[NodeTemplateArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def NodeTemplate(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 amazonec2_config: Optional[NodeTemplateAmazonec2ConfigArgs] = None,
                 annotations: Optional[Mapping[str, str]] = 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, str]] = None,
                 engine_insecure_registries: Optional[Sequence[str]] = None,
                 engine_install_url: Optional[str] = None,
                 engine_label: Optional[Mapping[str, str]] = None,
                 engine_opt: Optional[Mapping[str, str]] = None,
                 engine_registry_mirrors: Optional[Sequence[str]] = None,
                 engine_storage_driver: Optional[str] = None,
                 harvester_config: Optional[NodeTemplateHarvesterConfigArgs] = None,
                 hetzner_config: Optional[NodeTemplateHetznerConfigArgs] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 linode_config: Optional[NodeTemplateLinodeConfigArgs] = None,
                 name: Optional[str] = None,
                 node_taints: Optional[Sequence[NodeTemplateNodeTaintArgs]] = None,
                 opennebula_config: Optional[NodeTemplateOpennebulaConfigArgs] = None,
                 openstack_config: Optional[NodeTemplateOpenstackConfigArgs] = None,
                 outscale_config: Optional[NodeTemplateOutscaleConfigArgs] = 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)
public NodeTemplate(String name, NodeTemplateArgs args)
public NodeTemplate(String name, NodeTemplateArgs args, CustomResourceOptions options)
type: rancher2:NodeTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. str
The unique name of the resource.
args NodeTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. 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 This property is required. string
The unique name of the resource.
args NodeTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NodeTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var nodeTemplateResource = new Rancher2.NodeTemplate("nodeTemplateResource", new()
{
    Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
    {
        Region = "string",
        Ami = "string",
        Zone = "string",
        VpcId = "string",
        SubnetId = "string",
        SecurityGroups = new[]
        {
            "string",
        },
        RequestSpotInstance = false,
        SecretKey = "string",
        IamInstanceProfile = "string",
        InsecureTransport = false,
        InstanceType = "string",
        KmsKey = "string",
        Monitoring = false,
        OpenPorts = new[]
        {
            "string",
        },
        PrivateAddressOnly = false,
        HttpEndpoint = "string",
        AccessKey = "string",
        Retries = "string",
        RootSize = "string",
        HttpTokens = "string",
        SecurityGroupReadonly = false,
        Endpoint = "string",
        SessionToken = "string",
        SpotPrice = "string",
        SshKeypath = "string",
        SshUser = "string",
        EncryptEbsVolume = false,
        Tags = "string",
        UseEbsOptimizedInstance = false,
        UsePrivateAddress = false,
        Userdata = "string",
        VolumeType = "string",
        DeviceName = "string",
        BlockDurationMinutes = "string",
    },
    Annotations = 
    {
        { "string", "string" },
    },
    AuthCertificateAuthority = "string",
    AuthKey = "string",
    AzureConfig = new Rancher2.Inputs.NodeTemplateAzureConfigArgs
    {
        AcceleratedNetworking = false,
        AvailabilitySet = "string",
        AvailabilityZone = "string",
        ClientId = "string",
        ClientSecret = "string",
        CustomData = "string",
        DiskSize = "string",
        Dns = "string",
        DockerPort = "string",
        Environment = "string",
        FaultDomainCount = "string",
        Image = "string",
        Location = "string",
        ManagedDisks = false,
        NoPublicIp = false,
        Nsg = "string",
        OpenPorts = new[]
        {
            "string",
        },
        Plan = "string",
        PrivateIpAddress = "string",
        ResourceGroup = "string",
        Size = "string",
        SshUser = "string",
        StaticPublicIp = false,
        StorageType = "string",
        Subnet = "string",
        SubnetPrefix = "string",
        SubscriptionId = "string",
        Tags = "string",
        UpdateDomainCount = "string",
        UsePrivateIp = false,
        UsePublicIpStandardSku = false,
        Vnet = "string",
    },
    CloudCredentialId = "string",
    Description = "string",
    DigitaloceanConfig = new Rancher2.Inputs.NodeTemplateDigitaloceanConfigArgs
    {
        AccessToken = "string",
        Backups = false,
        Image = "string",
        Ipv6 = false,
        Monitoring = false,
        PrivateNetworking = false,
        Region = "string",
        Size = "string",
        SshKeyFingerprint = "string",
        SshKeyPath = "string",
        SshPort = "string",
        SshUser = "string",
        Tags = "string",
        Userdata = "string",
    },
    DriverId = "string",
    EngineEnv = 
    {
        { "string", "string" },
    },
    EngineInsecureRegistries = new[]
    {
        "string",
    },
    EngineInstallUrl = "string",
    EngineLabel = 
    {
        { "string", "string" },
    },
    EngineOpt = 
    {
        { "string", "string" },
    },
    EngineRegistryMirrors = new[]
    {
        "string",
    },
    EngineStorageDriver = "string",
    HarvesterConfig = new Rancher2.Inputs.NodeTemplateHarvesterConfigArgs
    {
        SshUser = "string",
        VmNamespace = "string",
        NetworkData = "string",
        MemorySize = "string",
        CpuCount = "string",
        NetworkInfo = "string",
        SshPassword = "string",
        DiskInfo = "string",
        UserData = "string",
        VmAffinity = "string",
    },
    HetznerConfig = new Rancher2.Inputs.NodeTemplateHetznerConfigArgs
    {
        ApiToken = "string",
        Image = "string",
        Networks = "string",
        ServerLabels = 
        {
            { "string", "string" },
        },
        ServerLocation = "string",
        ServerType = "string",
        UsePrivateNetwork = false,
        Userdata = "string",
        Volumes = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    LinodeConfig = new Rancher2.Inputs.NodeTemplateLinodeConfigArgs
    {
        AuthorizedUsers = "string",
        CreatePrivateIp = false,
        DockerPort = "string",
        Image = "string",
        InstanceType = "string",
        Label = "string",
        Region = "string",
        RootPass = "string",
        SshPort = "string",
        SshUser = "string",
        Stackscript = "string",
        StackscriptData = "string",
        SwapSize = "string",
        Tags = "string",
        Token = "string",
        UaPrefix = "string",
    },
    Name = "string",
    NodeTaints = new[]
    {
        new Rancher2.Inputs.NodeTemplateNodeTaintArgs
        {
            Key = "string",
            Value = "string",
            Effect = "string",
            TimeAdded = "string",
        },
    },
    OpennebulaConfig = new Rancher2.Inputs.NodeTemplateOpennebulaConfigArgs
    {
        Password = "string",
        XmlRpcUrl = "string",
        User = "string",
        DiskResize = "string",
        NetworkName = "string",
        ImageId = "string",
        ImageName = "string",
        ImageOwner = "string",
        Memory = "string",
        NetworkId = "string",
        B2dSize = "string",
        NetworkOwner = "string",
        DisableVnc = false,
        SshUser = "string",
        TemplateId = "string",
        TemplateName = "string",
        DevPrefix = "string",
        Vcpu = "string",
        Cpu = "string",
    },
    OpenstackConfig = new Rancher2.Inputs.NodeTemplateOpenstackConfigArgs
    {
        AuthUrl = "string",
        Region = "string",
        AvailabilityZone = "string",
        IpVersion = "string",
        NetId = "string",
        ApplicationCredentialName = "string",
        BootFromVolume = false,
        Cacert = "string",
        ConfigDrive = false,
        DomainId = "string",
        DomainName = "string",
        EndpointType = "string",
        FlavorId = "string",
        FlavorName = "string",
        FloatingIpPool = "string",
        ImageId = "string",
        ImageName = "string",
        Insecure = false,
        ActiveTimeout = "string",
        ApplicationCredentialSecret = "string",
        KeypairName = "string",
        NetName = "string",
        NovaNetwork = false,
        Password = "string",
        PrivateKeyFile = "string",
        ApplicationCredentialId = "string",
        SecGroups = "string",
        SshPort = "string",
        SshUser = "string",
        TenantId = "string",
        TenantName = "string",
        UserDataFile = "string",
        Username = "string",
        VolumeDevicePath = "string",
        VolumeId = "string",
        VolumeName = "string",
        VolumeSize = "string",
        VolumeType = "string",
    },
    OutscaleConfig = new Rancher2.Inputs.NodeTemplateOutscaleConfigArgs
    {
        AccessKey = "string",
        SecretKey = "string",
        ExtraTagsAlls = new[]
        {
            "string",
        },
        ExtraTagsInstances = new[]
        {
            "string",
        },
        InstanceType = "string",
        Region = "string",
        RootDiskIops = 0,
        RootDiskSize = 0,
        RootDiskType = "string",
        SecurityGroupIds = new[]
        {
            "string",
        },
        SourceOmi = "string",
    },
    UseInternalIpAddress = false,
    VsphereConfig = new Rancher2.Inputs.NodeTemplateVsphereConfigArgs
    {
        Boot2dockerUrl = "string",
        Cfgparams = new[]
        {
            "string",
        },
        CloneFrom = "string",
        CloudConfig = "string",
        Cloudinit = "string",
        ContentLibrary = "string",
        CpuCount = "string",
        CreationType = "string",
        CustomAttributes = new[]
        {
            "string",
        },
        Datacenter = "string",
        Datastore = "string",
        DatastoreCluster = "string",
        DiskSize = "string",
        Folder = "string",
        GracefulShutdownTimeout = "string",
        Hostsystem = "string",
        MemorySize = "string",
        Networks = new[]
        {
            "string",
        },
        Password = "string",
        Pool = "string",
        SshPassword = "string",
        SshPort = "string",
        SshUser = "string",
        SshUserGroup = "string",
        Tags = new[]
        {
            "string",
        },
        Username = "string",
        VappIpAllocationPolicy = "string",
        VappIpProtocol = "string",
        VappProperties = new[]
        {
            "string",
        },
        VappTransport = "string",
        Vcenter = "string",
        VcenterPort = "string",
    },
});
Copy
example, err := rancher2.NewNodeTemplate(ctx, "nodeTemplateResource", &rancher2.NodeTemplateArgs{
	Amazonec2Config: &rancher2.NodeTemplateAmazonec2ConfigArgs{
		Region:   pulumi.String("string"),
		Ami:      pulumi.String("string"),
		Zone:     pulumi.String("string"),
		VpcId:    pulumi.String("string"),
		SubnetId: pulumi.String("string"),
		SecurityGroups: pulumi.StringArray{
			pulumi.String("string"),
		},
		RequestSpotInstance: pulumi.Bool(false),
		SecretKey:           pulumi.String("string"),
		IamInstanceProfile:  pulumi.String("string"),
		InsecureTransport:   pulumi.Bool(false),
		InstanceType:        pulumi.String("string"),
		KmsKey:              pulumi.String("string"),
		Monitoring:          pulumi.Bool(false),
		OpenPorts: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrivateAddressOnly:      pulumi.Bool(false),
		HttpEndpoint:            pulumi.String("string"),
		AccessKey:               pulumi.String("string"),
		Retries:                 pulumi.String("string"),
		RootSize:                pulumi.String("string"),
		HttpTokens:              pulumi.String("string"),
		SecurityGroupReadonly:   pulumi.Bool(false),
		Endpoint:                pulumi.String("string"),
		SessionToken:            pulumi.String("string"),
		SpotPrice:               pulumi.String("string"),
		SshKeypath:              pulumi.String("string"),
		SshUser:                 pulumi.String("string"),
		EncryptEbsVolume:        pulumi.Bool(false),
		Tags:                    pulumi.String("string"),
		UseEbsOptimizedInstance: pulumi.Bool(false),
		UsePrivateAddress:       pulumi.Bool(false),
		Userdata:                pulumi.String("string"),
		VolumeType:              pulumi.String("string"),
		DeviceName:              pulumi.String("string"),
		BlockDurationMinutes:    pulumi.String("string"),
	},
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AuthCertificateAuthority: pulumi.String("string"),
	AuthKey:                  pulumi.String("string"),
	AzureConfig: &rancher2.NodeTemplateAzureConfigArgs{
		AcceleratedNetworking: pulumi.Bool(false),
		AvailabilitySet:       pulumi.String("string"),
		AvailabilityZone:      pulumi.String("string"),
		ClientId:              pulumi.String("string"),
		ClientSecret:          pulumi.String("string"),
		CustomData:            pulumi.String("string"),
		DiskSize:              pulumi.String("string"),
		Dns:                   pulumi.String("string"),
		DockerPort:            pulumi.String("string"),
		Environment:           pulumi.String("string"),
		FaultDomainCount:      pulumi.String("string"),
		Image:                 pulumi.String("string"),
		Location:              pulumi.String("string"),
		ManagedDisks:          pulumi.Bool(false),
		NoPublicIp:            pulumi.Bool(false),
		Nsg:                   pulumi.String("string"),
		OpenPorts: pulumi.StringArray{
			pulumi.String("string"),
		},
		Plan:                   pulumi.String("string"),
		PrivateIpAddress:       pulumi.String("string"),
		ResourceGroup:          pulumi.String("string"),
		Size:                   pulumi.String("string"),
		SshUser:                pulumi.String("string"),
		StaticPublicIp:         pulumi.Bool(false),
		StorageType:            pulumi.String("string"),
		Subnet:                 pulumi.String("string"),
		SubnetPrefix:           pulumi.String("string"),
		SubscriptionId:         pulumi.String("string"),
		Tags:                   pulumi.String("string"),
		UpdateDomainCount:      pulumi.String("string"),
		UsePrivateIp:           pulumi.Bool(false),
		UsePublicIpStandardSku: pulumi.Bool(false),
		Vnet:                   pulumi.String("string"),
	},
	CloudCredentialId: pulumi.String("string"),
	Description:       pulumi.String("string"),
	DigitaloceanConfig: &rancher2.NodeTemplateDigitaloceanConfigArgs{
		AccessToken:       pulumi.String("string"),
		Backups:           pulumi.Bool(false),
		Image:             pulumi.String("string"),
		Ipv6:              pulumi.Bool(false),
		Monitoring:        pulumi.Bool(false),
		PrivateNetworking: pulumi.Bool(false),
		Region:            pulumi.String("string"),
		Size:              pulumi.String("string"),
		SshKeyFingerprint: pulumi.String("string"),
		SshKeyPath:        pulumi.String("string"),
		SshPort:           pulumi.String("string"),
		SshUser:           pulumi.String("string"),
		Tags:              pulumi.String("string"),
		Userdata:          pulumi.String("string"),
	},
	DriverId: pulumi.String("string"),
	EngineEnv: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EngineInsecureRegistries: pulumi.StringArray{
		pulumi.String("string"),
	},
	EngineInstallUrl: pulumi.String("string"),
	EngineLabel: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EngineOpt: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EngineRegistryMirrors: pulumi.StringArray{
		pulumi.String("string"),
	},
	EngineStorageDriver: pulumi.String("string"),
	HarvesterConfig: &rancher2.NodeTemplateHarvesterConfigArgs{
		SshUser:     pulumi.String("string"),
		VmNamespace: pulumi.String("string"),
		NetworkData: pulumi.String("string"),
		MemorySize:  pulumi.String("string"),
		CpuCount:    pulumi.String("string"),
		NetworkInfo: pulumi.String("string"),
		SshPassword: pulumi.String("string"),
		DiskInfo:    pulumi.String("string"),
		UserData:    pulumi.String("string"),
		VmAffinity:  pulumi.String("string"),
	},
	HetznerConfig: &rancher2.NodeTemplateHetznerConfigArgs{
		ApiToken: pulumi.String("string"),
		Image:    pulumi.String("string"),
		Networks: pulumi.String("string"),
		ServerLabels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ServerLocation:    pulumi.String("string"),
		ServerType:        pulumi.String("string"),
		UsePrivateNetwork: pulumi.Bool(false),
		Userdata:          pulumi.String("string"),
		Volumes:           pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LinodeConfig: &rancher2.NodeTemplateLinodeConfigArgs{
		AuthorizedUsers: pulumi.String("string"),
		CreatePrivateIp: pulumi.Bool(false),
		DockerPort:      pulumi.String("string"),
		Image:           pulumi.String("string"),
		InstanceType:    pulumi.String("string"),
		Label:           pulumi.String("string"),
		Region:          pulumi.String("string"),
		RootPass:        pulumi.String("string"),
		SshPort:         pulumi.String("string"),
		SshUser:         pulumi.String("string"),
		Stackscript:     pulumi.String("string"),
		StackscriptData: pulumi.String("string"),
		SwapSize:        pulumi.String("string"),
		Tags:            pulumi.String("string"),
		Token:           pulumi.String("string"),
		UaPrefix:        pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	NodeTaints: rancher2.NodeTemplateNodeTaintArray{
		&rancher2.NodeTemplateNodeTaintArgs{
			Key:       pulumi.String("string"),
			Value:     pulumi.String("string"),
			Effect:    pulumi.String("string"),
			TimeAdded: pulumi.String("string"),
		},
	},
	OpennebulaConfig: &rancher2.NodeTemplateOpennebulaConfigArgs{
		Password:     pulumi.String("string"),
		XmlRpcUrl:    pulumi.String("string"),
		User:         pulumi.String("string"),
		DiskResize:   pulumi.String("string"),
		NetworkName:  pulumi.String("string"),
		ImageId:      pulumi.String("string"),
		ImageName:    pulumi.String("string"),
		ImageOwner:   pulumi.String("string"),
		Memory:       pulumi.String("string"),
		NetworkId:    pulumi.String("string"),
		B2dSize:      pulumi.String("string"),
		NetworkOwner: pulumi.String("string"),
		DisableVnc:   pulumi.Bool(false),
		SshUser:      pulumi.String("string"),
		TemplateId:   pulumi.String("string"),
		TemplateName: pulumi.String("string"),
		DevPrefix:    pulumi.String("string"),
		Vcpu:         pulumi.String("string"),
		Cpu:          pulumi.String("string"),
	},
	OpenstackConfig: &rancher2.NodeTemplateOpenstackConfigArgs{
		AuthUrl:                     pulumi.String("string"),
		Region:                      pulumi.String("string"),
		AvailabilityZone:            pulumi.String("string"),
		IpVersion:                   pulumi.String("string"),
		NetId:                       pulumi.String("string"),
		ApplicationCredentialName:   pulumi.String("string"),
		BootFromVolume:              pulumi.Bool(false),
		Cacert:                      pulumi.String("string"),
		ConfigDrive:                 pulumi.Bool(false),
		DomainId:                    pulumi.String("string"),
		DomainName:                  pulumi.String("string"),
		EndpointType:                pulumi.String("string"),
		FlavorId:                    pulumi.String("string"),
		FlavorName:                  pulumi.String("string"),
		FloatingIpPool:              pulumi.String("string"),
		ImageId:                     pulumi.String("string"),
		ImageName:                   pulumi.String("string"),
		Insecure:                    pulumi.Bool(false),
		ActiveTimeout:               pulumi.String("string"),
		ApplicationCredentialSecret: pulumi.String("string"),
		KeypairName:                 pulumi.String("string"),
		NetName:                     pulumi.String("string"),
		NovaNetwork:                 pulumi.Bool(false),
		Password:                    pulumi.String("string"),
		PrivateKeyFile:              pulumi.String("string"),
		ApplicationCredentialId:     pulumi.String("string"),
		SecGroups:                   pulumi.String("string"),
		SshPort:                     pulumi.String("string"),
		SshUser:                     pulumi.String("string"),
		TenantId:                    pulumi.String("string"),
		TenantName:                  pulumi.String("string"),
		UserDataFile:                pulumi.String("string"),
		Username:                    pulumi.String("string"),
		VolumeDevicePath:            pulumi.String("string"),
		VolumeId:                    pulumi.String("string"),
		VolumeName:                  pulumi.String("string"),
		VolumeSize:                  pulumi.String("string"),
		VolumeType:                  pulumi.String("string"),
	},
	OutscaleConfig: &rancher2.NodeTemplateOutscaleConfigArgs{
		AccessKey: pulumi.String("string"),
		SecretKey: pulumi.String("string"),
		ExtraTagsAlls: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExtraTagsInstances: pulumi.StringArray{
			pulumi.String("string"),
		},
		InstanceType: pulumi.String("string"),
		Region:       pulumi.String("string"),
		RootDiskIops: pulumi.Int(0),
		RootDiskSize: pulumi.Int(0),
		RootDiskType: pulumi.String("string"),
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SourceOmi: pulumi.String("string"),
	},
	UseInternalIpAddress: pulumi.Bool(false),
	VsphereConfig: &rancher2.NodeTemplateVsphereConfigArgs{
		Boot2dockerUrl: pulumi.String("string"),
		Cfgparams: pulumi.StringArray{
			pulumi.String("string"),
		},
		CloneFrom:      pulumi.String("string"),
		CloudConfig:    pulumi.String("string"),
		Cloudinit:      pulumi.String("string"),
		ContentLibrary: pulumi.String("string"),
		CpuCount:       pulumi.String("string"),
		CreationType:   pulumi.String("string"),
		CustomAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Datacenter:              pulumi.String("string"),
		Datastore:               pulumi.String("string"),
		DatastoreCluster:        pulumi.String("string"),
		DiskSize:                pulumi.String("string"),
		Folder:                  pulumi.String("string"),
		GracefulShutdownTimeout: pulumi.String("string"),
		Hostsystem:              pulumi.String("string"),
		MemorySize:              pulumi.String("string"),
		Networks: pulumi.StringArray{
			pulumi.String("string"),
		},
		Password:     pulumi.String("string"),
		Pool:         pulumi.String("string"),
		SshPassword:  pulumi.String("string"),
		SshPort:      pulumi.String("string"),
		SshUser:      pulumi.String("string"),
		SshUserGroup: pulumi.String("string"),
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
		Username:               pulumi.String("string"),
		VappIpAllocationPolicy: pulumi.String("string"),
		VappIpProtocol:         pulumi.String("string"),
		VappProperties: pulumi.StringArray{
			pulumi.String("string"),
		},
		VappTransport: pulumi.String("string"),
		Vcenter:       pulumi.String("string"),
		VcenterPort:   pulumi.String("string"),
	},
})
Copy
var nodeTemplateResource = new NodeTemplate("nodeTemplateResource", NodeTemplateArgs.builder()
    .amazonec2Config(NodeTemplateAmazonec2ConfigArgs.builder()
        .region("string")
        .ami("string")
        .zone("string")
        .vpcId("string")
        .subnetId("string")
        .securityGroups("string")
        .requestSpotInstance(false)
        .secretKey("string")
        .iamInstanceProfile("string")
        .insecureTransport(false)
        .instanceType("string")
        .kmsKey("string")
        .monitoring(false)
        .openPorts("string")
        .privateAddressOnly(false)
        .httpEndpoint("string")
        .accessKey("string")
        .retries("string")
        .rootSize("string")
        .httpTokens("string")
        .securityGroupReadonly(false)
        .endpoint("string")
        .sessionToken("string")
        .spotPrice("string")
        .sshKeypath("string")
        .sshUser("string")
        .encryptEbsVolume(false)
        .tags("string")
        .useEbsOptimizedInstance(false)
        .usePrivateAddress(false)
        .userdata("string")
        .volumeType("string")
        .deviceName("string")
        .blockDurationMinutes("string")
        .build())
    .annotations(Map.of("string", "string"))
    .authCertificateAuthority("string")
    .authKey("string")
    .azureConfig(NodeTemplateAzureConfigArgs.builder()
        .acceleratedNetworking(false)
        .availabilitySet("string")
        .availabilityZone("string")
        .clientId("string")
        .clientSecret("string")
        .customData("string")
        .diskSize("string")
        .dns("string")
        .dockerPort("string")
        .environment("string")
        .faultDomainCount("string")
        .image("string")
        .location("string")
        .managedDisks(false)
        .noPublicIp(false)
        .nsg("string")
        .openPorts("string")
        .plan("string")
        .privateIpAddress("string")
        .resourceGroup("string")
        .size("string")
        .sshUser("string")
        .staticPublicIp(false)
        .storageType("string")
        .subnet("string")
        .subnetPrefix("string")
        .subscriptionId("string")
        .tags("string")
        .updateDomainCount("string")
        .usePrivateIp(false)
        .usePublicIpStandardSku(false)
        .vnet("string")
        .build())
    .cloudCredentialId("string")
    .description("string")
    .digitaloceanConfig(NodeTemplateDigitaloceanConfigArgs.builder()
        .accessToken("string")
        .backups(false)
        .image("string")
        .ipv6(false)
        .monitoring(false)
        .privateNetworking(false)
        .region("string")
        .size("string")
        .sshKeyFingerprint("string")
        .sshKeyPath("string")
        .sshPort("string")
        .sshUser("string")
        .tags("string")
        .userdata("string")
        .build())
    .driverId("string")
    .engineEnv(Map.of("string", "string"))
    .engineInsecureRegistries("string")
    .engineInstallUrl("string")
    .engineLabel(Map.of("string", "string"))
    .engineOpt(Map.of("string", "string"))
    .engineRegistryMirrors("string")
    .engineStorageDriver("string")
    .harvesterConfig(NodeTemplateHarvesterConfigArgs.builder()
        .sshUser("string")
        .vmNamespace("string")
        .networkData("string")
        .memorySize("string")
        .cpuCount("string")
        .networkInfo("string")
        .sshPassword("string")
        .diskInfo("string")
        .userData("string")
        .vmAffinity("string")
        .build())
    .hetznerConfig(NodeTemplateHetznerConfigArgs.builder()
        .apiToken("string")
        .image("string")
        .networks("string")
        .serverLabels(Map.of("string", "string"))
        .serverLocation("string")
        .serverType("string")
        .usePrivateNetwork(false)
        .userdata("string")
        .volumes("string")
        .build())
    .labels(Map.of("string", "string"))
    .linodeConfig(NodeTemplateLinodeConfigArgs.builder()
        .authorizedUsers("string")
        .createPrivateIp(false)
        .dockerPort("string")
        .image("string")
        .instanceType("string")
        .label("string")
        .region("string")
        .rootPass("string")
        .sshPort("string")
        .sshUser("string")
        .stackscript("string")
        .stackscriptData("string")
        .swapSize("string")
        .tags("string")
        .token("string")
        .uaPrefix("string")
        .build())
    .name("string")
    .nodeTaints(NodeTemplateNodeTaintArgs.builder()
        .key("string")
        .value("string")
        .effect("string")
        .timeAdded("string")
        .build())
    .opennebulaConfig(NodeTemplateOpennebulaConfigArgs.builder()
        .password("string")
        .xmlRpcUrl("string")
        .user("string")
        .diskResize("string")
        .networkName("string")
        .imageId("string")
        .imageName("string")
        .imageOwner("string")
        .memory("string")
        .networkId("string")
        .b2dSize("string")
        .networkOwner("string")
        .disableVnc(false)
        .sshUser("string")
        .templateId("string")
        .templateName("string")
        .devPrefix("string")
        .vcpu("string")
        .cpu("string")
        .build())
    .openstackConfig(NodeTemplateOpenstackConfigArgs.builder()
        .authUrl("string")
        .region("string")
        .availabilityZone("string")
        .ipVersion("string")
        .netId("string")
        .applicationCredentialName("string")
        .bootFromVolume(false)
        .cacert("string")
        .configDrive(false)
        .domainId("string")
        .domainName("string")
        .endpointType("string")
        .flavorId("string")
        .flavorName("string")
        .floatingIpPool("string")
        .imageId("string")
        .imageName("string")
        .insecure(false)
        .activeTimeout("string")
        .applicationCredentialSecret("string")
        .keypairName("string")
        .netName("string")
        .novaNetwork(false)
        .password("string")
        .privateKeyFile("string")
        .applicationCredentialId("string")
        .secGroups("string")
        .sshPort("string")
        .sshUser("string")
        .tenantId("string")
        .tenantName("string")
        .userDataFile("string")
        .username("string")
        .volumeDevicePath("string")
        .volumeId("string")
        .volumeName("string")
        .volumeSize("string")
        .volumeType("string")
        .build())
    .outscaleConfig(NodeTemplateOutscaleConfigArgs.builder()
        .accessKey("string")
        .secretKey("string")
        .extraTagsAlls("string")
        .extraTagsInstances("string")
        .instanceType("string")
        .region("string")
        .rootDiskIops(0)
        .rootDiskSize(0)
        .rootDiskType("string")
        .securityGroupIds("string")
        .sourceOmi("string")
        .build())
    .useInternalIpAddress(false)
    .vsphereConfig(NodeTemplateVsphereConfigArgs.builder()
        .boot2dockerUrl("string")
        .cfgparams("string")
        .cloneFrom("string")
        .cloudConfig("string")
        .cloudinit("string")
        .contentLibrary("string")
        .cpuCount("string")
        .creationType("string")
        .customAttributes("string")
        .datacenter("string")
        .datastore("string")
        .datastoreCluster("string")
        .diskSize("string")
        .folder("string")
        .gracefulShutdownTimeout("string")
        .hostsystem("string")
        .memorySize("string")
        .networks("string")
        .password("string")
        .pool("string")
        .sshPassword("string")
        .sshPort("string")
        .sshUser("string")
        .sshUserGroup("string")
        .tags("string")
        .username("string")
        .vappIpAllocationPolicy("string")
        .vappIpProtocol("string")
        .vappProperties("string")
        .vappTransport("string")
        .vcenter("string")
        .vcenterPort("string")
        .build())
    .build());
Copy
node_template_resource = rancher2.NodeTemplate("nodeTemplateResource",
    amazonec2_config={
        "region": "string",
        "ami": "string",
        "zone": "string",
        "vpc_id": "string",
        "subnet_id": "string",
        "security_groups": ["string"],
        "request_spot_instance": False,
        "secret_key": "string",
        "iam_instance_profile": "string",
        "insecure_transport": False,
        "instance_type": "string",
        "kms_key": "string",
        "monitoring": False,
        "open_ports": ["string"],
        "private_address_only": False,
        "http_endpoint": "string",
        "access_key": "string",
        "retries": "string",
        "root_size": "string",
        "http_tokens": "string",
        "security_group_readonly": False,
        "endpoint": "string",
        "session_token": "string",
        "spot_price": "string",
        "ssh_keypath": "string",
        "ssh_user": "string",
        "encrypt_ebs_volume": False,
        "tags": "string",
        "use_ebs_optimized_instance": False,
        "use_private_address": False,
        "userdata": "string",
        "volume_type": "string",
        "device_name": "string",
        "block_duration_minutes": "string",
    },
    annotations={
        "string": "string",
    },
    auth_certificate_authority="string",
    auth_key="string",
    azure_config={
        "accelerated_networking": False,
        "availability_set": "string",
        "availability_zone": "string",
        "client_id": "string",
        "client_secret": "string",
        "custom_data": "string",
        "disk_size": "string",
        "dns": "string",
        "docker_port": "string",
        "environment": "string",
        "fault_domain_count": "string",
        "image": "string",
        "location": "string",
        "managed_disks": False,
        "no_public_ip": False,
        "nsg": "string",
        "open_ports": ["string"],
        "plan": "string",
        "private_ip_address": "string",
        "resource_group": "string",
        "size": "string",
        "ssh_user": "string",
        "static_public_ip": False,
        "storage_type": "string",
        "subnet": "string",
        "subnet_prefix": "string",
        "subscription_id": "string",
        "tags": "string",
        "update_domain_count": "string",
        "use_private_ip": False,
        "use_public_ip_standard_sku": False,
        "vnet": "string",
    },
    cloud_credential_id="string",
    description="string",
    digitalocean_config={
        "access_token": "string",
        "backups": False,
        "image": "string",
        "ipv6": False,
        "monitoring": False,
        "private_networking": False,
        "region": "string",
        "size": "string",
        "ssh_key_fingerprint": "string",
        "ssh_key_path": "string",
        "ssh_port": "string",
        "ssh_user": "string",
        "tags": "string",
        "userdata": "string",
    },
    driver_id="string",
    engine_env={
        "string": "string",
    },
    engine_insecure_registries=["string"],
    engine_install_url="string",
    engine_label={
        "string": "string",
    },
    engine_opt={
        "string": "string",
    },
    engine_registry_mirrors=["string"],
    engine_storage_driver="string",
    harvester_config={
        "ssh_user": "string",
        "vm_namespace": "string",
        "network_data": "string",
        "memory_size": "string",
        "cpu_count": "string",
        "network_info": "string",
        "ssh_password": "string",
        "disk_info": "string",
        "user_data": "string",
        "vm_affinity": "string",
    },
    hetzner_config={
        "api_token": "string",
        "image": "string",
        "networks": "string",
        "server_labels": {
            "string": "string",
        },
        "server_location": "string",
        "server_type": "string",
        "use_private_network": False,
        "userdata": "string",
        "volumes": "string",
    },
    labels={
        "string": "string",
    },
    linode_config={
        "authorized_users": "string",
        "create_private_ip": False,
        "docker_port": "string",
        "image": "string",
        "instance_type": "string",
        "label": "string",
        "region": "string",
        "root_pass": "string",
        "ssh_port": "string",
        "ssh_user": "string",
        "stackscript": "string",
        "stackscript_data": "string",
        "swap_size": "string",
        "tags": "string",
        "token": "string",
        "ua_prefix": "string",
    },
    name="string",
    node_taints=[{
        "key": "string",
        "value": "string",
        "effect": "string",
        "time_added": "string",
    }],
    opennebula_config={
        "password": "string",
        "xml_rpc_url": "string",
        "user": "string",
        "disk_resize": "string",
        "network_name": "string",
        "image_id": "string",
        "image_name": "string",
        "image_owner": "string",
        "memory": "string",
        "network_id": "string",
        "b2d_size": "string",
        "network_owner": "string",
        "disable_vnc": False,
        "ssh_user": "string",
        "template_id": "string",
        "template_name": "string",
        "dev_prefix": "string",
        "vcpu": "string",
        "cpu": "string",
    },
    openstack_config={
        "auth_url": "string",
        "region": "string",
        "availability_zone": "string",
        "ip_version": "string",
        "net_id": "string",
        "application_credential_name": "string",
        "boot_from_volume": False,
        "cacert": "string",
        "config_drive": False,
        "domain_id": "string",
        "domain_name": "string",
        "endpoint_type": "string",
        "flavor_id": "string",
        "flavor_name": "string",
        "floating_ip_pool": "string",
        "image_id": "string",
        "image_name": "string",
        "insecure": False,
        "active_timeout": "string",
        "application_credential_secret": "string",
        "keypair_name": "string",
        "net_name": "string",
        "nova_network": False,
        "password": "string",
        "private_key_file": "string",
        "application_credential_id": "string",
        "sec_groups": "string",
        "ssh_port": "string",
        "ssh_user": "string",
        "tenant_id": "string",
        "tenant_name": "string",
        "user_data_file": "string",
        "username": "string",
        "volume_device_path": "string",
        "volume_id": "string",
        "volume_name": "string",
        "volume_size": "string",
        "volume_type": "string",
    },
    outscale_config={
        "access_key": "string",
        "secret_key": "string",
        "extra_tags_alls": ["string"],
        "extra_tags_instances": ["string"],
        "instance_type": "string",
        "region": "string",
        "root_disk_iops": 0,
        "root_disk_size": 0,
        "root_disk_type": "string",
        "security_group_ids": ["string"],
        "source_omi": "string",
    },
    use_internal_ip_address=False,
    vsphere_config={
        "boot2docker_url": "string",
        "cfgparams": ["string"],
        "clone_from": "string",
        "cloud_config": "string",
        "cloudinit": "string",
        "content_library": "string",
        "cpu_count": "string",
        "creation_type": "string",
        "custom_attributes": ["string"],
        "datacenter": "string",
        "datastore": "string",
        "datastore_cluster": "string",
        "disk_size": "string",
        "folder": "string",
        "graceful_shutdown_timeout": "string",
        "hostsystem": "string",
        "memory_size": "string",
        "networks": ["string"],
        "password": "string",
        "pool": "string",
        "ssh_password": "string",
        "ssh_port": "string",
        "ssh_user": "string",
        "ssh_user_group": "string",
        "tags": ["string"],
        "username": "string",
        "vapp_ip_allocation_policy": "string",
        "vapp_ip_protocol": "string",
        "vapp_properties": ["string"],
        "vapp_transport": "string",
        "vcenter": "string",
        "vcenter_port": "string",
    })
Copy
const nodeTemplateResource = new rancher2.NodeTemplate("nodeTemplateResource", {
    amazonec2Config: {
        region: "string",
        ami: "string",
        zone: "string",
        vpcId: "string",
        subnetId: "string",
        securityGroups: ["string"],
        requestSpotInstance: false,
        secretKey: "string",
        iamInstanceProfile: "string",
        insecureTransport: false,
        instanceType: "string",
        kmsKey: "string",
        monitoring: false,
        openPorts: ["string"],
        privateAddressOnly: false,
        httpEndpoint: "string",
        accessKey: "string",
        retries: "string",
        rootSize: "string",
        httpTokens: "string",
        securityGroupReadonly: false,
        endpoint: "string",
        sessionToken: "string",
        spotPrice: "string",
        sshKeypath: "string",
        sshUser: "string",
        encryptEbsVolume: false,
        tags: "string",
        useEbsOptimizedInstance: false,
        usePrivateAddress: false,
        userdata: "string",
        volumeType: "string",
        deviceName: "string",
        blockDurationMinutes: "string",
    },
    annotations: {
        string: "string",
    },
    authCertificateAuthority: "string",
    authKey: "string",
    azureConfig: {
        acceleratedNetworking: false,
        availabilitySet: "string",
        availabilityZone: "string",
        clientId: "string",
        clientSecret: "string",
        customData: "string",
        diskSize: "string",
        dns: "string",
        dockerPort: "string",
        environment: "string",
        faultDomainCount: "string",
        image: "string",
        location: "string",
        managedDisks: false,
        noPublicIp: false,
        nsg: "string",
        openPorts: ["string"],
        plan: "string",
        privateIpAddress: "string",
        resourceGroup: "string",
        size: "string",
        sshUser: "string",
        staticPublicIp: false,
        storageType: "string",
        subnet: "string",
        subnetPrefix: "string",
        subscriptionId: "string",
        tags: "string",
        updateDomainCount: "string",
        usePrivateIp: false,
        usePublicIpStandardSku: false,
        vnet: "string",
    },
    cloudCredentialId: "string",
    description: "string",
    digitaloceanConfig: {
        accessToken: "string",
        backups: false,
        image: "string",
        ipv6: false,
        monitoring: false,
        privateNetworking: false,
        region: "string",
        size: "string",
        sshKeyFingerprint: "string",
        sshKeyPath: "string",
        sshPort: "string",
        sshUser: "string",
        tags: "string",
        userdata: "string",
    },
    driverId: "string",
    engineEnv: {
        string: "string",
    },
    engineInsecureRegistries: ["string"],
    engineInstallUrl: "string",
    engineLabel: {
        string: "string",
    },
    engineOpt: {
        string: "string",
    },
    engineRegistryMirrors: ["string"],
    engineStorageDriver: "string",
    harvesterConfig: {
        sshUser: "string",
        vmNamespace: "string",
        networkData: "string",
        memorySize: "string",
        cpuCount: "string",
        networkInfo: "string",
        sshPassword: "string",
        diskInfo: "string",
        userData: "string",
        vmAffinity: "string",
    },
    hetznerConfig: {
        apiToken: "string",
        image: "string",
        networks: "string",
        serverLabels: {
            string: "string",
        },
        serverLocation: "string",
        serverType: "string",
        usePrivateNetwork: false,
        userdata: "string",
        volumes: "string",
    },
    labels: {
        string: "string",
    },
    linodeConfig: {
        authorizedUsers: "string",
        createPrivateIp: false,
        dockerPort: "string",
        image: "string",
        instanceType: "string",
        label: "string",
        region: "string",
        rootPass: "string",
        sshPort: "string",
        sshUser: "string",
        stackscript: "string",
        stackscriptData: "string",
        swapSize: "string",
        tags: "string",
        token: "string",
        uaPrefix: "string",
    },
    name: "string",
    nodeTaints: [{
        key: "string",
        value: "string",
        effect: "string",
        timeAdded: "string",
    }],
    opennebulaConfig: {
        password: "string",
        xmlRpcUrl: "string",
        user: "string",
        diskResize: "string",
        networkName: "string",
        imageId: "string",
        imageName: "string",
        imageOwner: "string",
        memory: "string",
        networkId: "string",
        b2dSize: "string",
        networkOwner: "string",
        disableVnc: false,
        sshUser: "string",
        templateId: "string",
        templateName: "string",
        devPrefix: "string",
        vcpu: "string",
        cpu: "string",
    },
    openstackConfig: {
        authUrl: "string",
        region: "string",
        availabilityZone: "string",
        ipVersion: "string",
        netId: "string",
        applicationCredentialName: "string",
        bootFromVolume: false,
        cacert: "string",
        configDrive: false,
        domainId: "string",
        domainName: "string",
        endpointType: "string",
        flavorId: "string",
        flavorName: "string",
        floatingIpPool: "string",
        imageId: "string",
        imageName: "string",
        insecure: false,
        activeTimeout: "string",
        applicationCredentialSecret: "string",
        keypairName: "string",
        netName: "string",
        novaNetwork: false,
        password: "string",
        privateKeyFile: "string",
        applicationCredentialId: "string",
        secGroups: "string",
        sshPort: "string",
        sshUser: "string",
        tenantId: "string",
        tenantName: "string",
        userDataFile: "string",
        username: "string",
        volumeDevicePath: "string",
        volumeId: "string",
        volumeName: "string",
        volumeSize: "string",
        volumeType: "string",
    },
    outscaleConfig: {
        accessKey: "string",
        secretKey: "string",
        extraTagsAlls: ["string"],
        extraTagsInstances: ["string"],
        instanceType: "string",
        region: "string",
        rootDiskIops: 0,
        rootDiskSize: 0,
        rootDiskType: "string",
        securityGroupIds: ["string"],
        sourceOmi: "string",
    },
    useInternalIpAddress: false,
    vsphereConfig: {
        boot2dockerUrl: "string",
        cfgparams: ["string"],
        cloneFrom: "string",
        cloudConfig: "string",
        cloudinit: "string",
        contentLibrary: "string",
        cpuCount: "string",
        creationType: "string",
        customAttributes: ["string"],
        datacenter: "string",
        datastore: "string",
        datastoreCluster: "string",
        diskSize: "string",
        folder: "string",
        gracefulShutdownTimeout: "string",
        hostsystem: "string",
        memorySize: "string",
        networks: ["string"],
        password: "string",
        pool: "string",
        sshPassword: "string",
        sshPort: "string",
        sshUser: "string",
        sshUserGroup: "string",
        tags: ["string"],
        username: "string",
        vappIpAllocationPolicy: "string",
        vappIpProtocol: "string",
        vappProperties: ["string"],
        vappTransport: "string",
        vcenter: "string",
        vcenterPort: "string",
    },
});
Copy
type: rancher2:NodeTemplate
properties:
    amazonec2Config:
        accessKey: string
        ami: string
        blockDurationMinutes: string
        deviceName: string
        encryptEbsVolume: false
        endpoint: string
        httpEndpoint: string
        httpTokens: string
        iamInstanceProfile: string
        insecureTransport: false
        instanceType: string
        kmsKey: string
        monitoring: false
        openPorts:
            - string
        privateAddressOnly: false
        region: string
        requestSpotInstance: false
        retries: string
        rootSize: string
        secretKey: string
        securityGroupReadonly: false
        securityGroups:
            - string
        sessionToken: string
        spotPrice: string
        sshKeypath: string
        sshUser: string
        subnetId: string
        tags: string
        useEbsOptimizedInstance: false
        usePrivateAddress: false
        userdata: string
        volumeType: string
        vpcId: string
        zone: string
    annotations:
        string: string
    authCertificateAuthority: string
    authKey: string
    azureConfig:
        acceleratedNetworking: false
        availabilitySet: string
        availabilityZone: string
        clientId: string
        clientSecret: string
        customData: string
        diskSize: string
        dns: string
        dockerPort: string
        environment: string
        faultDomainCount: string
        image: string
        location: string
        managedDisks: false
        noPublicIp: false
        nsg: string
        openPorts:
            - string
        plan: string
        privateIpAddress: string
        resourceGroup: string
        size: string
        sshUser: string
        staticPublicIp: false
        storageType: string
        subnet: string
        subnetPrefix: string
        subscriptionId: string
        tags: string
        updateDomainCount: string
        usePrivateIp: false
        usePublicIpStandardSku: false
        vnet: string
    cloudCredentialId: string
    description: string
    digitaloceanConfig:
        accessToken: string
        backups: false
        image: string
        ipv6: false
        monitoring: false
        privateNetworking: false
        region: string
        size: string
        sshKeyFingerprint: string
        sshKeyPath: string
        sshPort: string
        sshUser: string
        tags: string
        userdata: string
    driverId: string
    engineEnv:
        string: string
    engineInsecureRegistries:
        - string
    engineInstallUrl: string
    engineLabel:
        string: string
    engineOpt:
        string: string
    engineRegistryMirrors:
        - string
    engineStorageDriver: string
    harvesterConfig:
        cpuCount: string
        diskInfo: string
        memorySize: string
        networkData: string
        networkInfo: string
        sshPassword: string
        sshUser: string
        userData: string
        vmAffinity: string
        vmNamespace: string
    hetznerConfig:
        apiToken: string
        image: string
        networks: string
        serverLabels:
            string: string
        serverLocation: string
        serverType: string
        usePrivateNetwork: false
        userdata: string
        volumes: string
    labels:
        string: string
    linodeConfig:
        authorizedUsers: string
        createPrivateIp: false
        dockerPort: string
        image: string
        instanceType: string
        label: string
        region: string
        rootPass: string
        sshPort: string
        sshUser: string
        stackscript: string
        stackscriptData: string
        swapSize: string
        tags: string
        token: string
        uaPrefix: string
    name: string
    nodeTaints:
        - effect: string
          key: string
          timeAdded: string
          value: string
    opennebulaConfig:
        b2dSize: string
        cpu: string
        devPrefix: string
        disableVnc: false
        diskResize: string
        imageId: string
        imageName: string
        imageOwner: string
        memory: string
        networkId: string
        networkName: string
        networkOwner: string
        password: string
        sshUser: string
        templateId: string
        templateName: string
        user: string
        vcpu: string
        xmlRpcUrl: string
    openstackConfig:
        activeTimeout: string
        applicationCredentialId: string
        applicationCredentialName: string
        applicationCredentialSecret: string
        authUrl: string
        availabilityZone: string
        bootFromVolume: false
        cacert: string
        configDrive: false
        domainId: string
        domainName: string
        endpointType: string
        flavorId: string
        flavorName: string
        floatingIpPool: string
        imageId: string
        imageName: string
        insecure: false
        ipVersion: string
        keypairName: string
        netId: string
        netName: string
        novaNetwork: false
        password: string
        privateKeyFile: string
        region: string
        secGroups: string
        sshPort: string
        sshUser: string
        tenantId: string
        tenantName: string
        userDataFile: string
        username: string
        volumeDevicePath: string
        volumeId: string
        volumeName: string
        volumeSize: string
        volumeType: string
    outscaleConfig:
        accessKey: string
        extraTagsAlls:
            - string
        extraTagsInstances:
            - string
        instanceType: string
        region: string
        rootDiskIops: 0
        rootDiskSize: 0
        rootDiskType: string
        secretKey: string
        securityGroupIds:
            - string
        sourceOmi: string
    useInternalIpAddress: false
    vsphereConfig:
        boot2dockerUrl: string
        cfgparams:
            - string
        cloneFrom: string
        cloudConfig: string
        cloudinit: string
        contentLibrary: string
        cpuCount: string
        creationType: string
        customAttributes:
            - string
        datacenter: string
        datastore: string
        datastoreCluster: string
        diskSize: string
        folder: string
        gracefulShutdownTimeout: string
        hostsystem: string
        memorySize: string
        networks:
            - string
        password: string
        pool: string
        sshPassword: string
        sshPort: string
        sshUser: string
        sshUserGroup: string
        tags:
            - string
        username: string
        vappIpAllocationPolicy: string
        vappIpProtocol: string
        vappProperties:
            - string
        vappTransport: string
        vcenter: string
        vcenterPort: string
Copy

NodeTemplate Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NodeTemplate resource accepts the following input properties:

Amazonec2Config NodeTemplateAmazonec2Config
AWS config for the Node Template (list maxitems:1)
Annotations Dictionary<string, string>
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 Dictionary<string, string>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel Dictionary<string, string>
Engine label for the node template (string)
EngineOpt Dictionary<string, string>
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)
HarvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
HetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
Labels Dictionary<string, string>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

LinodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
Name string
The name of the Node Template (string)
NodeTaints List<NodeTemplateNodeTaint>
Node taints. For Rancher v2.3.3 and above (List)
OpennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
OutscaleConfig NodeTemplateOutscaleConfig
Outscale 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 NodeTemplateAmazonec2ConfigArgs
AWS config for the Node Template (list maxitems:1)
Annotations map[string]string
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 map[string]string
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. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel map[string]string
Engine label for the node template (string)
EngineOpt map[string]string
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)
HarvesterConfig NodeTemplateHarvesterConfigArgs
Harvester config for the Node Template (list maxitems:1)
HetznerConfig NodeTemplateHetznerConfigArgs
Hetzner config for the Node Template (list maxitems:1)
Labels map[string]string

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

LinodeConfig NodeTemplateLinodeConfigArgs
Linode config for the Node Template (list maxitems:1)
Name string
The name of the Node Template (string)
NodeTaints []NodeTemplateNodeTaintArgs
Node taints. For Rancher v2.3.3 and above (List)
OpennebulaConfig NodeTemplateOpennebulaConfigArgs
Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfigArgs
Openstack config for the Node Template (list maxitems:1)
OutscaleConfig NodeTemplateOutscaleConfigArgs
Outscale 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,String>
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,String>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel Map<String,String>
Engine label for the node template (string)
engineOpt Map<String,String>
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)
harvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
hetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
labels Map<String,String>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
name String
The name of the Node Template (string)
nodeTaints List<NodeTemplateNodeTaint>
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
outscaleConfig NodeTemplateOutscaleConfig
Outscale 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)
amazonec2Config NodeTemplateAmazonec2Config
AWS config for the Node Template (list maxitems:1)
annotations {[key: string]: string}
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]: string}
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel {[key: string]: string}
Engine label for the node template (string)
engineOpt {[key: string]: string}
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)
harvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
hetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
labels {[key: string]: string}

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
name string
The name of the Node Template (string)
nodeTaints NodeTemplateNodeTaint[]
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
outscaleConfig NodeTemplateOutscaleConfig
Outscale 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, str]
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, str]
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engine_label Mapping[str, str]
Engine label for the node template (string)
engine_opt Mapping[str, str]
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)
harvester_config NodeTemplateHarvesterConfigArgs
Harvester config for the Node Template (list maxitems:1)
hetzner_config NodeTemplateHetznerConfigArgs
Hetzner config for the Node Template (list maxitems:1)
labels Mapping[str, str]

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linode_config NodeTemplateLinodeConfigArgs
Linode config for the Node Template (list maxitems:1)
name str
The name of the Node Template (string)
node_taints Sequence[NodeTemplateNodeTaintArgs]
Node taints. For Rancher v2.3.3 and above (List)
opennebula_config NodeTemplateOpennebulaConfigArgs
Opennebula config for the Node Template (list maxitems:1)
openstack_config NodeTemplateOpenstackConfigArgs
Openstack config for the Node Template (list maxitems:1)
outscale_config NodeTemplateOutscaleConfigArgs
Outscale 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)
amazonec2Config Property Map
AWS config for the Node Template (list maxitems:1)
annotations Map<String>
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 Property Map
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 Property Map
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>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel Map<String>
Engine label for the node template (string)
engineOpt Map<String>
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)
harvesterConfig Property Map
Harvester config for the Node Template (list maxitems:1)
hetznerConfig Property Map
Hetzner config for the Node Template (list maxitems:1)
labels Map<String>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig Property Map
Linode config for the Node Template (list maxitems:1)
name String
The name of the Node Template (string)
nodeTaints List<Property Map>
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig Property Map
Opennebula config for the Node Template (list maxitems:1)
openstackConfig Property Map
Openstack config for the Node Template (list maxitems:1)
outscaleConfig Property Map
Outscale config for the Node Template (list maxitems:1)
useInternalIpAddress Boolean
Engine storage driver for the node template (bool)
vsphereConfig Property Map
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 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.
driver String
(Computed) The driver of the node template (string)
id String
The provider-assigned unique ID for this managed resource.

Look up 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, str]] = 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, str]] = None,
        engine_insecure_registries: Optional[Sequence[str]] = None,
        engine_install_url: Optional[str] = None,
        engine_label: Optional[Mapping[str, str]] = None,
        engine_opt: Optional[Mapping[str, str]] = None,
        engine_registry_mirrors: Optional[Sequence[str]] = None,
        engine_storage_driver: Optional[str] = None,
        harvester_config: Optional[NodeTemplateHarvesterConfigArgs] = None,
        hetzner_config: Optional[NodeTemplateHetznerConfigArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        linode_config: Optional[NodeTemplateLinodeConfigArgs] = None,
        name: Optional[str] = None,
        node_taints: Optional[Sequence[NodeTemplateNodeTaintArgs]] = None,
        opennebula_config: Optional[NodeTemplateOpennebulaConfigArgs] = None,
        openstack_config: Optional[NodeTemplateOpenstackConfigArgs] = None,
        outscale_config: Optional[NodeTemplateOutscaleConfigArgs] = 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)
public static NodeTemplate get(String name, Output<String> id, NodeTemplateState state, CustomResourceOptions options)
resources:  _:    type: rancher2:NodeTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 NodeTemplateAmazonec2Config
AWS config for the Node Template (list maxitems:1)
Annotations Dictionary<string, string>
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 Dictionary<string, string>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel Dictionary<string, string>
Engine label for the node template (string)
EngineOpt Dictionary<string, string>
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)
HarvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
HetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
Labels Dictionary<string, string>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

LinodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
Name string
The name of the Node Template (string)
NodeTaints List<NodeTemplateNodeTaint>
Node taints. For Rancher v2.3.3 and above (List)
OpennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
OutscaleConfig NodeTemplateOutscaleConfig
Outscale 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 NodeTemplateAmazonec2ConfigArgs
AWS config for the Node Template (list maxitems:1)
Annotations map[string]string
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 map[string]string
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. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel map[string]string
Engine label for the node template (string)
EngineOpt map[string]string
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)
HarvesterConfig NodeTemplateHarvesterConfigArgs
Harvester config for the Node Template (list maxitems:1)
HetznerConfig NodeTemplateHetznerConfigArgs
Hetzner config for the Node Template (list maxitems:1)
Labels map[string]string

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

LinodeConfig NodeTemplateLinodeConfigArgs
Linode config for the Node Template (list maxitems:1)
Name string
The name of the Node Template (string)
NodeTaints []NodeTemplateNodeTaintArgs
Node taints. For Rancher v2.3.3 and above (List)
OpennebulaConfig NodeTemplateOpennebulaConfigArgs
Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfigArgs
Openstack config for the Node Template (list maxitems:1)
OutscaleConfig NodeTemplateOutscaleConfigArgs
Outscale 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,String>
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,String>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel Map<String,String>
Engine label for the node template (string)
engineOpt Map<String,String>
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)
harvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
hetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
labels Map<String,String>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
name String
The name of the Node Template (string)
nodeTaints List<NodeTemplateNodeTaint>
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
outscaleConfig NodeTemplateOutscaleConfig
Outscale 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)
amazonec2Config NodeTemplateAmazonec2Config
AWS config for the Node Template (list maxitems:1)
annotations {[key: string]: string}
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]: string}
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel {[key: string]: string}
Engine label for the node template (string)
engineOpt {[key: string]: string}
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)
harvesterConfig NodeTemplateHarvesterConfig
Harvester config for the Node Template (list maxitems:1)
hetznerConfig NodeTemplateHetznerConfig
Hetzner config for the Node Template (list maxitems:1)
labels {[key: string]: string}

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig NodeTemplateLinodeConfig
Linode config for the Node Template (list maxitems:1)
name string
The name of the Node Template (string)
nodeTaints NodeTemplateNodeTaint[]
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig NodeTemplateOpennebulaConfig
Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig
Openstack config for the Node Template (list maxitems:1)
outscaleConfig NodeTemplateOutscaleConfig
Outscale 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, str]
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, str]
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engine_label Mapping[str, str]
Engine label for the node template (string)
engine_opt Mapping[str, str]
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)
harvester_config NodeTemplateHarvesterConfigArgs
Harvester config for the Node Template (list maxitems:1)
hetzner_config NodeTemplateHetznerConfigArgs
Hetzner config for the Node Template (list maxitems:1)
labels Mapping[str, str]

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linode_config NodeTemplateLinodeConfigArgs
Linode config for the Node Template (list maxitems:1)
name str
The name of the Node Template (string)
node_taints Sequence[NodeTemplateNodeTaintArgs]
Node taints. For Rancher v2.3.3 and above (List)
opennebula_config NodeTemplateOpennebulaConfigArgs
Opennebula config for the Node Template (list maxitems:1)
openstack_config NodeTemplateOpenstackConfigArgs
Openstack config for the Node Template (list maxitems:1)
outscale_config NodeTemplateOutscaleConfigArgs
Outscale 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)
amazonec2Config Property Map
AWS config for the Node Template (list maxitems:1)
annotations Map<String>
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 Property Map
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 Property Map
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>
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. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel Map<String>
Engine label for the node template (string)
engineOpt Map<String>
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)
harvesterConfig Property Map
Harvester config for the Node Template (list maxitems:1)
hetznerConfig Property Map
Hetzner config for the Node Template (list maxitems:1)
labels Map<String>

Labels for Node Template object (map)

Note: labels and node_taints will be applied to nodes deployed using the Node Template

linodeConfig Property Map
Linode config for the Node Template (list maxitems:1)
name String
The name of the Node Template (string)
nodeTaints List<Property Map>
Node taints. For Rancher v2.3.3 and above (List)
opennebulaConfig Property Map
Opennebula config for the Node Template (list maxitems:1)
openstackConfig Property Map
Openstack config for the Node Template (list maxitems:1)
outscaleConfig Property Map
Outscale config for the Node Template (list maxitems:1)
useInternalIpAddress Boolean
Engine storage driver for the node template (bool)
vsphereConfig Property Map
vSphere config for the Node Template (list maxitems:1)

Supporting Types

NodeTemplateAmazonec2Config
, NodeTemplateAmazonec2ConfigArgs

Ami This property is required. string
AWS machine image
Region This property is required. string
AWS Region
SecurityGroups This property is required. List<string>
AWS VPC security group
SubnetId This property is required. string
AWS VPC subnet id
VpcId This property is required. string
AWS VPC id
Zone This property is required. string
AWS zone for instance (i.e. a,b,c,d,e)
AccessKey string
AWS Access Key
BlockDurationMinutes string
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
DeviceName string
AWS root device name
EncryptEbsVolume bool
Encrypt EBS volume
Endpoint string
Optional endpoint URL (hostname only or fully qualified URI)
HttpEndpoint string
Enables or disables the HTTP metadata endpoint on your instances
HttpTokens string
The state of token usage for your instance metadata requests
IamInstanceProfile string
AWS IAM Instance Profile
InsecureTransport bool
Disable SSL when sending requests
InstanceType string
AWS instance type
KmsKey string
Custom KMS key ID using the AWS Managed CMK
Monitoring bool
Set this flag to enable CloudWatch monitoring
OpenPorts List<string>
Make the specified port number accessible from the Internet
PrivateAddressOnly bool
Only use a private IP address
RequestSpotInstance bool
Set this flag to request spot instance
Retries string
Set retry count for recoverable failures (use -1 to disable)
RootSize string
AWS root disk size (in GB)
SecretKey string
AWS Secret Key
SecurityGroupReadonly bool
Skip adding default rules to security groups
SessionToken string
AWS Session Token
SpotPrice string
AWS spot instance bid price (in dollar)
SshKeypath string
SSH Key for Instance
SshUser string
Set the name of the ssh user
Tags string
AWS Tags (e.g. key1,value1,key2,value2)
UseEbsOptimizedInstance bool
Create an EBS optimized instance
UsePrivateAddress bool
Force the usage of private IP address
Userdata string
Path to file with cloud-init user data
VolumeType string
Amazon EBS volume type
Ami This property is required. string
AWS machine image
Region This property is required. string
AWS Region
SecurityGroups This property is required. []string
AWS VPC security group
SubnetId This property is required. string
AWS VPC subnet id
VpcId This property is required. string
AWS VPC id
Zone This property is required. string
AWS zone for instance (i.e. a,b,c,d,e)
AccessKey string
AWS Access Key
BlockDurationMinutes string
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
DeviceName string
AWS root device name
EncryptEbsVolume bool
Encrypt EBS volume
Endpoint string
Optional endpoint URL (hostname only or fully qualified URI)
HttpEndpoint string
Enables or disables the HTTP metadata endpoint on your instances
HttpTokens string
The state of token usage for your instance metadata requests
IamInstanceProfile string
AWS IAM Instance Profile
InsecureTransport bool
Disable SSL when sending requests
InstanceType string
AWS instance type
KmsKey string
Custom KMS key ID using the AWS Managed CMK
Monitoring bool
Set this flag to enable CloudWatch monitoring
OpenPorts []string
Make the specified port number accessible from the Internet
PrivateAddressOnly bool
Only use a private IP address
RequestSpotInstance bool
Set this flag to request spot instance
Retries string
Set retry count for recoverable failures (use -1 to disable)
RootSize string
AWS root disk size (in GB)
SecretKey string
AWS Secret Key
SecurityGroupReadonly bool
Skip adding default rules to security groups
SessionToken string
AWS Session Token
SpotPrice string
AWS spot instance bid price (in dollar)
SshKeypath string
SSH Key for Instance
SshUser string
Set the name of the ssh user
Tags string
AWS Tags (e.g. key1,value1,key2,value2)
UseEbsOptimizedInstance bool
Create an EBS optimized instance
UsePrivateAddress bool
Force the usage of private IP address
Userdata string
Path to file with cloud-init user data
VolumeType string
Amazon EBS volume type
ami This property is required. String
AWS machine image
region This property is required. String
AWS Region
securityGroups This property is required. List<String>
AWS VPC security group
subnetId This property is required. String
AWS VPC subnet id
vpcId This property is required. String
AWS VPC id
zone This property is required. String
AWS zone for instance (i.e. a,b,c,d,e)
accessKey String
AWS Access Key
blockDurationMinutes String
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
deviceName String
AWS root device name
encryptEbsVolume Boolean
Encrypt EBS volume
endpoint String
Optional endpoint URL (hostname only or fully qualified URI)
httpEndpoint String
Enables or disables the HTTP metadata endpoint on your instances
httpTokens String
The state of token usage for your instance metadata requests
iamInstanceProfile String
AWS IAM Instance Profile
insecureTransport Boolean
Disable SSL when sending requests
instanceType String
AWS instance type
kmsKey String
Custom KMS key ID using the AWS Managed CMK
monitoring Boolean
Set this flag to enable CloudWatch monitoring
openPorts List<String>
Make the specified port number accessible from the Internet
privateAddressOnly Boolean
Only use a private IP address
requestSpotInstance Boolean
Set this flag to request spot instance
retries String
Set retry count for recoverable failures (use -1 to disable)
rootSize String
AWS root disk size (in GB)
secretKey String
AWS Secret Key
securityGroupReadonly Boolean
Skip adding default rules to security groups
sessionToken String
AWS Session Token
spotPrice String
AWS spot instance bid price (in dollar)
sshKeypath String
SSH Key for Instance
sshUser String
Set the name of the ssh user
tags String
AWS Tags (e.g. key1,value1,key2,value2)
useEbsOptimizedInstance Boolean
Create an EBS optimized instance
usePrivateAddress Boolean
Force the usage of private IP address
userdata String
Path to file with cloud-init user data
volumeType String
Amazon EBS volume type
ami This property is required. string
AWS machine image
region This property is required. string
AWS Region
securityGroups This property is required. string[]
AWS VPC security group
subnetId This property is required. string
AWS VPC subnet id
vpcId This property is required. string
AWS VPC id
zone This property is required. string
AWS zone for instance (i.e. a,b,c,d,e)
accessKey string
AWS Access Key
blockDurationMinutes string
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
deviceName string
AWS root device name
encryptEbsVolume boolean
Encrypt EBS volume
endpoint string
Optional endpoint URL (hostname only or fully qualified URI)
httpEndpoint string
Enables or disables the HTTP metadata endpoint on your instances
httpTokens string
The state of token usage for your instance metadata requests
iamInstanceProfile string
AWS IAM Instance Profile
insecureTransport boolean
Disable SSL when sending requests
instanceType string
AWS instance type
kmsKey string
Custom KMS key ID using the AWS Managed CMK
monitoring boolean
Set this flag to enable CloudWatch monitoring
openPorts string[]
Make the specified port number accessible from the Internet
privateAddressOnly boolean
Only use a private IP address
requestSpotInstance boolean
Set this flag to request spot instance
retries string
Set retry count for recoverable failures (use -1 to disable)
rootSize string
AWS root disk size (in GB)
secretKey string
AWS Secret Key
securityGroupReadonly boolean
Skip adding default rules to security groups
sessionToken string
AWS Session Token
spotPrice string
AWS spot instance bid price (in dollar)
sshKeypath string
SSH Key for Instance
sshUser string
Set the name of the ssh user
tags string
AWS Tags (e.g. key1,value1,key2,value2)
useEbsOptimizedInstance boolean
Create an EBS optimized instance
usePrivateAddress boolean
Force the usage of private IP address
userdata string
Path to file with cloud-init user data
volumeType string
Amazon EBS volume type
ami This property is required. str
AWS machine image
region This property is required. str
AWS Region
security_groups This property is required. Sequence[str]
AWS VPC security group
subnet_id This property is required. str
AWS VPC subnet id
vpc_id This property is required. str
AWS VPC id
zone This property is required. str
AWS zone for instance (i.e. a,b,c,d,e)
access_key str
AWS Access Key
block_duration_minutes str
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
device_name str
AWS root device name
encrypt_ebs_volume bool
Encrypt EBS volume
endpoint str
Optional endpoint URL (hostname only or fully qualified URI)
http_endpoint str
Enables or disables the HTTP metadata endpoint on your instances
http_tokens str
The state of token usage for your instance metadata requests
iam_instance_profile str
AWS IAM Instance Profile
insecure_transport bool
Disable SSL when sending requests
instance_type str
AWS instance type
kms_key str
Custom KMS key ID using the AWS Managed CMK
monitoring bool
Set this flag to enable CloudWatch monitoring
open_ports Sequence[str]
Make the specified port number accessible from the Internet
private_address_only bool
Only use a private IP address
request_spot_instance bool
Set this flag to request spot instance
retries str
Set retry count for recoverable failures (use -1 to disable)
root_size str
AWS root disk size (in GB)
secret_key str
AWS Secret Key
security_group_readonly bool
Skip adding default rules to security groups
session_token str
AWS Session Token
spot_price str
AWS spot instance bid price (in dollar)
ssh_keypath str
SSH Key for Instance
ssh_user str
Set the name of the ssh user
tags str
AWS Tags (e.g. key1,value1,key2,value2)
use_ebs_optimized_instance bool
Create an EBS optimized instance
use_private_address bool
Force the usage of private IP address
userdata str
Path to file with cloud-init user data
volume_type str
Amazon EBS volume type
ami This property is required. String
AWS machine image
region This property is required. String
AWS Region
securityGroups This property is required. List<String>
AWS VPC security group
subnetId This property is required. String
AWS VPC subnet id
vpcId This property is required. String
AWS VPC id
zone This property is required. String
AWS zone for instance (i.e. a,b,c,d,e)
accessKey String
AWS Access Key
blockDurationMinutes String
AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360)
deviceName String
AWS root device name
encryptEbsVolume Boolean
Encrypt EBS volume
endpoint String
Optional endpoint URL (hostname only or fully qualified URI)
httpEndpoint String
Enables or disables the HTTP metadata endpoint on your instances
httpTokens String
The state of token usage for your instance metadata requests
iamInstanceProfile String
AWS IAM Instance Profile
insecureTransport Boolean
Disable SSL when sending requests
instanceType String
AWS instance type
kmsKey String
Custom KMS key ID using the AWS Managed CMK
monitoring Boolean
Set this flag to enable CloudWatch monitoring
openPorts List<String>
Make the specified port number accessible from the Internet
privateAddressOnly Boolean
Only use a private IP address
requestSpotInstance Boolean
Set this flag to request spot instance
retries String
Set retry count for recoverable failures (use -1 to disable)
rootSize String
AWS root disk size (in GB)
secretKey String
AWS Secret Key
securityGroupReadonly Boolean
Skip adding default rules to security groups
sessionToken String
AWS Session Token
spotPrice String
AWS spot instance bid price (in dollar)
sshKeypath String
SSH Key for Instance
sshUser String
Set the name of the ssh user
tags String
AWS Tags (e.g. key1,value1,key2,value2)
useEbsOptimizedInstance Boolean
Create an EBS optimized instance
usePrivateAddress Boolean
Force the usage of private IP address
userdata String
Path to file with cloud-init user data
volumeType String
Amazon EBS volume type

NodeTemplateAzureConfig
, NodeTemplateAzureConfigArgs

AcceleratedNetworking bool
Enable Accelerated Networking when creating an Azure Network Interface
AvailabilitySet string
Azure Availability Set to place the virtual machine into
AvailabilityZone string
The Azure Availability Zone the VM should be created in
ClientId string
Azure Service Principal Account ID (optional, browser auth is used if not specified)
ClientSecret string
Azure Service Principal Account password (optional, browser auth is used if not specified)
CustomData string
Path to file with custom-data
DiskSize string
Disk size if using managed disk
Dns string
A unique DNS label for the public IP adddress
DockerPort string
Port number for Docker engine
Environment string
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
FaultDomainCount string
Fault domain count to use for availability set
Image string
Azure virtual machine OS image
Location string
Azure region to create the virtual machine
ManagedDisks bool
Configures VM and availability set for managed disks
NoPublicIp bool
Do not create a public IP address for the machine
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)
OpenPorts List<string>
Make the specified port number accessible from the Internet
Plan string
Purchase plan for Azure Virtual Machine (in :: format)
PrivateIpAddress string
Specify a static private IP address for the machine
ResourceGroup string
Azure Resource Group name (will be created if missing)
Size string
Size for Azure Virtual Machine
SshUser string
Username for SSH login
StaticPublicIp bool
Assign a static public IP address to the machine
StorageType string
Type of Storage Account to host the OS Disk for the machine
Subnet string
Azure Subnet Name to be used within the Virtual Network
SubnetPrefix string
Private CIDR block to be used for the new subnet, should comply RFC 1918
SubscriptionId string
Azure Subscription ID
Tags string
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
UpdateDomainCount string
Update domain count to use for availability set
UsePrivateIp bool
Use private IP address of the machine to connect
UsePublicIpStandardSku bool
Use the Standard SKU when creating a public IP for an Azure VM
Vnet string
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)
AcceleratedNetworking bool
Enable Accelerated Networking when creating an Azure Network Interface
AvailabilitySet string
Azure Availability Set to place the virtual machine into
AvailabilityZone string
The Azure Availability Zone the VM should be created in
ClientId string
Azure Service Principal Account ID (optional, browser auth is used if not specified)
ClientSecret string
Azure Service Principal Account password (optional, browser auth is used if not specified)
CustomData string
Path to file with custom-data
DiskSize string
Disk size if using managed disk
Dns string
A unique DNS label for the public IP adddress
DockerPort string
Port number for Docker engine
Environment string
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
FaultDomainCount string
Fault domain count to use for availability set
Image string
Azure virtual machine OS image
Location string
Azure region to create the virtual machine
ManagedDisks bool
Configures VM and availability set for managed disks
NoPublicIp bool
Do not create a public IP address for the machine
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)
OpenPorts []string
Make the specified port number accessible from the Internet
Plan string
Purchase plan for Azure Virtual Machine (in :: format)
PrivateIpAddress string
Specify a static private IP address for the machine
ResourceGroup string
Azure Resource Group name (will be created if missing)
Size string
Size for Azure Virtual Machine
SshUser string
Username for SSH login
StaticPublicIp bool
Assign a static public IP address to the machine
StorageType string
Type of Storage Account to host the OS Disk for the machine
Subnet string
Azure Subnet Name to be used within the Virtual Network
SubnetPrefix string
Private CIDR block to be used for the new subnet, should comply RFC 1918
SubscriptionId string
Azure Subscription ID
Tags string
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
UpdateDomainCount string
Update domain count to use for availability set
UsePrivateIp bool
Use private IP address of the machine to connect
UsePublicIpStandardSku bool
Use the Standard SKU when creating a public IP for an Azure VM
Vnet string
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)
acceleratedNetworking Boolean
Enable Accelerated Networking when creating an Azure Network Interface
availabilitySet String
Azure Availability Set to place the virtual machine into
availabilityZone String
The Azure Availability Zone the VM should be created in
clientId String
Azure Service Principal Account ID (optional, browser auth is used if not specified)
clientSecret String
Azure Service Principal Account password (optional, browser auth is used if not specified)
customData String
Path to file with custom-data
diskSize String
Disk size if using managed disk
dns String
A unique DNS label for the public IP adddress
dockerPort String
Port number for Docker engine
environment String
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
faultDomainCount String
Fault domain count to use for availability set
image String
Azure virtual machine OS image
location String
Azure region to create the virtual machine
managedDisks Boolean
Configures VM and availability set for managed disks
noPublicIp Boolean
Do not create a public IP address for the machine
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)
openPorts List<String>
Make the specified port number accessible from the Internet
plan String
Purchase plan for Azure Virtual Machine (in :: format)
privateIpAddress String
Specify a static private IP address for the machine
resourceGroup String
Azure Resource Group name (will be created if missing)
size String
Size for Azure Virtual Machine
sshUser String
Username for SSH login
staticPublicIp Boolean
Assign a static public IP address to the machine
storageType String
Type of Storage Account to host the OS Disk for the machine
subnet String
Azure Subnet Name to be used within the Virtual Network
subnetPrefix String
Private CIDR block to be used for the new subnet, should comply RFC 1918
subscriptionId String
Azure Subscription ID
tags String
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
updateDomainCount String
Update domain count to use for availability set
usePrivateIp Boolean
Use private IP address of the machine to connect
usePublicIpStandardSku Boolean
Use the Standard SKU when creating a public IP for an Azure VM
vnet String
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)
acceleratedNetworking boolean
Enable Accelerated Networking when creating an Azure Network Interface
availabilitySet string
Azure Availability Set to place the virtual machine into
availabilityZone string
The Azure Availability Zone the VM should be created in
clientId string
Azure Service Principal Account ID (optional, browser auth is used if not specified)
clientSecret string
Azure Service Principal Account password (optional, browser auth is used if not specified)
customData string
Path to file with custom-data
diskSize string
Disk size if using managed disk
dns string
A unique DNS label for the public IP adddress
dockerPort string
Port number for Docker engine
environment string
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
faultDomainCount string
Fault domain count to use for availability set
image string
Azure virtual machine OS image
location string
Azure region to create the virtual machine
managedDisks boolean
Configures VM and availability set for managed disks
noPublicIp boolean
Do not create a public IP address for the machine
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)
openPorts string[]
Make the specified port number accessible from the Internet
plan string
Purchase plan for Azure Virtual Machine (in :: format)
privateIpAddress string
Specify a static private IP address for the machine
resourceGroup string
Azure Resource Group name (will be created if missing)
size string
Size for Azure Virtual Machine
sshUser string
Username for SSH login
staticPublicIp boolean
Assign a static public IP address to the machine
storageType string
Type of Storage Account to host the OS Disk for the machine
subnet string
Azure Subnet Name to be used within the Virtual Network
subnetPrefix string
Private CIDR block to be used for the new subnet, should comply RFC 1918
subscriptionId string
Azure Subscription ID
tags string
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
updateDomainCount string
Update domain count to use for availability set
usePrivateIp boolean
Use private IP address of the machine to connect
usePublicIpStandardSku boolean
Use the Standard SKU when creating a public IP for an Azure VM
vnet string
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)
accelerated_networking bool
Enable Accelerated Networking when creating an Azure Network Interface
availability_set str
Azure Availability Set to place the virtual machine into
availability_zone str
The Azure Availability Zone the VM should be created in
client_id str
Azure Service Principal Account ID (optional, browser auth is used if not specified)
client_secret str
Azure Service Principal Account password (optional, browser auth is used if not specified)
custom_data str
Path to file with custom-data
disk_size str
Disk size if using managed disk
dns str
A unique DNS label for the public IP adddress
docker_port str
Port number for Docker engine
environment str
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
fault_domain_count str
Fault domain count to use for availability set
image str
Azure virtual machine OS image
location str
Azure region to create the virtual machine
managed_disks bool
Configures VM and availability set for managed disks
no_public_ip bool
Do not create a public IP address for the machine
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)
open_ports Sequence[str]
Make the specified port number accessible from the Internet
plan str
Purchase plan for Azure Virtual Machine (in :: format)
private_ip_address str
Specify a static private IP address for the machine
resource_group str
Azure Resource Group name (will be created if missing)
size str
Size for Azure Virtual Machine
ssh_user str
Username for SSH login
static_public_ip bool
Assign a static public IP address to the machine
storage_type str
Type of Storage Account to host the OS Disk for the machine
subnet str
Azure Subnet Name to be used within the Virtual Network
subnet_prefix str
Private CIDR block to be used for the new subnet, should comply RFC 1918
subscription_id str
Azure Subscription ID
tags str
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
update_domain_count str
Update domain count to use for availability set
use_private_ip bool
Use private IP address of the machine to connect
use_public_ip_standard_sku bool
Use the Standard SKU when creating a public IP for an Azure VM
vnet str
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)
acceleratedNetworking Boolean
Enable Accelerated Networking when creating an Azure Network Interface
availabilitySet String
Azure Availability Set to place the virtual machine into
availabilityZone String
The Azure Availability Zone the VM should be created in
clientId String
Azure Service Principal Account ID (optional, browser auth is used if not specified)
clientSecret String
Azure Service Principal Account password (optional, browser auth is used if not specified)
customData String
Path to file with custom-data
diskSize String
Disk size if using managed disk
dns String
A unique DNS label for the public IP adddress
dockerPort String
Port number for Docker engine
environment String
Azure environment (e.g. AzurePublicCloud, AzureChinaCloud)
faultDomainCount String
Fault domain count to use for availability set
image String
Azure virtual machine OS image
location String
Azure region to create the virtual machine
managedDisks Boolean
Configures VM and availability set for managed disks
noPublicIp Boolean
Do not create a public IP address for the machine
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)
openPorts List<String>
Make the specified port number accessible from the Internet
plan String
Purchase plan for Azure Virtual Machine (in :: format)
privateIpAddress String
Specify a static private IP address for the machine
resourceGroup String
Azure Resource Group name (will be created if missing)
size String
Size for Azure Virtual Machine
sshUser String
Username for SSH login
staticPublicIp Boolean
Assign a static public IP address to the machine
storageType String
Type of Storage Account to host the OS Disk for the machine
subnet String
Azure Subnet Name to be used within the Virtual Network
subnetPrefix String
Private CIDR block to be used for the new subnet, should comply RFC 1918
subscriptionId String
Azure Subscription ID
tags String
Tags to be applied to the Azure VM instance (e.g. key1,value1,key2,value2)
updateDomainCount String
Update domain count to use for availability set
usePrivateIp Boolean
Use private IP address of the machine to connect
usePublicIpStandardSku Boolean
Use the Standard SKU when creating a public IP for an Azure VM
vnet String
Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format)

NodeTemplateDigitaloceanConfig
, NodeTemplateDigitaloceanConfigArgs

AccessToken string
Digital Ocean access token
Backups bool
Enable backups for droplet
Image string
Digital Ocean Image
Ipv6 bool
Enable ipv6 for droplet
Monitoring bool
Enable monitoring for droplet
PrivateNetworking bool
Enable private networking for droplet
Region string
Digital Ocean region
Size string
Digital Ocean size
SshKeyFingerprint string
SSH key fingerprint
SshKeyPath string
SSH private key path
SshPort string
SSH port
SshUser string
SSH username
Tags string
Comma-separated list of tags to apply to the Droplet
Userdata string
Path to file with cloud-init user-data
AccessToken string
Digital Ocean access token
Backups bool
Enable backups for droplet
Image string
Digital Ocean Image
Ipv6 bool
Enable ipv6 for droplet
Monitoring bool
Enable monitoring for droplet
PrivateNetworking bool
Enable private networking for droplet
Region string
Digital Ocean region
Size string
Digital Ocean size
SshKeyFingerprint string
SSH key fingerprint
SshKeyPath string
SSH private key path
SshPort string
SSH port
SshUser string
SSH username
Tags string
Comma-separated list of tags to apply to the Droplet
Userdata string
Path to file with cloud-init user-data
accessToken String
Digital Ocean access token
backups Boolean
Enable backups for droplet
image String
Digital Ocean Image
ipv6 Boolean
Enable ipv6 for droplet
monitoring Boolean
Enable monitoring for droplet
privateNetworking Boolean
Enable private networking for droplet
region String
Digital Ocean region
size String
Digital Ocean size
sshKeyFingerprint String
SSH key fingerprint
sshKeyPath String
SSH private key path
sshPort String
SSH port
sshUser String
SSH username
tags String
Comma-separated list of tags to apply to the Droplet
userdata String
Path to file with cloud-init user-data
accessToken string
Digital Ocean access token
backups boolean
Enable backups for droplet
image string
Digital Ocean Image
ipv6 boolean
Enable ipv6 for droplet
monitoring boolean
Enable monitoring for droplet
privateNetworking boolean
Enable private networking for droplet
region string
Digital Ocean region
size string
Digital Ocean size
sshKeyFingerprint string
SSH key fingerprint
sshKeyPath string
SSH private key path
sshPort string
SSH port
sshUser string
SSH username
tags string
Comma-separated list of tags to apply to the Droplet
userdata string
Path to file with cloud-init user-data
access_token str
Digital Ocean access token
backups bool
Enable backups for droplet
image str
Digital Ocean Image
ipv6 bool
Enable ipv6 for droplet
monitoring bool
Enable monitoring for droplet
private_networking bool
Enable private networking for droplet
region str
Digital Ocean region
size str
Digital Ocean size
ssh_key_fingerprint str
SSH key fingerprint
ssh_key_path str
SSH private key path
ssh_port str
SSH port
ssh_user str
SSH username
tags str
Comma-separated list of tags to apply to the Droplet
userdata str
Path to file with cloud-init user-data
accessToken String
Digital Ocean access token
backups Boolean
Enable backups for droplet
image String
Digital Ocean Image
ipv6 Boolean
Enable ipv6 for droplet
monitoring Boolean
Enable monitoring for droplet
privateNetworking Boolean
Enable private networking for droplet
region String
Digital Ocean region
size String
Digital Ocean size
sshKeyFingerprint String
SSH key fingerprint
sshKeyPath String
SSH private key path
sshPort String
SSH port
sshUser String
SSH username
tags String
Comma-separated list of tags to apply to the Droplet
userdata String
Path to file with cloud-init user-data

NodeTemplateHarvesterConfig
, NodeTemplateHarvesterConfigArgs

SshUser This property is required. string
SSH username
VmNamespace This property is required. string
Virtual machine namespace
CpuCount string
CPU count
DiskBus string
Disk bus

Deprecated: Use disk_info instead

DiskInfo string
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
DiskSize string
Disk size (in GiB)

Deprecated: Use disk_info instead

ImageName string
Image name

Deprecated: Use disk_info instead

MemorySize string
Memory size (in GiB)
NetworkData string
NetworkData content of cloud-init, base64 is supported
NetworkInfo string
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
NetworkModel string
Network model

Deprecated: Use network_info instead

NetworkName string
Network name

Deprecated: Use network_info instead

SshPassword string
SSH password
UserData string
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
VmAffinity string
VM affinity, base64 is supported
SshUser This property is required. string
SSH username
VmNamespace This property is required. string
Virtual machine namespace
CpuCount string
CPU count
DiskBus string
Disk bus

Deprecated: Use disk_info instead

DiskInfo string
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
DiskSize string
Disk size (in GiB)

Deprecated: Use disk_info instead

ImageName string
Image name

Deprecated: Use disk_info instead

MemorySize string
Memory size (in GiB)
NetworkData string
NetworkData content of cloud-init, base64 is supported
NetworkInfo string
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
NetworkModel string
Network model

Deprecated: Use network_info instead

NetworkName string
Network name

Deprecated: Use network_info instead

SshPassword string
SSH password
UserData string
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
VmAffinity string
VM affinity, base64 is supported
sshUser This property is required. String
SSH username
vmNamespace This property is required. String
Virtual machine namespace
cpuCount String
CPU count
diskBus String
Disk bus

Deprecated: Use disk_info instead

diskInfo String
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
diskSize String
Disk size (in GiB)

Deprecated: Use disk_info instead

imageName String
Image name

Deprecated: Use disk_info instead

memorySize String
Memory size (in GiB)
networkData String
NetworkData content of cloud-init, base64 is supported
networkInfo String
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
networkModel String
Network model

Deprecated: Use network_info instead

networkName String
Network name

Deprecated: Use network_info instead

sshPassword String
SSH password
userData String
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
vmAffinity String
VM affinity, base64 is supported
sshUser This property is required. string
SSH username
vmNamespace This property is required. string
Virtual machine namespace
cpuCount string
CPU count
diskBus string
Disk bus

Deprecated: Use disk_info instead

diskInfo string
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
diskSize string
Disk size (in GiB)

Deprecated: Use disk_info instead

imageName string
Image name

Deprecated: Use disk_info instead

memorySize string
Memory size (in GiB)
networkData string
NetworkData content of cloud-init, base64 is supported
networkInfo string
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
networkModel string
Network model

Deprecated: Use network_info instead

networkName string
Network name

Deprecated: Use network_info instead

sshPassword string
SSH password
userData string
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
vmAffinity string
VM affinity, base64 is supported
ssh_user This property is required. str
SSH username
vm_namespace This property is required. str
Virtual machine namespace
cpu_count str
CPU count
disk_bus str
Disk bus

Deprecated: Use disk_info instead

disk_info str
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
disk_size str
Disk size (in GiB)

Deprecated: Use disk_info instead

image_name str
Image name

Deprecated: Use disk_info instead

memory_size str
Memory size (in GiB)
network_data str
NetworkData content of cloud-init, base64 is supported
network_info str
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
network_model str
Network model

Deprecated: Use network_info instead

network_name str
Network name

Deprecated: Use network_info instead

ssh_password str
SSH password
user_data str
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
vm_affinity str
VM affinity, base64 is supported
sshUser This property is required. String
SSH username
vmNamespace This property is required. String
Virtual machine namespace
cpuCount String
CPU count
diskBus String
Disk bus

Deprecated: Use disk_info instead

diskInfo String
A JSON string specifying info for the disks e.g. {"disks":[{"imageName":"harvester-public/image-57hzg","bootOrder":1,"size":40},{"storageClassName":"node-driver-test","bootOrder":2,"size":1}]}
diskSize String
Disk size (in GiB)

Deprecated: Use disk_info instead

imageName String
Image name

Deprecated: Use disk_info instead

memorySize String
Memory size (in GiB)
networkData String
NetworkData content of cloud-init, base64 is supported
networkInfo String
A JSON string specifying info for the networks e.g. {"interfaces":[{"networkName":"harvester-public/vlan1"},{"networkName":"harvester-public/vlan2"}]}
networkModel String
Network model

Deprecated: Use network_info instead

networkName String
Network name

Deprecated: Use network_info instead

sshPassword String
SSH password
userData String
UserData content of cloud-init, base64 is supported. If the image does not contain the qemu-guest-agent package, you must install and start qemu-guest-agent using userdata
vmAffinity String
VM affinity, base64 is supported

NodeTemplateHetznerConfig
, NodeTemplateHetznerConfigArgs

ApiToken This property is required. string
Hetzner Cloud project API token
Image string
Hetzner Cloud server image
Networks string
Comma-separated list of network IDs or names which should be attached to the server private network interface
ServerLabels Dictionary<string, string>
Map of the labels which will be assigned to the server
ServerLocation string
Hetzner Cloud datacenter
ServerType string
Hetzner Cloud server type
UsePrivateNetwork bool
Use private network
Userdata string
Path to file with cloud-init user-data
Volumes string
Comma-separated list of volume IDs or names which should be attached to the server
ApiToken This property is required. string
Hetzner Cloud project API token
Image string
Hetzner Cloud server image
Networks string
Comma-separated list of network IDs or names which should be attached to the server private network interface
ServerLabels map[string]string
Map of the labels which will be assigned to the server
ServerLocation string
Hetzner Cloud datacenter
ServerType string
Hetzner Cloud server type
UsePrivateNetwork bool
Use private network
Userdata string
Path to file with cloud-init user-data
Volumes string
Comma-separated list of volume IDs or names which should be attached to the server
apiToken This property is required. String
Hetzner Cloud project API token
image String
Hetzner Cloud server image
networks String
Comma-separated list of network IDs or names which should be attached to the server private network interface
serverLabels Map<String,String>
Map of the labels which will be assigned to the server
serverLocation String
Hetzner Cloud datacenter
serverType String
Hetzner Cloud server type
usePrivateNetwork Boolean
Use private network
userdata String
Path to file with cloud-init user-data
volumes String
Comma-separated list of volume IDs or names which should be attached to the server
apiToken This property is required. string
Hetzner Cloud project API token
image string
Hetzner Cloud server image
networks string
Comma-separated list of network IDs or names which should be attached to the server private network interface
serverLabels {[key: string]: string}
Map of the labels which will be assigned to the server
serverLocation string
Hetzner Cloud datacenter
serverType string
Hetzner Cloud server type
usePrivateNetwork boolean
Use private network
userdata string
Path to file with cloud-init user-data
volumes string
Comma-separated list of volume IDs or names which should be attached to the server
api_token This property is required. str
Hetzner Cloud project API token
image str
Hetzner Cloud server image
networks str
Comma-separated list of network IDs or names which should be attached to the server private network interface
server_labels Mapping[str, str]
Map of the labels which will be assigned to the server
server_location str
Hetzner Cloud datacenter
server_type str
Hetzner Cloud server type
use_private_network bool
Use private network
userdata str
Path to file with cloud-init user-data
volumes str
Comma-separated list of volume IDs or names which should be attached to the server
apiToken This property is required. String
Hetzner Cloud project API token
image String
Hetzner Cloud server image
networks String
Comma-separated list of network IDs or names which should be attached to the server private network interface
serverLabels Map<String>
Map of the labels which will be assigned to the server
serverLocation String
Hetzner Cloud datacenter
serverType String
Hetzner Cloud server type
usePrivateNetwork Boolean
Use private network
userdata String
Path to file with cloud-init user-data
volumes String
Comma-separated list of volume IDs or names which should be attached to the server

NodeTemplateLinodeConfig
, NodeTemplateLinodeConfigArgs

AuthorizedUsers string
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
CreatePrivateIp bool
Create private IP for the instance
DockerPort string
Docker Port
Image string
Specifies the Linode Instance image which determines the OS distribution and base files
InstanceType string
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
Label string
Linode Instance Label
Region string
Specifies the region (location) of the Linode instance
RootPass string
Root Password
SshPort string
Linode Instance SSH Port
SshUser string
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
Stackscript string
Specifies the Linode StackScript to use to create the instance
StackscriptData string
A JSON string specifying data for the selected StackScript
SwapSize string
Linode Instance Swap Size (MB)
Tags string
A comma separated list of tags to apply to the the Linode resource
Token string
Linode API Token
UaPrefix string
Prefix the User-Agent in Linode API calls with some 'product/version'
AuthorizedUsers string
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
CreatePrivateIp bool
Create private IP for the instance
DockerPort string
Docker Port
Image string
Specifies the Linode Instance image which determines the OS distribution and base files
InstanceType string
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
Label string
Linode Instance Label
Region string
Specifies the region (location) of the Linode instance
RootPass string
Root Password
SshPort string
Linode Instance SSH Port
SshUser string
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
Stackscript string
Specifies the Linode StackScript to use to create the instance
StackscriptData string
A JSON string specifying data for the selected StackScript
SwapSize string
Linode Instance Swap Size (MB)
Tags string
A comma separated list of tags to apply to the the Linode resource
Token string
Linode API Token
UaPrefix string
Prefix the User-Agent in Linode API calls with some 'product/version'
authorizedUsers String
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
createPrivateIp Boolean
Create private IP for the instance
dockerPort String
Docker Port
image String
Specifies the Linode Instance image which determines the OS distribution and base files
instanceType String
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
label String
Linode Instance Label
region String
Specifies the region (location) of the Linode instance
rootPass String
Root Password
sshPort String
Linode Instance SSH Port
sshUser String
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
stackscript String
Specifies the Linode StackScript to use to create the instance
stackscriptData String
A JSON string specifying data for the selected StackScript
swapSize String
Linode Instance Swap Size (MB)
tags String
A comma separated list of tags to apply to the the Linode resource
token String
Linode API Token
uaPrefix String
Prefix the User-Agent in Linode API calls with some 'product/version'
authorizedUsers string
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
createPrivateIp boolean
Create private IP for the instance
dockerPort string
Docker Port
image string
Specifies the Linode Instance image which determines the OS distribution and base files
instanceType string
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
label string
Linode Instance Label
region string
Specifies the region (location) of the Linode instance
rootPass string
Root Password
sshPort string
Linode Instance SSH Port
sshUser string
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
stackscript string
Specifies the Linode StackScript to use to create the instance
stackscriptData string
A JSON string specifying data for the selected StackScript
swapSize string
Linode Instance Swap Size (MB)
tags string
A comma separated list of tags to apply to the the Linode resource
token string
Linode API Token
uaPrefix string
Prefix the User-Agent in Linode API calls with some 'product/version'
authorized_users str
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
create_private_ip bool
Create private IP for the instance
docker_port str
Docker Port
image str
Specifies the Linode Instance image which determines the OS distribution and base files
instance_type str
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
label str
Linode Instance Label
region str
Specifies the region (location) of the Linode instance
root_pass str
Root Password
ssh_port str
Linode Instance SSH Port
ssh_user str
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
stackscript str
Specifies the Linode StackScript to use to create the instance
stackscript_data str
A JSON string specifying data for the selected StackScript
swap_size str
Linode Instance Swap Size (MB)
tags str
A comma separated list of tags to apply to the the Linode resource
token str
Linode API Token
ua_prefix str
Prefix the User-Agent in Linode API calls with some 'product/version'
authorizedUsers String
Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node
createPrivateIp Boolean
Create private IP for the instance
dockerPort String
Docker Port
image String
Specifies the Linode Instance image which determines the OS distribution and base files
instanceType String
Specifies the Linode Instance type which determines CPU, memory, disk size, etc.
label String
Linode Instance Label
region String
Specifies the region (location) of the Linode instance
rootPass String
Root Password
sshPort String
Linode Instance SSH Port
sshUser String
Specifies the user as which docker-machine should log in to the Linode instance to install Docker.
stackscript String
Specifies the Linode StackScript to use to create the instance
stackscriptData String
A JSON string specifying data for the selected StackScript
swapSize String
Linode Instance Swap Size (MB)
tags String
A comma separated list of tags to apply to the the Linode resource
token String
Linode API Token
uaPrefix String
Prefix the User-Agent in Linode API calls with some 'product/version'

NodeTemplateNodeTaint
, NodeTemplateNodeTaintArgs

Key This property is required. string
Taint key (string)
Value This property is required. string
Taint value (string)
Effect string
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
TimeAdded string
Taint time added (string)
Key This property is required. string
Taint key (string)
Value This property is required. string
Taint value (string)
Effect string
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
TimeAdded string
Taint time added (string)
key This property is required. String
Taint key (string)
value This property is required. String
Taint value (string)
effect String
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
timeAdded String
Taint time added (string)
key This property is required. string
Taint key (string)
value This property is required. string
Taint value (string)
effect string
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
timeAdded string
Taint time added (string)
key This property is required. str
Taint key (string)
value This property is required. str
Taint value (string)
effect str
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
time_added str
Taint time added (string)
key This property is required. String
Taint key (string)
value This property is required. String
Taint value (string)
effect String
Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)
timeAdded String
Taint time added (string)

NodeTemplateOpennebulaConfig
, NodeTemplateOpennebulaConfigArgs

Password This property is required. string
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
User This property is required. string
Set the user for the XML-RPC API authentication (string)
XmlRpcUrl This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

Password This property is required. string
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
User This property is required. string
Set the user for the XML-RPC API authentication (string)
XmlRpcUrl This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

password This property is required. String
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
user This property is required. String
Set the user for the XML-RPC API authentication (string)
xmlRpcUrl This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

password This property is required. string
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
user This property is required. string
Set the user for the XML-RPC API authentication (string)
xmlRpcUrl This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

password This property is required. str
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
user This property is required. str
Set the user for the XML-RPC API authentication (string)
xml_rpc_url This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

password This property is required. String
vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2.CloudCredential from Rancher v2.2.x (string)
user This property is required. String
Set the user for the XML-RPC API authentication (string)
xmlRpcUrl This property is required. 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)

Note:: Required* denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.

NodeTemplateOpenstackConfig
, NodeTemplateOpenstackConfigArgs

AuthUrl This property is required. string
OpenStack authentication URL (string)
AvailabilityZone This property is required. string
OpenStack availability zone (string)
Region This property is required. string
AWS region. Default eu-west-2 (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)
BootFromVolume bool
Enable booting from volume. Default is false (bool)
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)
VolumeDevicePath string

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

VolumeId string
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
VolumeName string
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
VolumeSize string
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
VolumeType string
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)
AuthUrl This property is required. string
OpenStack authentication URL (string)
AvailabilityZone This property is required. string
OpenStack availability zone (string)
Region This property is required. string
AWS region. Default eu-west-2 (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)
BootFromVolume bool
Enable booting from volume. Default is false (bool)
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)
VolumeDevicePath string

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

VolumeId string
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
VolumeName string
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
VolumeSize string
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
VolumeType string
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)
authUrl This property is required. String
OpenStack authentication URL (string)
availabilityZone This property is required. String
OpenStack availability zone (string)
region This property is required. String
AWS region. Default eu-west-2 (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)
bootFromVolume Boolean
Enable booting from volume. Default is false (bool)
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)
volumeDevicePath String

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

volumeId String
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
volumeName String
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
volumeSize String
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
volumeType String
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)
authUrl This property is required. string
OpenStack authentication URL (string)
availabilityZone This property is required. string
OpenStack availability zone (string)
region This property is required. string
AWS region. Default eu-west-2 (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)
bootFromVolume boolean
Enable booting from volume. Default is false (bool)
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)
volumeDevicePath string

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

volumeId string
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
volumeName string
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
volumeSize string
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
volumeType string
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)
auth_url This property is required. str
OpenStack authentication URL (string)
availability_zone This property is required. str
OpenStack availability zone (string)
region This property is required. str
AWS region. Default eu-west-2 (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)
boot_from_volume bool
Enable booting from volume. Default is false (bool)
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)
volume_device_path str

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

volume_id str
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
volume_name str
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
volume_size str
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
volume_type str
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)
authUrl This property is required. String
OpenStack authentication URL (string)
availabilityZone This property is required. String
OpenStack availability zone (string)
region This property is required. String
AWS region. Default eu-west-2 (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)
bootFromVolume Boolean
Enable booting from volume. Default is false (bool)
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)
volumeDevicePath String

OpenStack volume device path (attaching). Applicable only when boot_from_volume is true. Omit for auto /dev/vdb. (string)

Note:: Required* denotes that either the _name or _id is required but you cannot use both.

Note:: Required** denotes that either the _name or _id is required unless application_credential_id is defined.

Note for OpenStack users:: keypair_name is required to be in the schema even if there are no references in rancher itself

volumeId String
OpenStack volume id of existing volume. Applicable only when boot_from_volume is true (string)
volumeName String
OpenStack volume name of existing volume. Applicable only when boot_from_volume is true (string)
volumeSize String
OpenStack volume size (GiB). Required when boot_from_volume is true (string)
volumeType String
OpenStack volume type. Required when boot_from_volume is true and openstack cloud does not have a default volume type (string)

NodeTemplateOutscaleConfig
, NodeTemplateOutscaleConfigArgs

AccessKey This property is required. string
Outscale Access Key
SecretKey This property is required. string
Outscale Secret Key
ExtraTagsAlls List<string>
Extra tags for all created resources (e.g. key1=value1,key2=value2)
ExtraTagsInstances List<string>
Extra tags only for instances (e.g. key1=value1,key2=value2)
InstanceType string
Outscale VM type
Region string
Outscale Region
RootDiskIops int
Iops for io1 Root Disk. From 1 to 13000.
RootDiskSize int
Size of the Root Disk (in GB). From 1 to 14901.
RootDiskType string
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
SecurityGroupIds List<string>
Ids of user defined Security Groups to add to the machine
SourceOmi string
Outscale Machine Image to use as bootstrap for the VM
AccessKey This property is required. string
Outscale Access Key
SecretKey This property is required. string
Outscale Secret Key
ExtraTagsAlls []string
Extra tags for all created resources (e.g. key1=value1,key2=value2)
ExtraTagsInstances []string
Extra tags only for instances (e.g. key1=value1,key2=value2)
InstanceType string
Outscale VM type
Region string
Outscale Region
RootDiskIops int
Iops for io1 Root Disk. From 1 to 13000.
RootDiskSize int
Size of the Root Disk (in GB). From 1 to 14901.
RootDiskType string
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
SecurityGroupIds []string
Ids of user defined Security Groups to add to the machine
SourceOmi string
Outscale Machine Image to use as bootstrap for the VM
accessKey This property is required. String
Outscale Access Key
secretKey This property is required. String
Outscale Secret Key
extraTagsAlls List<String>
Extra tags for all created resources (e.g. key1=value1,key2=value2)
extraTagsInstances List<String>
Extra tags only for instances (e.g. key1=value1,key2=value2)
instanceType String
Outscale VM type
region String
Outscale Region
rootDiskIops Integer
Iops for io1 Root Disk. From 1 to 13000.
rootDiskSize Integer
Size of the Root Disk (in GB). From 1 to 14901.
rootDiskType String
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
securityGroupIds List<String>
Ids of user defined Security Groups to add to the machine
sourceOmi String
Outscale Machine Image to use as bootstrap for the VM
accessKey This property is required. string
Outscale Access Key
secretKey This property is required. string
Outscale Secret Key
extraTagsAlls string[]
Extra tags for all created resources (e.g. key1=value1,key2=value2)
extraTagsInstances string[]
Extra tags only for instances (e.g. key1=value1,key2=value2)
instanceType string
Outscale VM type
region string
Outscale Region
rootDiskIops number
Iops for io1 Root Disk. From 1 to 13000.
rootDiskSize number
Size of the Root Disk (in GB). From 1 to 14901.
rootDiskType string
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
securityGroupIds string[]
Ids of user defined Security Groups to add to the machine
sourceOmi string
Outscale Machine Image to use as bootstrap for the VM
access_key This property is required. str
Outscale Access Key
secret_key This property is required. str
Outscale Secret Key
extra_tags_alls Sequence[str]
Extra tags for all created resources (e.g. key1=value1,key2=value2)
extra_tags_instances Sequence[str]
Extra tags only for instances (e.g. key1=value1,key2=value2)
instance_type str
Outscale VM type
region str
Outscale Region
root_disk_iops int
Iops for io1 Root Disk. From 1 to 13000.
root_disk_size int
Size of the Root Disk (in GB). From 1 to 14901.
root_disk_type str
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
security_group_ids Sequence[str]
Ids of user defined Security Groups to add to the machine
source_omi str
Outscale Machine Image to use as bootstrap for the VM
accessKey This property is required. String
Outscale Access Key
secretKey This property is required. String
Outscale Secret Key
extraTagsAlls List<String>
Extra tags for all created resources (e.g. key1=value1,key2=value2)
extraTagsInstances List<String>
Extra tags only for instances (e.g. key1=value1,key2=value2)
instanceType String
Outscale VM type
region String
Outscale Region
rootDiskIops Number
Iops for io1 Root Disk. From 1 to 13000.
rootDiskSize Number
Size of the Root Disk (in GB). From 1 to 14901.
rootDiskType String
Type of the Root Disk. Possible values are :'standard', 'gp2' or 'io1'.
securityGroupIds List<String>
Ids of user defined Security Groups to add to the machine
sourceOmi String
Outscale Machine Image to use as bootstrap for the VM

NodeTemplateVsphereConfig
, NodeTemplateVsphereConfigArgs

Boot2dockerUrl string
vSphere URL for boot2docker image
Cfgparams List<string>
vSphere vm configuration parameters (used for guestinfo)
CloneFrom string
If you choose creation type clone a name of what you want to clone is required
CloudConfig string
Filepath to a cloud-config yaml file to put into the ISO user-data
Cloudinit string
vSphere cloud-init filepath or url to add to guestinfo
ContentLibrary string
If you choose to clone from a content library template specify the name of the library
CpuCount string
vSphere CPU number for docker VM
CreationType string
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
CustomAttributes List<string>
vSphere custom attributes, format key/value e.g. '200=my custom value'
Datacenter string
vSphere datacenter for virtual machine
Datastore string
vSphere datastore for virtual machine
DatastoreCluster string
vSphere datastore cluster for virtual machine
DiskSize string
vSphere size of disk for docker VM (in MB)
Folder string
vSphere folder for the docker VM. This folder must already exist in the datacenter
GracefulShutdownTimeout string
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
Hostsystem string
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
MemorySize string
vSphere size of memory for docker VM (in MB)
Networks List<string>
vSphere network where the virtual machine will be attached
Password string
vSphere password
Pool string
vSphere resource pool for docker VM
SshPassword string
If using a non-B2D image you can specify the ssh password
SshPort string
If using a non-B2D image you can specify the ssh port
SshUser string
If using a non-B2D image you can specify the ssh user
SshUserGroup string
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
Tags List<string>
vSphere tags id e.g. urn:xxx
Username string
vSphere username
VappIpAllocationPolicy string
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
VappIpProtocol string
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
VappProperties List<string>
vSphere vApp properties
VappTransport string
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
Vcenter string
vSphere IP/hostname for vCenter
VcenterPort string
vSphere Port for vCenter
Boot2dockerUrl string
vSphere URL for boot2docker image
Cfgparams []string
vSphere vm configuration parameters (used for guestinfo)
CloneFrom string
If you choose creation type clone a name of what you want to clone is required
CloudConfig string
Filepath to a cloud-config yaml file to put into the ISO user-data
Cloudinit string
vSphere cloud-init filepath or url to add to guestinfo
ContentLibrary string
If you choose to clone from a content library template specify the name of the library
CpuCount string
vSphere CPU number for docker VM
CreationType string
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
CustomAttributes []string
vSphere custom attributes, format key/value e.g. '200=my custom value'
Datacenter string
vSphere datacenter for virtual machine
Datastore string
vSphere datastore for virtual machine
DatastoreCluster string
vSphere datastore cluster for virtual machine
DiskSize string
vSphere size of disk for docker VM (in MB)
Folder string
vSphere folder for the docker VM. This folder must already exist in the datacenter
GracefulShutdownTimeout string
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
Hostsystem string
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
MemorySize string
vSphere size of memory for docker VM (in MB)
Networks []string
vSphere network where the virtual machine will be attached
Password string
vSphere password
Pool string
vSphere resource pool for docker VM
SshPassword string
If using a non-B2D image you can specify the ssh password
SshPort string
If using a non-B2D image you can specify the ssh port
SshUser string
If using a non-B2D image you can specify the ssh user
SshUserGroup string
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
Tags []string
vSphere tags id e.g. urn:xxx
Username string
vSphere username
VappIpAllocationPolicy string
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
VappIpProtocol string
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
VappProperties []string
vSphere vApp properties
VappTransport string
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
Vcenter string
vSphere IP/hostname for vCenter
VcenterPort string
vSphere Port for vCenter
boot2dockerUrl String
vSphere URL for boot2docker image
cfgparams List<String>
vSphere vm configuration parameters (used for guestinfo)
cloneFrom String
If you choose creation type clone a name of what you want to clone is required
cloudConfig String
Filepath to a cloud-config yaml file to put into the ISO user-data
cloudinit String
vSphere cloud-init filepath or url to add to guestinfo
contentLibrary String
If you choose to clone from a content library template specify the name of the library
cpuCount String
vSphere CPU number for docker VM
creationType String
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
customAttributes List<String>
vSphere custom attributes, format key/value e.g. '200=my custom value'
datacenter String
vSphere datacenter for virtual machine
datastore String
vSphere datastore for virtual machine
datastoreCluster String
vSphere datastore cluster for virtual machine
diskSize String
vSphere size of disk for docker VM (in MB)
folder String
vSphere folder for the docker VM. This folder must already exist in the datacenter
gracefulShutdownTimeout String
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
hostsystem String
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
memorySize String
vSphere size of memory for docker VM (in MB)
networks List<String>
vSphere network where the virtual machine will be attached
password String
vSphere password
pool String
vSphere resource pool for docker VM
sshPassword String
If using a non-B2D image you can specify the ssh password
sshPort String
If using a non-B2D image you can specify the ssh port
sshUser String
If using a non-B2D image you can specify the ssh user
sshUserGroup String
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
tags List<String>
vSphere tags id e.g. urn:xxx
username String
vSphere username
vappIpAllocationPolicy String
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
vappIpProtocol String
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
vappProperties List<String>
vSphere vApp properties
vappTransport String
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
vcenter String
vSphere IP/hostname for vCenter
vcenterPort String
vSphere Port for vCenter
boot2dockerUrl string
vSphere URL for boot2docker image
cfgparams string[]
vSphere vm configuration parameters (used for guestinfo)
cloneFrom string
If you choose creation type clone a name of what you want to clone is required
cloudConfig string
Filepath to a cloud-config yaml file to put into the ISO user-data
cloudinit string
vSphere cloud-init filepath or url to add to guestinfo
contentLibrary string
If you choose to clone from a content library template specify the name of the library
cpuCount string
vSphere CPU number for docker VM
creationType string
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
customAttributes string[]
vSphere custom attributes, format key/value e.g. '200=my custom value'
datacenter string
vSphere datacenter for virtual machine
datastore string
vSphere datastore for virtual machine
datastoreCluster string
vSphere datastore cluster for virtual machine
diskSize string
vSphere size of disk for docker VM (in MB)
folder string
vSphere folder for the docker VM. This folder must already exist in the datacenter
gracefulShutdownTimeout string
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
hostsystem string
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
memorySize string
vSphere size of memory for docker VM (in MB)
networks string[]
vSphere network where the virtual machine will be attached
password string
vSphere password
pool string
vSphere resource pool for docker VM
sshPassword string
If using a non-B2D image you can specify the ssh password
sshPort string
If using a non-B2D image you can specify the ssh port
sshUser string
If using a non-B2D image you can specify the ssh user
sshUserGroup string
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
tags string[]
vSphere tags id e.g. urn:xxx
username string
vSphere username
vappIpAllocationPolicy string
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
vappIpProtocol string
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
vappProperties string[]
vSphere vApp properties
vappTransport string
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
vcenter string
vSphere IP/hostname for vCenter
vcenterPort string
vSphere Port for vCenter
boot2docker_url str
vSphere URL for boot2docker image
cfgparams Sequence[str]
vSphere vm configuration parameters (used for guestinfo)
clone_from str
If you choose creation type clone a name of what you want to clone is required
cloud_config str
Filepath to a cloud-config yaml file to put into the ISO user-data
cloudinit str
vSphere cloud-init filepath or url to add to guestinfo
content_library str
If you choose to clone from a content library template specify the name of the library
cpu_count str
vSphere CPU number for docker VM
creation_type str
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
custom_attributes Sequence[str]
vSphere custom attributes, format key/value e.g. '200=my custom value'
datacenter str
vSphere datacenter for virtual machine
datastore str
vSphere datastore for virtual machine
datastore_cluster str
vSphere datastore cluster for virtual machine
disk_size str
vSphere size of disk for docker VM (in MB)
folder str
vSphere folder for the docker VM. This folder must already exist in the datacenter
graceful_shutdown_timeout str
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
hostsystem str
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
memory_size str
vSphere size of memory for docker VM (in MB)
networks Sequence[str]
vSphere network where the virtual machine will be attached
password str
vSphere password
pool str
vSphere resource pool for docker VM
ssh_password str
If using a non-B2D image you can specify the ssh password
ssh_port str
If using a non-B2D image you can specify the ssh port
ssh_user str
If using a non-B2D image you can specify the ssh user
ssh_user_group str
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
tags Sequence[str]
vSphere tags id e.g. urn:xxx
username str
vSphere username
vapp_ip_allocation_policy str
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
vapp_ip_protocol str
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
vapp_properties Sequence[str]
vSphere vApp properties
vapp_transport str
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
vcenter str
vSphere IP/hostname for vCenter
vcenter_port str
vSphere Port for vCenter
boot2dockerUrl String
vSphere URL for boot2docker image
cfgparams List<String>
vSphere vm configuration parameters (used for guestinfo)
cloneFrom String
If you choose creation type clone a name of what you want to clone is required
cloudConfig String
Filepath to a cloud-config yaml file to put into the ISO user-data
cloudinit String
vSphere cloud-init filepath or url to add to guestinfo
contentLibrary String
If you choose to clone from a content library template specify the name of the library
cpuCount String
vSphere CPU number for docker VM
creationType String
Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy
customAttributes List<String>
vSphere custom attributes, format key/value e.g. '200=my custom value'
datacenter String
vSphere datacenter for virtual machine
datastore String
vSphere datastore for virtual machine
datastoreCluster String
vSphere datastore cluster for virtual machine
diskSize String
vSphere size of disk for docker VM (in MB)
folder String
vSphere folder for the docker VM. This folder must already exist in the datacenter
gracefulShutdownTimeout String
Duration in seconds before the graceful shutdown of the VM times out and the VM is destroyed. A force destroy will be performed when the value is zero
hostsystem String
vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS
memorySize String
vSphere size of memory for docker VM (in MB)
networks List<String>
vSphere network where the virtual machine will be attached
password String
vSphere password
pool String
vSphere resource pool for docker VM
sshPassword String
If using a non-B2D image you can specify the ssh password
sshPort String
If using a non-B2D image you can specify the ssh port
sshUser String
If using a non-B2D image you can specify the ssh user
sshUserGroup String
If using a non-B2D image the uploaded keys will need chown'ed, defaults to staff e.g. docker:staff
tags List<String>
vSphere tags id e.g. urn:xxx
username String
vSphere username
vappIpAllocationPolicy String
vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated
vappIpProtocol String
vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6
vappProperties List<String>
vSphere vApp properties
vappTransport String
vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo
vcenter String
vSphere IP/hostname for vCenter
vcenterPort String
vSphere Port for vCenter

Import

Node Template can be imported using the Rancher Node Template ID

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.