NodeTemplate

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

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

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

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

}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

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

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

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

Create a NodeTemplate Resource

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: CustomResourceOptions);

def NodeTemplate(resource_name, opts=None, amazonec2_config=None, annotations=None, auth_certificate_authority=None, auth_key=None, azure_config=None, cloud_credential_id=None, description=None, digitalocean_config=None, driver_id=None, engine_env=None, engine_insecure_registries=None, engine_install_url=None, engine_label=None, engine_opt=None, engine_registry_mirrors=None, engine_storage_driver=None, labels=None, linode_config=None, name=None, opennebula_config=None, openstack_config=None, use_internal_ip_address=None, vsphere_config=None, __props__=None);

func NewNodeTemplate(ctx *Context, name string, args *NodeTemplateArgs, opts ...ResourceOption) (*NodeTemplate, error)

public NodeTemplate(string name, NodeTemplateArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NodeTemplate Resource Properties

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

Inputs

The NodeTemplate resource accepts the following input properties:

Amazonec2Config NodeTemplateAmazonec2ConfigArgs: AWS config for the Node Template (list maxitems:1)
Annotations Dictionary<string, object>: Annotations for Node Template object (map)
AuthCertificateAuthority string: Auth certificate authority for the Node Template (string)
AuthKey string: Auth key for the Node Template (string)
AzureConfig NodeTemplateAzureConfigArgs: Azure config for the Node Template (list maxitems:1)
CloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
Description string: Description for the Node Template (string)
DigitaloceanConfig NodeTemplateDigitaloceanConfigArgs: Digitalocean config for the Node Template (list maxitems:1)
DriverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
EngineEnv Dictionary<string, object>: Engine environment for the node template (string)
EngineInsecureRegistries List<string>: Insecure registry for the node template (list)
EngineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel Dictionary<string, object>: Engine label for the node template (string)
EngineOpt Dictionary<string, object>: Engine options for the node template (map)
EngineRegistryMirrors List<string>: Engine registry mirror for the node template (list)
EngineStorageDriver string: Engine storage driver for the node template (string)
Labels Dictionary<string, object>: Labels for Node Template object (map)
LinodeConfig NodeTemplateLinodeConfigArgs: Linode config for the Node Template (list maxitems:1)
Name string: The name of the Node Template (string)
OpennebulaConfig NodeTemplateOpennebulaConfigArgs: Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfigArgs: Openstack config for the Node Template (list maxitems:1)
UseInternalIpAddress bool: Engine storage driver for the node template (bool)
VsphereConfig NodeTemplateVsphereConfigArgs: vSphere config for the Node Template (list maxitems:1)

Amazonec2Config NodeTemplateAmazonec2Config: AWS config for the Node Template (list maxitems:1)
Annotations map[string]interface{}: Annotations for Node Template object (map)
AuthCertificateAuthority string: Auth certificate authority for the Node Template (string)
AuthKey string: Auth key for the Node Template (string)
AzureConfig NodeTemplateAzureConfig: Azure config for the Node Template (list maxitems:1)
CloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
Description string: Description for the Node Template (string)
DigitaloceanConfig NodeTemplateDigitaloceanConfig: Digitalocean config for the Node Template (list maxitems:1)
DriverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
EngineEnv map[string]interface{}: Engine environment for the node template (string)
EngineInsecureRegistries []string: Insecure registry for the node template (list)
EngineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel map[string]interface{}: Engine label for the node template (string)
EngineOpt map[string]interface{}: Engine options for the node template (map)
EngineRegistryMirrors []string: Engine registry mirror for the node template (list)
EngineStorageDriver string: Engine storage driver for the node template (string)
Labels map[string]interface{}: Labels for Node Template object (map)
LinodeConfig NodeTemplateLinodeConfig: Linode config for the Node Template (list maxitems:1)
Name string: The name of the Node Template (string)
OpennebulaConfig NodeTemplateOpennebulaConfig: Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfig: Openstack config for the Node Template (list maxitems:1)
UseInternalIpAddress bool: Engine storage driver for the node template (bool)
VsphereConfig NodeTemplateVsphereConfig: vSphere config for the Node Template (list maxitems:1)

amazonec2Config NodeTemplateAmazonec2Config: AWS config for the Node Template (list maxitems:1)
annotations {[key: string]: any}: Annotations for Node Template object (map)
authCertificateAuthority string: Auth certificate authority for the Node Template (string)
authKey string: Auth key for the Node Template (string)
azureConfig NodeTemplateAzureConfig: Azure config for the Node Template (list maxitems:1)
cloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
description string: Description for the Node Template (string)
digitaloceanConfig NodeTemplateDigitaloceanConfig: Digitalocean config for the Node Template (list maxitems:1)
driverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
engineEnv {[key: string]: any}: Engine environment for the node template (string)
engineInsecureRegistries string[]: Insecure registry for the node template (list)
engineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel {[key: string]: any}: Engine label for the node template (string)
engineOpt {[key: string]: any}: Engine options for the node template (map)
engineRegistryMirrors string[]: Engine registry mirror for the node template (list)
engineStorageDriver string: Engine storage driver for the node template (string)
labels {[key: string]: any}: Labels for Node Template object (map)
linodeConfig NodeTemplateLinodeConfig: Linode config for the Node Template (list maxitems:1)
name string: The name of the Node Template (string)
opennebulaConfig NodeTemplateOpennebulaConfig: Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig: Openstack config for the Node Template (list maxitems:1)
useInternalIpAddress boolean: Engine storage driver for the node template (bool)
vsphereConfig NodeTemplateVsphereConfig: vSphere config for the Node Template (list maxitems:1)

amazonec2_config Dict[NodeTemplateAmazonec2Config]: AWS config for the Node Template (list maxitems:1)
annotations Dict[str, Any]: Annotations for Node Template object (map)
auth_certificate_authority str: Auth certificate authority for the Node Template (string)
auth_key str: Auth key for the Node Template (string)
azure_config Dict[NodeTemplateAzureConfig]: 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 Dict[NodeTemplateDigitaloceanConfig]: 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 Dict[str, Any]: Engine environment for the node template (string)
engine_insecure_registries List[str]: Insecure registry for the node template (list)
engine_install_url str: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
engine_label Dict[str, Any]: Engine label for the node template (string)
engine_opt Dict[str, Any]: Engine options for the node template (map)
engine_registry_mirrors List[str]: Engine registry mirror for the node template (list)
engine_storage_driver str: Engine storage driver for the node template (string)
labels Dict[str, Any]: Labels for Node Template object (map)
linode_config Dict[NodeTemplateLinodeConfig]: Linode config for the Node Template (list maxitems:1)
name str: The name of the Node Template (string)
opennebula_config Dict[NodeTemplateOpennebulaConfig]: Opennebula config for the Node Template (list maxitems:1)
openstack_config Dict[NodeTemplateOpenstackConfig]: Openstack config for the Node Template (list maxitems:1)
use_internal_ip_address bool: Engine storage driver for the node template (bool)
vsphere_config Dict[NodeTemplateVsphereConfig]: vSphere config for the Node Template (list maxitems:1)

Outputs

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

Driver string: (Computed) The driver of the node template (string)
Id string: The provider-assigned unique ID for this managed resource.

Driver string: (Computed) The driver of the node template (string)
Id string: The provider-assigned unique ID for this managed resource.

driver string: (Computed) The driver of the node template (string)
id string: The provider-assigned unique ID for this managed resource.

driver str: (Computed) The driver of the node template (string)
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NodeTemplate Resource

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

public static get(name: string, id: Input<ID>, state?: NodeTemplateState, opts?: CustomResourceOptions): NodeTemplate

static get(resource_name, id, opts=None, amazonec2_config=None, annotations=None, auth_certificate_authority=None, auth_key=None, azure_config=None, cloud_credential_id=None, description=None, digitalocean_config=None, driver=None, driver_id=None, engine_env=None, engine_insecure_registries=None, engine_install_url=None, engine_label=None, engine_opt=None, engine_registry_mirrors=None, engine_storage_driver=None, labels=None, linode_config=None, name=None, opennebula_config=None, openstack_config=None, use_internal_ip_address=None, vsphere_config=None, __props__=None);

func GetNodeTemplate(ctx *Context, name string, id IDInput, state *NodeTemplateState, opts ...ResourceOption) (*NodeTemplate, error)

public static NodeTemplate Get(string name, Input<string> id, NodeTemplateState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Amazonec2Config NodeTemplateAmazonec2ConfigArgs: AWS config for the Node Template (list maxitems:1)
Annotations Dictionary<string, object>: Annotations for Node Template object (map)
AuthCertificateAuthority string: Auth certificate authority for the Node Template (string)
AuthKey string: Auth key for the Node Template (string)
AzureConfig NodeTemplateAzureConfigArgs: Azure config for the Node Template (list maxitems:1)
CloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
Description string: Description for the Node Template (string)
DigitaloceanConfig NodeTemplateDigitaloceanConfigArgs: Digitalocean config for the Node Template (list maxitems:1)
Driver string: (Computed) The driver of the node template (string)
DriverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
EngineEnv Dictionary<string, object>: Engine environment for the node template (string)
EngineInsecureRegistries List<string>: Insecure registry for the node template (list)
EngineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel Dictionary<string, object>: Engine label for the node template (string)
EngineOpt Dictionary<string, object>: Engine options for the node template (map)
EngineRegistryMirrors List<string>: Engine registry mirror for the node template (list)
EngineStorageDriver string: Engine storage driver for the node template (string)
Labels Dictionary<string, object>: Labels for Node Template object (map)
LinodeConfig NodeTemplateLinodeConfigArgs: Linode config for the Node Template (list maxitems:1)
Name string: The name of the Node Template (string)
OpennebulaConfig NodeTemplateOpennebulaConfigArgs: Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfigArgs: Openstack config for the Node Template (list maxitems:1)
UseInternalIpAddress bool: Engine storage driver for the node template (bool)
VsphereConfig NodeTemplateVsphereConfigArgs: vSphere config for the Node Template (list maxitems:1)

Amazonec2Config NodeTemplateAmazonec2Config: AWS config for the Node Template (list maxitems:1)
Annotations map[string]interface{}: Annotations for Node Template object (map)
AuthCertificateAuthority string: Auth certificate authority for the Node Template (string)
AuthKey string: Auth key for the Node Template (string)
AzureConfig NodeTemplateAzureConfig: Azure config for the Node Template (list maxitems:1)
CloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
Description string: Description for the Node Template (string)
DigitaloceanConfig NodeTemplateDigitaloceanConfig: Digitalocean config for the Node Template (list maxitems:1)
Driver string: (Computed) The driver of the node template (string)
DriverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
EngineEnv map[string]interface{}: Engine environment for the node template (string)
EngineInsecureRegistries []string: Insecure registry for the node template (list)
EngineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
EngineLabel map[string]interface{}: Engine label for the node template (string)
EngineOpt map[string]interface{}: Engine options for the node template (map)
EngineRegistryMirrors []string: Engine registry mirror for the node template (list)
EngineStorageDriver string: Engine storage driver for the node template (string)
Labels map[string]interface{}: Labels for Node Template object (map)
LinodeConfig NodeTemplateLinodeConfig: Linode config for the Node Template (list maxitems:1)
Name string: The name of the Node Template (string)
OpennebulaConfig NodeTemplateOpennebulaConfig: Opennebula config for the Node Template (list maxitems:1)
OpenstackConfig NodeTemplateOpenstackConfig: Openstack config for the Node Template (list maxitems:1)
UseInternalIpAddress bool: Engine storage driver for the node template (bool)
VsphereConfig NodeTemplateVsphereConfig: vSphere config for the Node Template (list maxitems:1)

amazonec2Config NodeTemplateAmazonec2Config: AWS config for the Node Template (list maxitems:1)
annotations {[key: string]: any}: Annotations for Node Template object (map)
authCertificateAuthority string: Auth certificate authority for the Node Template (string)
authKey string: Auth key for the Node Template (string)
azureConfig NodeTemplateAzureConfig: Azure config for the Node Template (list maxitems:1)
cloudCredentialId string: Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)
description string: Description for the Node Template (string)
digitaloceanConfig NodeTemplateDigitaloceanConfig: Digitalocean config for the Node Template (list maxitems:1)
driver string: (Computed) The driver of the node template (string)
driverId string: The node driver id used by the node template. It’s required if the node driver isn’t built in Rancher (string)
engineEnv {[key: string]: any}: Engine environment for the node template (string)
engineInsecureRegistries string[]: Insecure registry for the node template (list)
engineInstallUrl string: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
engineLabel {[key: string]: any}: Engine label for the node template (string)
engineOpt {[key: string]: any}: Engine options for the node template (map)
engineRegistryMirrors string[]: Engine registry mirror for the node template (list)
engineStorageDriver string: Engine storage driver for the node template (string)
labels {[key: string]: any}: Labels for Node Template object (map)
linodeConfig NodeTemplateLinodeConfig: Linode config for the Node Template (list maxitems:1)
name string: The name of the Node Template (string)
opennebulaConfig NodeTemplateOpennebulaConfig: Opennebula config for the Node Template (list maxitems:1)
openstackConfig NodeTemplateOpenstackConfig: Openstack config for the Node Template (list maxitems:1)
useInternalIpAddress boolean: Engine storage driver for the node template (bool)
vsphereConfig NodeTemplateVsphereConfig: vSphere config for the Node Template (list maxitems:1)

amazonec2_config Dict[NodeTemplateAmazonec2Config]: AWS config for the Node Template (list maxitems:1)
annotations Dict[str, Any]: Annotations for Node Template object (map)
auth_certificate_authority str: Auth certificate authority for the Node Template (string)
auth_key str: Auth key for the Node Template (string)
azure_config Dict[NodeTemplateAzureConfig]: 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 Dict[NodeTemplateDigitaloceanConfig]: 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 Dict[str, Any]: Engine environment for the node template (string)
engine_insecure_registries List[str]: Insecure registry for the node template (list)
engine_install_url str: Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)
engine_label Dict[str, Any]: Engine label for the node template (string)
engine_opt Dict[str, Any]: Engine options for the node template (map)
engine_registry_mirrors List[str]: Engine registry mirror for the node template (list)
engine_storage_driver str: Engine storage driver for the node template (string)
labels Dict[str, Any]: Labels for Node Template object (map)
linode_config Dict[NodeTemplateLinodeConfig]: Linode config for the Node Template (list maxitems:1)
name str: The name of the Node Template (string)
opennebula_config Dict[NodeTemplateOpennebulaConfig]: Opennebula config for the Node Template (list maxitems:1)
openstack_config Dict[NodeTemplateOpenstackConfig]: Openstack config for the Node Template (list maxitems:1)
use_internal_ip_address bool: Engine storage driver for the node template (bool)
vsphere_config Dict[NodeTemplateVsphereConfig]: vSphere config for the Node Template (list maxitems:1)

Supporting Types

NodeTemplateAmazonec2Config

See the input and output API doc for this type.

Ami string: AWS machine image (string)
Region string: OpenStack region name (string)
SecurityGroups List<string>: AWS VPC security group. (list)
SubnetId string: AWS VPC subnet id (string)
VpcId string: AWS VPC id. (string)
Zone string: AWS zone for instance (i.e. a,b,c,d,e) (string)
AccessKey string: AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
BlockDurationMinutes string: AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)
DeviceName string: AWS root device name. Default /dev/sda1 (string)
EncryptEbsVolume bool: Encrypt EBS volume. Default false (bool)
Endpoint string: Optional endpoint URL (hostname only or fully qualified URI) (string)
IamInstanceProfile string: AWS IAM Instance Profile (string)
InsecureTransport bool: Disable SSL when sending requests (bool)
InstanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
KeypairName string: OpenStack keypair to use to SSH to the instance (string)
Monitoring bool: Enable monitoring for droplet. Default false (bool)
OpenPorts List<string>: Make the specified port number accessible from the Internet. (list)
PrivateAddressOnly bool: Only use a private IP address. Default false (bool)
RequestSpotInstance bool: Set this flag to request spot instance. Default false (bool)
Retries string: Set retry count for recoverable failures (use -1 to disable). Default 5 (string)
RootSize string: AWS root disk size (in GB). Default 16 (string)
SecretKey string: AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
SecurityGroupReadonly bool: Skip adding default rules to security groups (bool)
SessionToken string: AWS Session Token (string)
SpotPrice string: AWS spot instance bid price (in dollar). Default 0.50 (string)
SshKeypath string: SSH Key for Instance (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
UseEbsOptimizedInstance bool: Create an EBS optimized instance. Default false (bool)
UsePrivateAddress bool: Force the usage of private IP address. Default false (bool)
Userdata string: Path to file with cloud-init user-data (string)
VolumeType string: Amazon EBS volume type. Default gp2 (string)

Ami string: AWS machine image (string)
Region string: OpenStack region name (string)
SecurityGroups []string: AWS VPC security group. (list)
SubnetId string: AWS VPC subnet id (string)
VpcId string: AWS VPC id. (string)
Zone string: AWS zone for instance (i.e. a,b,c,d,e) (string)
AccessKey string: AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
BlockDurationMinutes string: AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)
DeviceName string: AWS root device name. Default /dev/sda1 (string)
EncryptEbsVolume bool: Encrypt EBS volume. Default false (bool)
Endpoint string: Optional endpoint URL (hostname only or fully qualified URI) (string)
IamInstanceProfile string: AWS IAM Instance Profile (string)
InsecureTransport bool: Disable SSL when sending requests (bool)
InstanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
KeypairName string: OpenStack keypair to use to SSH to the instance (string)
Monitoring bool: Enable monitoring for droplet. Default false (bool)
OpenPorts []string: Make the specified port number accessible from the Internet. (list)
PrivateAddressOnly bool: Only use a private IP address. Default false (bool)
RequestSpotInstance bool: Set this flag to request spot instance. Default false (bool)
Retries string: Set retry count for recoverable failures (use -1 to disable). Default 5 (string)
RootSize string: AWS root disk size (in GB). Default 16 (string)
SecretKey string: AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
SecurityGroupReadonly bool: Skip adding default rules to security groups (bool)
SessionToken string: AWS Session Token (string)
SpotPrice string: AWS spot instance bid price (in dollar). Default 0.50 (string)
SshKeypath string: SSH Key for Instance (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
UseEbsOptimizedInstance bool: Create an EBS optimized instance. Default false (bool)
UsePrivateAddress bool: Force the usage of private IP address. Default false (bool)
Userdata string: Path to file with cloud-init user-data (string)
VolumeType string: Amazon EBS volume type. Default gp2 (string)

ami string: AWS machine image (string)
region string: OpenStack region name (string)
securityGroups string[]: AWS VPC security group. (list)
subnetId string: AWS VPC subnet id (string)
vpcId string: AWS VPC id. (string)
zone string: AWS zone for instance (i.e. a,b,c,d,e) (string)
accessKey string: AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
blockDurationMinutes string: AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)
deviceName string: AWS root device name. Default /dev/sda1 (string)
encryptEbsVolume boolean: Encrypt EBS volume. Default false (bool)
endpoint string: Optional endpoint URL (hostname only or fully qualified URI) (string)
iamInstanceProfile string: AWS IAM Instance Profile (string)
insecureTransport boolean: Disable SSL when sending requests (bool)
instanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
keypairName string: OpenStack keypair to use to SSH to the instance (string)
monitoring boolean: Enable monitoring for droplet. Default false (bool)
openPorts string[]: Make the specified port number accessible from the Internet. (list)
privateAddressOnly boolean: Only use a private IP address. Default false (bool)
requestSpotInstance boolean: Set this flag to request spot instance. Default false (bool)
retries string: Set retry count for recoverable failures (use -1 to disable). Default 5 (string)
rootSize string: AWS root disk size (in GB). Default 16 (string)
secretKey string: AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
securityGroupReadonly boolean: Skip adding default rules to security groups (bool)
sessionToken string: AWS Session Token (string)
spotPrice string: AWS spot instance bid price (in dollar). Default 0.50 (string)
sshKeypath string: SSH Key for Instance (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
useEbsOptimizedInstance boolean: Create an EBS optimized instance. Default false (bool)
usePrivateAddress boolean: Force the usage of private IP address. Default false (bool)
userdata string: Path to file with cloud-init user-data (string)
volumeType string: Amazon EBS volume type. Default gp2 (string)

ami str: AWS machine image (string)
region str: OpenStack region name (string)
securityGroups List[str]: AWS VPC security group. (list)
subnetId str: AWS VPC subnet id (string)
vpcId str: AWS VPC id. (string)
zone str: AWS zone for instance (i.e. a,b,c,d,e) (string)
access_key str: AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
blockDurationMinutes str: AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)
deviceName str: AWS root device name. Default /dev/sda1 (string)
encryptEbsVolume bool: Encrypt EBS volume. Default false (bool)
endpoint str: Optional endpoint URL (hostname only or fully qualified URI) (string)
iamInstanceProfile str: AWS IAM Instance Profile (string)
insecureTransport bool: Disable SSL when sending requests (bool)
instanceType str: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
keypairName str: OpenStack keypair to use to SSH to the instance (string)
monitoring bool: Enable monitoring for droplet. Default false (bool)
openPorts List[str]: Make the specified port number accessible from the Internet. (list)
privateAddressOnly bool: Only use a private IP address. Default false (bool)
requestSpotInstance bool: Set this flag to request spot instance. Default false (bool)
retries str: Set retry count for recoverable failures (use -1 to disable). Default 5 (string)
rootSize str: AWS root disk size (in GB). Default 16 (string)
secret_key str: AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
securityGroupReadonly bool: Skip adding default rules to security groups (bool)
sessionToken str: AWS Session Token (string)
spotPrice str: AWS spot instance bid price (in dollar). Default 0.50 (string)
sshKeypath str: SSH Key for Instance (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tags str: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
useEbsOptimizedInstance bool: Create an EBS optimized instance. Default false (bool)
usePrivateAddress bool: Force the usage of private IP address. Default false (bool)
userdata str: Path to file with cloud-init user-data (string)
volumeType str: Amazon EBS volume type. Default gp2 (string)

NodeTemplateAzureConfig

See the input and output API doc for this type.

AvailabilitySet string: Azure Availability Set to place the virtual machine into. Default docker-machine (string)
ClientId string: Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
ClientSecret string: Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
CustomData string: Path to file with custom-data (string)
DiskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
Dns string: A unique DNS label for the public IP adddress (string)
DockerPort string: Docker Port. Default 2376 (string)
Environment string: Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string) fault_domain_count - (Optional) Fault domain count to use for availability set. Default 3 (string)
FaultDomainCount string
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
Location string: Azure region to create the virtual machine. Default westus (string)
ManagedDisks bool: Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)
NoPublicIp bool: Do not create a public IP address for the machine. Default false (bool)
OpenPorts List<string>: Make the specified port number accessible from the Internet. (list)
PrivateIpAddress string: Specify a static private IP address for the machine. (string)
ResourceGroup string: Azure Resource Group name (will be created if missing). Default docker-machine (string)
Size string: Digital Ocean size. Default s-1vcpu-1gb (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
StaticPublicIp bool: Assign a static public IP address to the machine. Default false (bool)
StorageType string: Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)
Subnet string: Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)
SubnetPrefix string: Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)
SubscriptionId string: Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
UpdateDomainCount string: Update domain count to use for availability set. Default 5 (string)
UsePrivateIp bool: Use private IP address of the machine to connect. Default false (bool)
Vnet string: Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

AvailabilitySet string: Azure Availability Set to place the virtual machine into. Default docker-machine (string)
ClientId string: Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
ClientSecret string: Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
CustomData string: Path to file with custom-data (string)
DiskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
Dns string: A unique DNS label for the public IP adddress (string)
DockerPort string: Docker Port. Default 2376 (string)
Environment string: Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string) fault_domain_count - (Optional) Fault domain count to use for availability set. Default 3 (string)
FaultDomainCount string
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
Location string: Azure region to create the virtual machine. Default westus (string)
ManagedDisks bool: Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)
NoPublicIp bool: Do not create a public IP address for the machine. Default false (bool)
OpenPorts []string: Make the specified port number accessible from the Internet. (list)
PrivateIpAddress string: Specify a static private IP address for the machine. (string)
ResourceGroup string: Azure Resource Group name (will be created if missing). Default docker-machine (string)
Size string: Digital Ocean size. Default s-1vcpu-1gb (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
StaticPublicIp bool: Assign a static public IP address to the machine. Default false (bool)
StorageType string: Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)
Subnet string: Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)
SubnetPrefix string: Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)
SubscriptionId string: Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
UpdateDomainCount string: Update domain count to use for availability set. Default 5 (string)
UsePrivateIp bool: Use private IP address of the machine to connect. Default false (bool)
Vnet string: Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

availabilitySet string: Azure Availability Set to place the virtual machine into. Default docker-machine (string)
clientId string: Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
clientSecret string: Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
customData string: Path to file with custom-data (string)
diskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
dns string: A unique DNS label for the public IP adddress (string)
dockerPort string: Docker Port. Default 2376 (string)
environment string: Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string) fault_domain_count - (Optional) Fault domain count to use for availability set. Default 3 (string)
faultDomainCount string
image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
location string: Azure region to create the virtual machine. Default westus (string)
managedDisks boolean: Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)
noPublicIp boolean: Do not create a public IP address for the machine. Default false (bool)
openPorts string[]: Make the specified port number accessible from the Internet. (list)
privateIpAddress string: Specify a static private IP address for the machine. (string)
resourceGroup string: Azure Resource Group name (will be created if missing). Default docker-machine (string)
size string: Digital Ocean size. Default s-1vcpu-1gb (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
staticPublicIp boolean: Assign a static public IP address to the machine. Default false (bool)
storageType string: Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)
subnet string: Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)
subnetPrefix string: Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)
subscriptionId string: Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
updateDomainCount string: Update domain count to use for availability set. Default 5 (string)
usePrivateIp boolean: Use private IP address of the machine to connect. Default false (bool)
vnet string: Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

availabilitySet str: Azure Availability Set to place the virtual machine into. Default docker-machine (string)
client_id str: Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
client_secret str: Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
customData str: Path to file with custom-data (string)
diskSize str: vSphere size of disk for docker VM (in MB). Default 20480 (string)
dns str: A unique DNS label for the public IP adddress (string)
dockerPort str: Docker Port. Default 2376 (string)
environment str: Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string) fault_domain_count - (Optional) Fault domain count to use for availability set. Default 3 (string)
faultDomainCount str
image str: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
location str: Azure region to create the virtual machine. Default westus (string)
managedDisks bool: Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)
noPublicIp bool: Do not create a public IP address for the machine. Default false (bool)
openPorts List[str]: Make the specified port number accessible from the Internet. (list)
privateIpAddress str: Specify a static private IP address for the machine. (string)
resourceGroup str: Azure Resource Group name (will be created if missing). Default docker-machine (string)
size str: Digital Ocean size. Default s-1vcpu-1gb (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
staticPublicIp bool: Assign a static public IP address to the machine. Default false (bool)
storageType str: Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)
subnet str: Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)
subnetPrefix str: Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)
subscriptionId str: Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
updateDomainCount str: Update domain count to use for availability set. Default 5 (string)
usePrivateIp bool: Use private IP address of the machine to connect. Default false (bool)
vnet str: Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

NodeTemplateDigitaloceanConfig

See the input and output API doc for this type.

AccessToken string: Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
Backups bool: Enable backups for droplet. Default false (bool)
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
Ipv6 bool: Enable ipv6 for droplet. Default false (bool)
Monitoring bool: Enable monitoring for droplet. Default false (bool)
PrivateNetworking bool: Enable private networking for droplet. Default false (bool)
Region string: OpenStack region name (string)
Size string: Digital Ocean size. Default s-1vcpu-1gb (string)
SshKeyFingerprint string: SSH key fingerprint (string)
SshKeyPath string: SSH private key path (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Userdata string: Path to file with cloud-init user-data (string)

AccessToken string: Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
Backups bool: Enable backups for droplet. Default false (bool)
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
Ipv6 bool: Enable ipv6 for droplet. Default false (bool)
Monitoring bool: Enable monitoring for droplet. Default false (bool)
PrivateNetworking bool: Enable private networking for droplet. Default false (bool)
Region string: OpenStack region name (string)
Size string: Digital Ocean size. Default s-1vcpu-1gb (string)
SshKeyFingerprint string: SSH key fingerprint (string)
SshKeyPath string: SSH private key path (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Userdata string: Path to file with cloud-init user-data (string)

accessToken string: Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
backups boolean: Enable backups for droplet. Default false (bool)
image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
ipv6 boolean: Enable ipv6 for droplet. Default false (bool)
monitoring boolean: Enable monitoring for droplet. Default false (bool)
privateNetworking boolean: Enable private networking for droplet. Default false (bool)
region string: OpenStack region name (string)
size string: Digital Ocean size. Default s-1vcpu-1gb (string)
sshKeyFingerprint string: SSH key fingerprint (string)
sshKeyPath string: SSH private key path (string)
sshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
userdata string: Path to file with cloud-init user-data (string)

accessToken str: Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
backups bool: Enable backups for droplet. Default false (bool)
image str: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
ipv6 bool: Enable ipv6 for droplet. Default false (bool)
monitoring bool: Enable monitoring for droplet. Default false (bool)
privateNetworking bool: Enable private networking for droplet. Default false (bool)
region str: OpenStack region name (string)
size str: Digital Ocean size. Default s-1vcpu-1gb (string)
sshKeyFingerprint str: SSH key fingerprint (string)
sshKeyPath str: SSH private key path (string)
sshPort str: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tags str: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
userdata str: Path to file with cloud-init user-data (string)

NodeTemplateLinodeConfig

See the input and output API doc for this type.

AuthorizedUsers string: Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)
CreatePrivateIp bool: Create private IP for the instance. Default false (bool)
DockerPort string: Docker Port. Default 2376 (string)
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
InstanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
Label string: Linode Instance Label. (string)
Region string: OpenStack region name (string)
RootPass string: Root Password (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Stackscript string: Specifies the Linode StackScript to use to create the instance. (string)
StackscriptData string: A JSON string specifying data for the selected StackScript. (string)
SwapSize string: Linode Instance Swap Size (MB). Default 512 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Token string: Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
UaPrefix string: Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

AuthorizedUsers string: Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)
CreatePrivateIp bool: Create private IP for the instance. Default false (bool)
DockerPort string: Docker Port. Default 2376 (string)
Image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
InstanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
Label string: Linode Instance Label. (string)
Region string: OpenStack region name (string)
RootPass string: Root Password (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
Stackscript string: Specifies the Linode StackScript to use to create the instance. (string)
StackscriptData string: A JSON string specifying data for the selected StackScript. (string)
SwapSize string: Linode Instance Swap Size (MB). Default 512 (string)
Tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Token string: Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
UaPrefix string: Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

authorizedUsers string: Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)
createPrivateIp boolean: Create private IP for the instance. Default false (bool)
dockerPort string: Docker Port. Default 2376 (string)
image string: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
instanceType string: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
label string: Linode Instance Label. (string)
region string: OpenStack region name (string)
rootPass string: Root Password (string)
sshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
stackscript string: Specifies the Linode StackScript to use to create the instance. (string)
stackscriptData string: A JSON string specifying data for the selected StackScript. (string)
swapSize string: Linode Instance Swap Size (MB). Default 512 (string)
tags string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
token string: Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
uaPrefix string: Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

authorizedUsers str: Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)
createPrivateIp bool: Create private IP for the instance. Default false (bool)
dockerPort str: Docker Port. Default 2376 (string)
image str: Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)
instanceType str: Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)
label str: Linode Instance Label. (string)
region str: OpenStack region name (string)
rootPass str: Root Password (string)
sshPort str: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
stackscript str: Specifies the Linode StackScript to use to create the instance. (string)
stackscriptData str: A JSON string specifying data for the selected StackScript. (string)
swapSize str: Linode Instance Swap Size (MB). Default 512 (string)
tags str: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
token str: Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
uaPrefix str: Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

NodeTemplateOpennebulaConfig

See the input and output API doc for this type.

Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
User string: Set the user for the XML-RPC API authentication (string)
XmlRpcUrl string: Set the url for the Opennebula XML-RPC API (string)
B2dSize string: Size of the Volatile disk in MB - only for b2d (string)
Cpu string: CPU value for the VM (string)
DevPrefix string: Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)
DisableVnc bool: VNC is enabled by default. Disable it with this flag (bool)
DiskResize string: Size of the disk for the VM in MB (string)
ImageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
ImageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
ImageOwner string: Owner of the image to use as the VM OS (string)
Memory string: Size of the memory for the VM in MB (string)
NetworkId string: Opennebula network ID to connect the machine to. Conflicts with network_name (string)
NetworkName string: Opennebula network to connect the machine to. Conflicts with network_id (string)
NetworkOwner string: Opennebula user ID of the Network to connect the machine to (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
TemplateId string: Opennebula template ID to use. Conflicts with template_name (string)
TemplateName string: Name of the Opennbula template to use. Conflicts with template_id (string)
Vcpu string: VCPUs for the VM (string)

Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
User string: Set the user for the XML-RPC API authentication (string)
XmlRpcUrl string: Set the url for the Opennebula XML-RPC API (string)
B2dSize string: Size of the Volatile disk in MB - only for b2d (string)
Cpu string: CPU value for the VM (string)
DevPrefix string: Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)
DisableVnc bool: VNC is enabled by default. Disable it with this flag (bool)
DiskResize string: Size of the disk for the VM in MB (string)
ImageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
ImageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
ImageOwner string: Owner of the image to use as the VM OS (string)
Memory string: Size of the memory for the VM in MB (string)
NetworkId string: Opennebula network ID to connect the machine to. Conflicts with network_name (string)
NetworkName string: Opennebula network to connect the machine to. Conflicts with network_id (string)
NetworkOwner string: Opennebula user ID of the Network to connect the machine to (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
TemplateId string: Opennebula template ID to use. Conflicts with template_name (string)
TemplateName string: Name of the Opennbula template to use. Conflicts with template_id (string)
Vcpu string: VCPUs for the VM (string)

password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
user string: Set the user for the XML-RPC API authentication (string)
xmlRpcUrl string: Set the url for the Opennebula XML-RPC API (string)
b2dSize string: Size of the Volatile disk in MB - only for b2d (string)
cpu string: CPU value for the VM (string)
devPrefix string: Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)
disableVnc boolean: VNC is enabled by default. Disable it with this flag (bool)
diskResize string: Size of the disk for the VM in MB (string)
imageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
imageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
imageOwner string: Owner of the image to use as the VM OS (string)
memory string: Size of the memory for the VM in MB (string)
networkId string: Opennebula network ID to connect the machine to. Conflicts with network_name (string)
networkName string: Opennebula network to connect the machine to. Conflicts with network_id (string)
networkOwner string: Opennebula user ID of the Network to connect the machine to (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
templateId string: Opennebula template ID to use. Conflicts with template_name (string)
templateName string: Name of the Opennbula template to use. Conflicts with template_id (string)
vcpu string: VCPUs for the VM (string)

password str: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
user str: Set the user for the XML-RPC API authentication (string)
xmlRpcUrl str: Set the url for the Opennebula XML-RPC API (string)
b2dSize str: Size of the Volatile disk in MB - only for b2d (string)
cpu str: CPU value for the VM (string)
devPrefix str: 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 str: Size of the disk for the VM in MB (string)
imageId str: OpenStack image id to use for the instance. Conflicts with image_name (string)
imageName str: OpenStack image name to use for the instance. Conflicts with image_id (string)
imageOwner str: Owner of the image to use as the VM OS (string)
memory str: Size of the memory for the VM in MB (string)
networkId str: Opennebula network ID to connect the machine to. Conflicts with network_name (string)
networkName str: Opennebula network to connect the machine to. Conflicts with network_id (string)
networkOwner str: Opennebula user ID of the Network to connect the machine to (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
templateId str: Opennebula template ID to use. Conflicts with template_name (string)
template_name str: Name of the Opennbula template to use. Conflicts with template_id (string)
vcpu str: VCPUs for the VM (string)

NodeTemplateOpenstackConfig

See the input and output API doc for this type.

AuthUrl string: OpenStack authentication URL (string)
AvailabilityZone string: OpenStack availability zone (string)
Region string: OpenStack region name (string)
Username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
ActiveTimeout string: OpenStack active timeout Default 200 (string)
Cacert string: CA certificate bundle to verify against (string)
ConfigDrive bool: Enables the OpenStack config drive for the instance. Default false (bool)
DomainId string: OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)
DomainName string: OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)
EndpointType string: OpenStack endpoint type. adminURL, internalURL or publicURL (string)
FlavorId string: OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)
FlavorName string: OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)
FloatingIpPool string: OpenStack floating IP pool to get an IP from to assign to the instance (string)
ImageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
ImageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
Insecure bool: Disable TLS credential checking. Default false (bool)
IpVersion string: OpenStack version of IP address assigned for the machine Default 4 (string)
KeypairName string: OpenStack keypair to use to SSH to the instance (string)
NetId string: OpenStack network id the machine will be connected on. Conflicts with net_name (string)
NetName string: OpenStack network name the machine will be connected on. Conflicts with net_id (string)
NovaNetwork bool: Use the nova networking services instead of neutron (string)
Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
PrivateKeyFile string: Private key content to use for SSH (string)
SecGroups string: OpenStack comma separated security groups for the machine (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
TenantId string: OpenStack tenant id. Conflicts with tenant_name (string)
TenantName string: OpenStack tenant name. Conflicts with tenant_id (string)
UserDataFile string: File containing an openstack userdata script (string)

AuthUrl string: OpenStack authentication URL (string)
AvailabilityZone string: OpenStack availability zone (string)
Region string: OpenStack region name (string)
Username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
ActiveTimeout string: OpenStack active timeout Default 200 (string)
Cacert string: CA certificate bundle to verify against (string)
ConfigDrive bool: Enables the OpenStack config drive for the instance. Default false (bool)
DomainId string: OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)
DomainName string: OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)
EndpointType string: OpenStack endpoint type. adminURL, internalURL or publicURL (string)
FlavorId string: OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)
FlavorName string: OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)
FloatingIpPool string: OpenStack floating IP pool to get an IP from to assign to the instance (string)
ImageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
ImageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
Insecure bool: Disable TLS credential checking. Default false (bool)
IpVersion string: OpenStack version of IP address assigned for the machine Default 4 (string)
KeypairName string: OpenStack keypair to use to SSH to the instance (string)
NetId string: OpenStack network id the machine will be connected on. Conflicts with net_name (string)
NetName string: OpenStack network name the machine will be connected on. Conflicts with net_id (string)
NovaNetwork bool: Use the nova networking services instead of neutron (string)
Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
PrivateKeyFile string: Private key content to use for SSH (string)
SecGroups string: OpenStack comma separated security groups for the machine (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
TenantId string: OpenStack tenant id. Conflicts with tenant_name (string)
TenantName string: OpenStack tenant name. Conflicts with tenant_id (string)
UserDataFile string: File containing an openstack userdata script (string)

authUrl string: OpenStack authentication URL (string)
availabilityZone string: OpenStack availability zone (string)
region string: OpenStack region name (string)
username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
activeTimeout string: OpenStack active timeout Default 200 (string)
cacert string: CA certificate bundle to verify against (string)
configDrive boolean: Enables the OpenStack config drive for the instance. Default false (bool)
domainId string: OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)
domainName string: OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)
endpointType string: OpenStack endpoint type. adminURL, internalURL or publicURL (string)
flavorId string: OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)
flavorName string: OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)
floatingIpPool string: OpenStack floating IP pool to get an IP from to assign to the instance (string)
imageId string: OpenStack image id to use for the instance. Conflicts with image_name (string)
imageName string: OpenStack image name to use for the instance. Conflicts with image_id (string)
insecure boolean: Disable TLS credential checking. Default false (bool)
ipVersion string: OpenStack version of IP address assigned for the machine Default 4 (string)
keypairName string: OpenStack keypair to use to SSH to the instance (string)
netId string: OpenStack network id the machine will be connected on. Conflicts with net_name (string)
netName string: OpenStack network name the machine will be connected on. Conflicts with net_id (string)
novaNetwork boolean: Use the nova networking services instead of neutron (string)
password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
privateKeyFile string: Private key content to use for SSH (string)
secGroups string: OpenStack comma separated security groups for the machine (string)
sshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tenantId string: OpenStack tenant id. Conflicts with tenant_name (string)
tenantName string: OpenStack tenant name. Conflicts with tenant_id (string)
userDataFile string: File containing an openstack userdata script (string)

authUrl str: OpenStack authentication URL (string)
availabilityZone str: OpenStack availability zone (string)
region str: OpenStack region name (string)
username str: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
activeTimeout str: OpenStack active timeout Default 200 (string)
cacert str: CA certificate bundle to verify against (string)
configDrive bool: Enables the OpenStack config drive for the instance. Default false (bool)
domainId str: OpenStack domain ID. Identity v3 only. Conflicts with domain_name (string)
domainName str: OpenStack domain name. Identity v3 only. Conflicts with domain_id (string)
endpointType str: OpenStack endpoint type. adminURL, internalURL or publicURL (string)
flavorId str: OpenStack flavor id to use for the instance. Conflicts with flavor_name (string)
flavorName str: OpenStack flavor name to use for the instance. Conflicts with flavor_id (string)
floatingIpPool str: OpenStack floating IP pool to get an IP from to assign to the instance (string)
imageId str: OpenStack image id to use for the instance. Conflicts with image_name (string)
imageName str: OpenStack image name to use for the instance. Conflicts with image_id (string)
insecure bool: Disable TLS credential checking. Default false (bool)
ipVersion str: OpenStack version of IP address assigned for the machine Default 4 (string)
keypairName str: OpenStack keypair to use to SSH to the instance (string)
netId str: OpenStack network id the machine will be connected on. Conflicts with net_name (string)
netName str: 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 str: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
privateKeyFile str: Private key content to use for SSH (string)
secGroups str: OpenStack comma separated security groups for the machine (string)
sshPort str: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
tenantName str: OpenStack tenant name. Conflicts with tenant_id (string)
tenant_id str: OpenStack tenant id. Conflicts with tenant_name (string)
userDataFile str: File containing an openstack userdata script (string)

NodeTemplateVsphereConfig

See the input and output API doc for this type.

Boot2dockerUrl string: vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)
Cfgparams List<string>: vSphere vm configuration parameters (used for guestinfo) (list)
CloneFrom string: If you choose creation type clone a name of what you want to clone is required. From Rancher v2.3.3 (string)
CloudConfig string: Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)
Cloudinit string: vSphere cloud-init file or url to set in the guestinfo (string)
ContentLibrary string: If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)
CpuCount string: vSphere CPU number for docker VM. Default 2 (string)
CreationType string: Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)
CustomAttributes List<string>: vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)
Datacenter string: vSphere datacenter for docker VM (string)
Datastore string: vSphere datastore for docker VM (string)
DatastoreCluster string: vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)
DiskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
Folder string: vSphere folder for the docker VM. This folder must already exist in the datacenter (string)
Hostsystem string: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)
MemorySize string: vSphere size of memory for docker VM (in MB). Default 2048 (string)
Networks List<string>: vSphere network where the docker VM will be attached (list)
Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
Pool string: vSphere resource pool for docker VM (string)
SshPassword string: If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
SshUserGroup string: If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)
Tags List<string>: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
VappIpAllocationPolicy string: vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)
VappIpProtocol string: vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)
VappProperties List<string>: vSphere vApp properties (list)
VappTransport string: vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)
Vcenter string: vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
VcenterPort string: vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x. Default 443 (string)

Boot2dockerUrl string: vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)
Cfgparams []string: vSphere vm configuration parameters (used for guestinfo) (list)
CloneFrom string: If you choose creation type clone a name of what you want to clone is required. From Rancher v2.3.3 (string)
CloudConfig string: Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)
Cloudinit string: vSphere cloud-init file or url to set in the guestinfo (string)
ContentLibrary string: If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)
CpuCount string: vSphere CPU number for docker VM. Default 2 (string)
CreationType string: Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)
CustomAttributes []string: vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)
Datacenter string: vSphere datacenter for docker VM (string)
Datastore string: vSphere datastore for docker VM (string)
DatastoreCluster string: vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)
DiskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
Folder string: vSphere folder for the docker VM. This folder must already exist in the datacenter (string)
Hostsystem string: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)
MemorySize string: vSphere size of memory for docker VM (in MB). Default 2048 (string)
Networks []string: vSphere network where the docker VM will be attached (list)
Password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
Pool string: vSphere resource pool for docker VM (string)
SshPassword string: If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)
SshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
SshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
SshUserGroup string: If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)
Tags []string: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
Username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
VappIpAllocationPolicy string: vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)
VappIpProtocol string: vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)
VappProperties []string: vSphere vApp properties (list)
VappTransport string: vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)
Vcenter string: vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
VcenterPort string: vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x. Default 443 (string)

boot2dockerUrl string: vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)
cfgparams string[]: vSphere vm configuration parameters (used for guestinfo) (list)
cloneFrom string: If you choose creation type clone a name of what you want to clone is required. From Rancher v2.3.3 (string)
cloudConfig string: Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)
cloudinit string: vSphere cloud-init file or url to set in the guestinfo (string)
contentLibrary string: If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)
cpuCount string: vSphere CPU number for docker VM. Default 2 (string)
creationType string: Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)
customAttributes string[]: vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)
datacenter string: vSphere datacenter for docker VM (string)
datastore string: vSphere datastore for docker VM (string)
datastoreCluster string: vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)
diskSize string: vSphere size of disk for docker VM (in MB). Default 20480 (string)
folder string: vSphere folder for the docker VM. This folder must already exist in the datacenter (string)
hostsystem string: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)
memorySize string: vSphere size of memory for docker VM (in MB). Default 2048 (string)
networks string[]: vSphere network where the docker VM will be attached (list)
password string: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
pool string: vSphere resource pool for docker VM (string)
sshPassword string: If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)
sshPort string: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser string: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
sshUserGroup string: If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)
tags string[]: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
username string: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
vappIpAllocationPolicy string: vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)
vappIpProtocol string: vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)
vappProperties string[]: vSphere vApp properties (list)
vappTransport string: vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)
vcenter string: vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
vcenterPort string: vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x. Default 443 (string)

boot2dockerUrl str: vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)
cfgparams List[str]: vSphere vm configuration parameters (used for guestinfo) (list)
cloneFrom str: If you choose creation type clone a name of what you want to clone is required. From Rancher v2.3.3 (string)
cloudConfig str: Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)
cloudinit str: vSphere cloud-init file or url to set in the guestinfo (string)
contentLibrary str: If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)
cpuCount str: vSphere CPU number for docker VM. Default 2 (string)
creationType str: Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)
customAttributes List[str]: vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)
datacenter str: vSphere datacenter for docker VM (string)
datastore str: vSphere datastore for docker VM (string)
datastoreCluster str: vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)
diskSize str: vSphere size of disk for docker VM (in MB). Default 20480 (string)
folder str: vSphere folder for the docker VM. This folder must already exist in the datacenter (string)
hostsystem str: vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)
memorySize str: vSphere size of memory for docker VM (in MB). Default 2048 (string)
networks List[str]: vSphere network where the docker VM will be attached (list)
password str: vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
pool str: vSphere resource pool for docker VM (string)
sshPassword str: If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)
sshPort str: If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)
sshUser str: If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)
sshUserGroup str: If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)
tags List[str]: vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)
username str: vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
vappIpAllocationPolicy str: vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)
vappIpProtocol str: vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)
vappProperties List[str]: vSphere vApp properties (list)
vappTransport str: vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)
vcenter str: vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)
vcenterPort str: vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x. Default 443 (string)

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

NodeTemplate

Example Usage

Create a NodeTemplate Resource

NodeTemplate Resource Properties

Inputs

Outputs

Look up an Existing NodeTemplate Resource

Supporting Types

NodeTemplateAmazonec2Config

NodeTemplateAzureConfig

NodeTemplateDigitaloceanConfig

NodeTemplateLinodeConfig

NodeTemplateOpennebulaConfig

NodeTemplateOpenstackConfig

NodeTemplateVsphereConfig

Package Details

On This Page