opennebula 1.4.1, Apr 14 25

opennebula 1.4.1 published on Monday, Apr 14, 2025 by opennebula

opennebula/terraform-provider-opennebula

opennebula.VirtualRouterInstance

Explore with Pulumi AI

opennebula 1.4.1 published on Monday, Apr 14, 2025 by opennebula

opennebula/terraform-provider-opennebula

Example Usage

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

const exampleVirtualRouterInstanceTemplate = new opennebula.VirtualRouterInstanceTemplate("exampleVirtualRouterInstanceTemplate", {
    permissions: "642",
    group: "oneadmin",
    cpu: 0.5,
    vcpu: 1,
    memory: 512,
    context: {
        dns_hostname: "yes",
        network: "YES",
    },
    graphics: {
        keymap: "en-us",
        listen: "0.0.0.0",
        type: "VNC",
    },
    os: {
        arch: "x86_64",
        boot: "",
    },
    tags: {
        environment: "example",
    },
});
const exampleVirtualRouter = new opennebula.VirtualRouter("exampleVirtualRouter", {
    permissions: "642",
    group: "oneadmin",
    description: "This is an example of virtual router",
    instanceTemplateId: exampleVirtualRouterInstanceTemplate.virtualRouterInstanceTemplateId,
    lock: "USE",
    tags: {
        environment: "example",
    },
});
const exampleVirtualRouterInstance = new opennebula.VirtualRouterInstance("exampleVirtualRouterInstance", {
    group: "oneadmin",
    permissions: "642",
    memory: 128,
    cpu: 0.1,
    virtualRouterId: exampleVirtualRouter.virtualRouterId,
    tags: {
        environment: "example",
    },
    templateSections: [{
        name: "exmaple",
        elements: {
            key1: "value1",
        },
    }],
});

import pulumi
import pulumi_opennebula as opennebula

example_virtual_router_instance_template = opennebula.VirtualRouterInstanceTemplate("exampleVirtualRouterInstanceTemplate",
    permissions="642",
    group="oneadmin",
    cpu=0.5,
    vcpu=1,
    memory=512,
    context={
        "dns_hostname": "yes",
        "network": "YES",
    },
    graphics={
        "keymap": "en-us",
        "listen": "0.0.0.0",
        "type": "VNC",
    },
    os={
        "arch": "x86_64",
        "boot": "",
    },
    tags={
        "environment": "example",
    })
example_virtual_router = opennebula.VirtualRouter("exampleVirtualRouter",
    permissions="642",
    group="oneadmin",
    description="This is an example of virtual router",
    instance_template_id=example_virtual_router_instance_template.virtual_router_instance_template_id,
    lock="USE",
    tags={
        "environment": "example",
    })
example_virtual_router_instance = opennebula.VirtualRouterInstance("exampleVirtualRouterInstance",
    group="oneadmin",
    permissions="642",
    memory=128,
    cpu=0.1,
    virtual_router_id=example_virtual_router.virtual_router_id,
    tags={
        "environment": "example",
    },
    template_sections=[{
        "name": "exmaple",
        "elements": {
            "key1": "value1",
        },
    }])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opennebula/opennebula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleVirtualRouterInstanceTemplate, err := opennebula.NewVirtualRouterInstanceTemplate(ctx, "exampleVirtualRouterInstanceTemplate", &opennebula.VirtualRouterInstanceTemplateArgs{
			Permissions: pulumi.String("642"),
			Group:       pulumi.String("oneadmin"),
			Cpu:         pulumi.Float64(0.5),
			Vcpu:        pulumi.Float64(1),
			Memory:      pulumi.Float64(512),
			Context: pulumi.StringMap{
				"dns_hostname": pulumi.String("yes"),
				"network":      pulumi.String("YES"),
			},
			Graphics: &opennebula.VirtualRouterInstanceTemplateGraphicsArgs{
				Keymap: pulumi.String("en-us"),
				Listen: pulumi.String("0.0.0.0"),
				Type:   pulumi.String("VNC"),
			},
			Os: &opennebula.VirtualRouterInstanceTemplateOsArgs{
				Arch: pulumi.String("x86_64"),
				Boot: pulumi.String(""),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleVirtualRouter, err := opennebula.NewVirtualRouter(ctx, "exampleVirtualRouter", &opennebula.VirtualRouterArgs{
			Permissions:        pulumi.String("642"),
			Group:              pulumi.String("oneadmin"),
			Description:        pulumi.String("This is an example of virtual router"),
			InstanceTemplateId: exampleVirtualRouterInstanceTemplate.VirtualRouterInstanceTemplateId,
			Lock:               pulumi.String("USE"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		_, err = opennebula.NewVirtualRouterInstance(ctx, "exampleVirtualRouterInstance", &opennebula.VirtualRouterInstanceArgs{
			Group:           pulumi.String("oneadmin"),
			Permissions:     pulumi.String("642"),
			Memory:          pulumi.Float64(128),
			Cpu:             pulumi.Float64(0.1),
			VirtualRouterId: exampleVirtualRouter.VirtualRouterId,
			Tags: pulumi.StringMap{
				"environment": pulumi.String("example"),
			},
			TemplateSections: opennebula.VirtualRouterInstanceTemplateSectionArray{
				&opennebula.VirtualRouterInstanceTemplateSectionArgs{
					Name: pulumi.String("exmaple"),
					Elements: pulumi.StringMap{
						"key1": pulumi.String("value1"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opennebula = Pulumi.Opennebula;

return await Deployment.RunAsync(() => 
{
    var exampleVirtualRouterInstanceTemplate = new Opennebula.VirtualRouterInstanceTemplate("exampleVirtualRouterInstanceTemplate", new()
    {
        Permissions = "642",
        Group = "oneadmin",
        Cpu = 0.5,
        Vcpu = 1,
        Memory = 512,
        Context = 
        {
            { "dns_hostname", "yes" },
            { "network", "YES" },
        },
        Graphics = new Opennebula.Inputs.VirtualRouterInstanceTemplateGraphicsArgs
        {
            Keymap = "en-us",
            Listen = "0.0.0.0",
            Type = "VNC",
        },
        Os = new Opennebula.Inputs.VirtualRouterInstanceTemplateOsArgs
        {
            Arch = "x86_64",
            Boot = "",
        },
        Tags = 
        {
            { "environment", "example" },
        },
    });

    var exampleVirtualRouter = new Opennebula.VirtualRouter("exampleVirtualRouter", new()
    {
        Permissions = "642",
        Group = "oneadmin",
        Description = "This is an example of virtual router",
        InstanceTemplateId = exampleVirtualRouterInstanceTemplate.VirtualRouterInstanceTemplateId,
        Lock = "USE",
        Tags = 
        {
            { "environment", "example" },
        },
    });

    var exampleVirtualRouterInstance = new Opennebula.VirtualRouterInstance("exampleVirtualRouterInstance", new()
    {
        Group = "oneadmin",
        Permissions = "642",
        Memory = 128,
        Cpu = 0.1,
        VirtualRouterId = exampleVirtualRouter.VirtualRouterId,
        Tags = 
        {
            { "environment", "example" },
        },
        TemplateSections = new[]
        {
            new Opennebula.Inputs.VirtualRouterInstanceTemplateSectionArgs
            {
                Name = "exmaple",
                Elements = 
                {
                    { "key1", "value1" },
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opennebula.VirtualRouterInstanceTemplate;
import com.pulumi.opennebula.VirtualRouterInstanceTemplateArgs;
import com.pulumi.opennebula.inputs.VirtualRouterInstanceTemplateGraphicsArgs;
import com.pulumi.opennebula.inputs.VirtualRouterInstanceTemplateOsArgs;
import com.pulumi.opennebula.VirtualRouter;
import com.pulumi.opennebula.VirtualRouterArgs;
import com.pulumi.opennebula.VirtualRouterInstance;
import com.pulumi.opennebula.VirtualRouterInstanceArgs;
import com.pulumi.opennebula.inputs.VirtualRouterInstanceTemplateSectionArgs;
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) {
        var exampleVirtualRouterInstanceTemplate = new VirtualRouterInstanceTemplate("exampleVirtualRouterInstanceTemplate", VirtualRouterInstanceTemplateArgs.builder()
            .permissions("642")
            .group("oneadmin")
            .cpu("0.5")
            .vcpu("1")
            .memory("512")
            .context(Map.ofEntries(
                Map.entry("dns_hostname", "yes"),
                Map.entry("network", "YES")
            ))
            .graphics(VirtualRouterInstanceTemplateGraphicsArgs.builder()
                .keymap("en-us")
                .listen("0.0.0.0")
                .type("VNC")
                .build())
            .os(VirtualRouterInstanceTemplateOsArgs.builder()
                .arch("x86_64")
                .boot("")
                .build())
            .tags(Map.of("environment", "example"))
            .build());

        var exampleVirtualRouter = new VirtualRouter("exampleVirtualRouter", VirtualRouterArgs.builder()
            .permissions("642")
            .group("oneadmin")
            .description("This is an example of virtual router")
            .instanceTemplateId(exampleVirtualRouterInstanceTemplate.virtualRouterInstanceTemplateId())
            .lock("USE")
            .tags(Map.of("environment", "example"))
            .build());

        var exampleVirtualRouterInstance = new VirtualRouterInstance("exampleVirtualRouterInstance", VirtualRouterInstanceArgs.builder()
            .group("oneadmin")
            .permissions("642")
            .memory(128)
            .cpu(0.1)
            .virtualRouterId(exampleVirtualRouter.virtualRouterId())
            .tags(Map.of("environment", "example"))
            .templateSections(VirtualRouterInstanceTemplateSectionArgs.builder()
                .name("exmaple")
                .elements(Map.of("key1", "value1"))
                .build())
            .build());

    }
}

resources:
  exampleVirtualRouterInstanceTemplate:
    type: opennebula:VirtualRouterInstanceTemplate
    properties:
      permissions: '642'
      group: oneadmin
      cpu: '0.5'
      vcpu: '1'
      memory: '512'
      context:
        dns_hostname: yes
        network: YES
      graphics:
        keymap: en-us
        listen: 0.0.0.0
        type: VNC
      os:
        arch: x86_64
        boot: ""
      tags:
        environment: example
  exampleVirtualRouter:
    type: opennebula:VirtualRouter
    properties:
      permissions: '642'
      group: oneadmin
      description: This is an example of virtual router
      instanceTemplateId: ${exampleVirtualRouterInstanceTemplate.virtualRouterInstanceTemplateId}
      lock: USE
      tags:
        environment: example
  exampleVirtualRouterInstance:
    type: opennebula:VirtualRouterInstance
    properties:
      group: oneadmin
      permissions: '642'
      memory: 128
      cpu: 0.1
      virtualRouterId: ${exampleVirtualRouter.virtualRouterId}
      tags:
        environment: example
      templateSections:
        - name: exmaple
          elements:
            key1: value1

Instantiate from a template

A virtual router instance is created from a template. The template ID is defined in the virtual router resource.

For all virtual router instance parameters excepted context: parameters present in instance overrides parameters defined in template. For context: it merges them.

For disks defined in the template, if they are not overriden, are described in template_disk attributes of the instantiated virtual router instance and are not modifiable anymore.

Create VirtualRouterInstance Resource

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

Constructor syntax

new VirtualRouterInstance(name: string, args: VirtualRouterInstanceArgs, opts?: CustomResourceOptions);

@overload
def VirtualRouterInstance(resource_name: str,
                          args: VirtualRouterInstanceArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def VirtualRouterInstance(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          virtual_router_id: Optional[float] = None,
                          os: Optional[VirtualRouterInstanceOsArgs] = None,
                          vcpu: Optional[float] = None,
                          description: Optional[str] = None,
                          disks: Optional[Sequence[VirtualRouterInstanceDiskArgs]] = None,
                          graphics: Optional[VirtualRouterInstanceGraphicsArgs] = None,
                          group: Optional[str] = None,
                          hard_shutdown: Optional[bool] = None,
                          lock: Optional[str] = None,
                          memory: Optional[float] = None,
                          name: Optional[str] = None,
                          on_disk_change: Optional[str] = None,
                          context: Optional[Mapping[str, str]] = None,
                          cpumodel: Optional[VirtualRouterInstanceCpumodelArgs] = None,
                          raw: Optional[VirtualRouterInstanceRawArgs] = None,
                          pending: Optional[bool] = None,
                          sched_ds_requirements: Optional[str] = None,
                          sched_requirements: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          template_sections: Optional[Sequence[VirtualRouterInstanceTemplateSectionArgs]] = None,
                          timeout: Optional[float] = None,
                          timeouts: Optional[VirtualRouterInstanceTimeoutsArgs] = None,
                          permissions: Optional[str] = None,
                          cpu: Optional[float] = None,
                          virtual_router_instance_id: Optional[str] = None,
                          vmgroup: Optional[VirtualRouterInstanceVmgroupArgs] = None)

func NewVirtualRouterInstance(ctx *Context, name string, args VirtualRouterInstanceArgs, opts ...ResourceOption) (*VirtualRouterInstance, error)

public VirtualRouterInstance(string name, VirtualRouterInstanceArgs args, CustomResourceOptions? opts = null)

public VirtualRouterInstance(String name, VirtualRouterInstanceArgs args)
public VirtualRouterInstance(String name, VirtualRouterInstanceArgs args, CustomResourceOptions options)

type: opennebula:VirtualRouterInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

resource_name str: The unique name of the resource.
args VirtualRouterInstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args VirtualRouterInstanceArgs: 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 virtualRouterInstanceResource = new Opennebula.VirtualRouterInstance("virtualRouterInstanceResource", new()
{
    VirtualRouterId = 0,
    Os = new Opennebula.Inputs.VirtualRouterInstanceOsArgs
    {
        Arch = "string",
        Boot = "string",
    },
    Vcpu = 0,
    Description = "string",
    Disks = new[]
    {
        new Opennebula.Inputs.VirtualRouterInstanceDiskArgs
        {
            Cache = "string",
            ComputedCache = "string",
            ComputedDevPrefix = "string",
            ComputedDiscard = "string",
            ComputedDriver = "string",
            ComputedIo = "string",
            ComputedSize = 0,
            ComputedTarget = "string",
            ComputedVolatileFormat = "string",
            DevPrefix = "string",
            Discard = "string",
            DiskId = 0,
            Driver = "string",
            ImageId = 0,
            Io = "string",
            Size = 0,
            Target = "string",
            VolatileFormat = "string",
            VolatileType = "string",
        },
    },
    Graphics = new Opennebula.Inputs.VirtualRouterInstanceGraphicsArgs
    {
        Listen = "string",
        Type = "string",
        Keymap = "string",
        Passwd = "string",
        Port = "string",
        RandomPasswd = false,
    },
    Group = "string",
    HardShutdown = false,
    Lock = "string",
    Memory = 0,
    Name = "string",
    OnDiskChange = "string",
    Context = 
    {
        { "string", "string" },
    },
    Cpumodel = new Opennebula.Inputs.VirtualRouterInstanceCpumodelArgs
    {
        Model = "string",
    },
    Raw = new Opennebula.Inputs.VirtualRouterInstanceRawArgs
    {
        Data = "string",
        Type = "string",
    },
    Pending = false,
    SchedDsRequirements = "string",
    SchedRequirements = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TemplateSections = new[]
    {
        new Opennebula.Inputs.VirtualRouterInstanceTemplateSectionArgs
        {
            Name = "string",
            Elements = 
            {
                { "string", "string" },
            },
        },
    },
    Timeouts = new Opennebula.Inputs.VirtualRouterInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Permissions = "string",
    Cpu = 0,
    VirtualRouterInstanceId = "string",
    Vmgroup = new Opennebula.Inputs.VirtualRouterInstanceVmgroupArgs
    {
        Role = "string",
        VmgroupId = 0,
    },
});

example, err := opennebula.NewVirtualRouterInstance(ctx, "virtualRouterInstanceResource", &opennebula.VirtualRouterInstanceArgs{
	VirtualRouterId: pulumi.Float64(0),
	Os: &opennebula.VirtualRouterInstanceOsArgs{
		Arch: pulumi.String("string"),
		Boot: pulumi.String("string"),
	},
	Vcpu:        pulumi.Float64(0),
	Description: pulumi.String("string"),
	Disks: opennebula.VirtualRouterInstanceDiskArray{
		&opennebula.VirtualRouterInstanceDiskArgs{
			Cache:                  pulumi.String("string"),
			ComputedCache:          pulumi.String("string"),
			ComputedDevPrefix:      pulumi.String("string"),
			ComputedDiscard:        pulumi.String("string"),
			ComputedDriver:         pulumi.String("string"),
			ComputedIo:             pulumi.String("string"),
			ComputedSize:           pulumi.Float64(0),
			ComputedTarget:         pulumi.String("string"),
			ComputedVolatileFormat: pulumi.String("string"),
			DevPrefix:              pulumi.String("string"),
			Discard:                pulumi.String("string"),
			DiskId:                 pulumi.Float64(0),
			Driver:                 pulumi.String("string"),
			ImageId:                pulumi.Float64(0),
			Io:                     pulumi.String("string"),
			Size:                   pulumi.Float64(0),
			Target:                 pulumi.String("string"),
			VolatileFormat:         pulumi.String("string"),
			VolatileType:           pulumi.String("string"),
		},
	},
	Graphics: &opennebula.VirtualRouterInstanceGraphicsArgs{
		Listen:       pulumi.String("string"),
		Type:         pulumi.String("string"),
		Keymap:       pulumi.String("string"),
		Passwd:       pulumi.String("string"),
		Port:         pulumi.String("string"),
		RandomPasswd: pulumi.Bool(false),
	},
	Group:        pulumi.String("string"),
	HardShutdown: pulumi.Bool(false),
	Lock:         pulumi.String("string"),
	Memory:       pulumi.Float64(0),
	Name:         pulumi.String("string"),
	OnDiskChange: pulumi.String("string"),
	Context: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Cpumodel: &opennebula.VirtualRouterInstanceCpumodelArgs{
		Model: pulumi.String("string"),
	},
	Raw: &opennebula.VirtualRouterInstanceRawArgs{
		Data: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	Pending:             pulumi.Bool(false),
	SchedDsRequirements: pulumi.String("string"),
	SchedRequirements:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TemplateSections: opennebula.VirtualRouterInstanceTemplateSectionArray{
		&opennebula.VirtualRouterInstanceTemplateSectionArgs{
			Name: pulumi.String("string"),
			Elements: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	Timeouts: &opennebula.VirtualRouterInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	Permissions:             pulumi.String("string"),
	Cpu:                     pulumi.Float64(0),
	VirtualRouterInstanceId: pulumi.String("string"),
	Vmgroup: &opennebula.VirtualRouterInstanceVmgroupArgs{
		Role:      pulumi.String("string"),
		VmgroupId: pulumi.Float64(0),
	},
})

var virtualRouterInstanceResource = new VirtualRouterInstance("virtualRouterInstanceResource", VirtualRouterInstanceArgs.builder()
    .virtualRouterId(0)
    .os(VirtualRouterInstanceOsArgs.builder()
        .arch("string")
        .boot("string")
        .build())
    .vcpu(0)
    .description("string")
    .disks(VirtualRouterInstanceDiskArgs.builder()
        .cache("string")
        .computedCache("string")
        .computedDevPrefix("string")
        .computedDiscard("string")
        .computedDriver("string")
        .computedIo("string")
        .computedSize(0)
        .computedTarget("string")
        .computedVolatileFormat("string")
        .devPrefix("string")
        .discard("string")
        .diskId(0)
        .driver("string")
        .imageId(0)
        .io("string")
        .size(0)
        .target("string")
        .volatileFormat("string")
        .volatileType("string")
        .build())
    .graphics(VirtualRouterInstanceGraphicsArgs.builder()
        .listen("string")
        .type("string")
        .keymap("string")
        .passwd("string")
        .port("string")
        .randomPasswd(false)
        .build())
    .group("string")
    .hardShutdown(false)
    .lock("string")
    .memory(0)
    .name("string")
    .onDiskChange("string")
    .context(Map.of("string", "string"))
    .cpumodel(VirtualRouterInstanceCpumodelArgs.builder()
        .model("string")
        .build())
    .raw(VirtualRouterInstanceRawArgs.builder()
        .data("string")
        .type("string")
        .build())
    .pending(false)
    .schedDsRequirements("string")
    .schedRequirements("string")
    .tags(Map.of("string", "string"))
    .templateSections(VirtualRouterInstanceTemplateSectionArgs.builder()
        .name("string")
        .elements(Map.of("string", "string"))
        .build())
    .timeouts(VirtualRouterInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .permissions("string")
    .cpu(0)
    .virtualRouterInstanceId("string")
    .vmgroup(VirtualRouterInstanceVmgroupArgs.builder()
        .role("string")
        .vmgroupId(0)
        .build())
    .build());

virtual_router_instance_resource = opennebula.VirtualRouterInstance("virtualRouterInstanceResource",
    virtual_router_id=0,
    os={
        "arch": "string",
        "boot": "string",
    },
    vcpu=0,
    description="string",
    disks=[{
        "cache": "string",
        "computed_cache": "string",
        "computed_dev_prefix": "string",
        "computed_discard": "string",
        "computed_driver": "string",
        "computed_io": "string",
        "computed_size": 0,
        "computed_target": "string",
        "computed_volatile_format": "string",
        "dev_prefix": "string",
        "discard": "string",
        "disk_id": 0,
        "driver": "string",
        "image_id": 0,
        "io": "string",
        "size": 0,
        "target": "string",
        "volatile_format": "string",
        "volatile_type": "string",
    }],
    graphics={
        "listen": "string",
        "type": "string",
        "keymap": "string",
        "passwd": "string",
        "port": "string",
        "random_passwd": False,
    },
    group="string",
    hard_shutdown=False,
    lock="string",
    memory=0,
    name="string",
    on_disk_change="string",
    context={
        "string": "string",
    },
    cpumodel={
        "model": "string",
    },
    raw={
        "data": "string",
        "type": "string",
    },
    pending=False,
    sched_ds_requirements="string",
    sched_requirements="string",
    tags={
        "string": "string",
    },
    template_sections=[{
        "name": "string",
        "elements": {
            "string": "string",
        },
    }],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    permissions="string",
    cpu=0,
    virtual_router_instance_id="string",
    vmgroup={
        "role": "string",
        "vmgroup_id": 0,
    })

const virtualRouterInstanceResource = new opennebula.VirtualRouterInstance("virtualRouterInstanceResource", {
    virtualRouterId: 0,
    os: {
        arch: "string",
        boot: "string",
    },
    vcpu: 0,
    description: "string",
    disks: [{
        cache: "string",
        computedCache: "string",
        computedDevPrefix: "string",
        computedDiscard: "string",
        computedDriver: "string",
        computedIo: "string",
        computedSize: 0,
        computedTarget: "string",
        computedVolatileFormat: "string",
        devPrefix: "string",
        discard: "string",
        diskId: 0,
        driver: "string",
        imageId: 0,
        io: "string",
        size: 0,
        target: "string",
        volatileFormat: "string",
        volatileType: "string",
    }],
    graphics: {
        listen: "string",
        type: "string",
        keymap: "string",
        passwd: "string",
        port: "string",
        randomPasswd: false,
    },
    group: "string",
    hardShutdown: false,
    lock: "string",
    memory: 0,
    name: "string",
    onDiskChange: "string",
    context: {
        string: "string",
    },
    cpumodel: {
        model: "string",
    },
    raw: {
        data: "string",
        type: "string",
    },
    pending: false,
    schedDsRequirements: "string",
    schedRequirements: "string",
    tags: {
        string: "string",
    },
    templateSections: [{
        name: "string",
        elements: {
            string: "string",
        },
    }],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    permissions: "string",
    cpu: 0,
    virtualRouterInstanceId: "string",
    vmgroup: {
        role: "string",
        vmgroupId: 0,
    },
});

type: opennebula:VirtualRouterInstance
properties:
    context:
        string: string
    cpu: 0
    cpumodel:
        model: string
    description: string
    disks:
        - cache: string
          computedCache: string
          computedDevPrefix: string
          computedDiscard: string
          computedDriver: string
          computedIo: string
          computedSize: 0
          computedTarget: string
          computedVolatileFormat: string
          devPrefix: string
          discard: string
          diskId: 0
          driver: string
          imageId: 0
          io: string
          size: 0
          target: string
          volatileFormat: string
          volatileType: string
    graphics:
        keymap: string
        listen: string
        passwd: string
        port: string
        randomPasswd: false
        type: string
    group: string
    hardShutdown: false
    lock: string
    memory: 0
    name: string
    onDiskChange: string
    os:
        arch: string
        boot: string
    pending: false
    permissions: string
    raw:
        data: string
        type: string
    schedDsRequirements: string
    schedRequirements: string
    tags:
        string: string
    templateSections:
        - elements:
            string: string
          name: string
    timeouts:
        create: string
        delete: string
        update: string
    vcpu: 0
    virtualRouterId: 0
    virtualRouterInstanceId: string
    vmgroup:
        role: string
        vmgroupId: 0

VirtualRouterInstance 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 VirtualRouterInstance resource accepts the following input properties:

VirtualRouterId double: The ID of the parent virtual router resource.
Context Dictionary<string, string>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
Cpu double: Amount of CPU shares assigned to the VM.
Cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
Description string: The description of the template.
Disks List<VirtualRouterInstanceDisk>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
Graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
Group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
HardShutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
Lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
Memory double: Amount of RAM assigned to the VM in MB.
Name string: The name of the virtual router instance.
OnDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
Os VirtualRouterInstanceOs: See OS parameters below for details.
Pending bool: Pending state during VM creation. Defaults to false.
Permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
Raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
SchedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
SchedRequirements string: Scheduling requirements to deploy the resource following specific rule.
Tags Dictionary<string, string>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
TemplateSections List<VirtualRouterInstanceTemplateSection>: Add custom section to the resource
Timeout double: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
Timeouts VirtualRouterInstanceTimeouts
Vcpu double: Number of virtual CPUs assigned to the virtual machine
VirtualRouterInstanceId string: ID of the virtual router instance.
Vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

VirtualRouterId float64: The ID of the parent virtual router resource.
Context map[string]string: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
Cpu float64: Amount of CPU shares assigned to the VM.
Cpumodel VirtualRouterInstanceCpumodelArgs: Definition of CPU Model type for the Virtual Machine
Description string: The description of the template.
Disks []VirtualRouterInstanceDiskArgs: Can be specified multiple times to attach several disks. See Disk parameters below for details.
Graphics VirtualRouterInstanceGraphicsArgs: See Graphics parameters below for details.
Group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
HardShutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
Lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
Memory float64: Amount of RAM assigned to the VM in MB.
Name string: The name of the virtual router instance.
OnDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
Os VirtualRouterInstanceOsArgs: See OS parameters below for details.
Pending bool: Pending state during VM creation. Defaults to false.
Permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
Raw VirtualRouterInstanceRawArgs: Low-level hypervisor tuning
SchedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
SchedRequirements string: Scheduling requirements to deploy the resource following specific rule.
Tags map[string]string: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
TemplateSections []VirtualRouterInstanceTemplateSectionArgs: Add custom section to the resource
Timeout float64: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
Timeouts VirtualRouterInstanceTimeoutsArgs
Vcpu float64: Number of virtual CPUs assigned to the virtual machine
VirtualRouterInstanceId string: ID of the virtual router instance.
Vmgroup VirtualRouterInstanceVmgroupArgs: See VM group parameters below for details. Changing this argument triggers a new resource.

virtualRouterId Double: The ID of the parent virtual router resource.
context Map<String,String>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu Double: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
description String: The description of the template.
disks List<VirtualRouterInstanceDisk>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
group String: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown Boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lock String: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory Double: Amount of RAM assigned to the VM in MB.
name String: The name of the virtual router instance.
onDiskChange String: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOs: See OS parameters below for details.
pending Boolean: Pending state during VM creation. Defaults to false.
permissions String: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
schedDsRequirements String: Storage placement requirements to deploy the resource following specific rule.
schedRequirements String: Scheduling requirements to deploy the resource following specific rule.
tags Map<String,String>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
templateSections List<VirtualRouterInstanceTemplateSection>: Add custom section to the resource
timeout Double: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeouts
vcpu Double: Number of virtual CPUs assigned to the virtual machine
virtualRouterInstanceId String: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

virtualRouterId number: The ID of the parent virtual router resource.
context {[key: string]: string}: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu number: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
description string: The description of the template.
disks VirtualRouterInstanceDisk[]: Can be specified multiple times to attach several disks. See Disk parameters below for details.
graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory number: Amount of RAM assigned to the VM in MB.
name string: The name of the virtual router instance.
onDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOs: See OS parameters below for details.
pending boolean: Pending state during VM creation. Defaults to false.
permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
schedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
schedRequirements string: Scheduling requirements to deploy the resource following specific rule.
tags {[key: string]: string}: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
templateSections VirtualRouterInstanceTemplateSection[]: Add custom section to the resource
timeout number: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeouts
vcpu number: Number of virtual CPUs assigned to the virtual machine
virtualRouterInstanceId string: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

virtual_router_id float: The ID of the parent virtual router resource.
context Mapping[str, str]: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu float: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodelArgs: Definition of CPU Model type for the Virtual Machine
description str: The description of the template.
disks Sequence[VirtualRouterInstanceDiskArgs]: Can be specified multiple times to attach several disks. See Disk parameters below for details.
graphics VirtualRouterInstanceGraphicsArgs: See Graphics parameters below for details.
group str: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hard_shutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lock str: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory float: Amount of RAM assigned to the VM in MB.
name str: The name of the virtual router instance.
on_disk_change str: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOsArgs: See OS parameters below for details.
pending bool: Pending state during VM creation. Defaults to false.
permissions str: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRawArgs: Low-level hypervisor tuning
sched_ds_requirements str: Storage placement requirements to deploy the resource following specific rule.
sched_requirements str: Scheduling requirements to deploy the resource following specific rule.
tags Mapping[str, str]: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
template_sections Sequence[VirtualRouterInstanceTemplateSectionArgs]: Add custom section to the resource
timeout float: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeoutsArgs
vcpu float: Number of virtual CPUs assigned to the virtual machine
virtual_router_instance_id str: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroupArgs: See VM group parameters below for details. Changing this argument triggers a new resource.

virtualRouterId Number: The ID of the parent virtual router resource.
context Map<String>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu Number: Amount of CPU shares assigned to the VM.
cpumodel Property Map: Definition of CPU Model type for the Virtual Machine
description String: The description of the template.
disks List<Property Map>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
graphics Property Map: See Graphics parameters below for details.
group String: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown Boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lock String: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory Number: Amount of RAM assigned to the VM in MB.
name String: The name of the virtual router instance.
onDiskChange String: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os Property Map: See OS parameters below for details.
pending Boolean: Pending state during VM creation. Defaults to false.
permissions String: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw Property Map: Low-level hypervisor tuning
schedDsRequirements String: Storage placement requirements to deploy the resource following specific rule.
schedRequirements String: Scheduling requirements to deploy the resource following specific rule.
tags Map<String>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
templateSections List<Property Map>: Add custom section to the resource
timeout Number: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts Property Map
vcpu Number: Number of virtual CPUs assigned to the virtual machine
virtualRouterInstanceId String: ID of the virtual router instance.
vmgroup Property Map: See VM group parameters below for details. Changing this argument triggers a new resource.

Outputs

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

DefaultTags Dictionary<string, string>: Default tags defined in the provider configuration.
Gid double: Group ID which owns the virtual router instance.
Gname string: Group Name which owns the virtual router instance.
Id string: The provider-assigned unique ID for this managed resource.
Lcmstate double: LCM State of the virtual router instance.
State double: State of the virtual router instance.
TagsAll Dictionary<string, string>: Result of the applied default_tags and then resource tags.
TemplateDisks List<VirtualRouterInstanceTemplateDisk>: this contains the template disks description.
TemplateSectionNames Dictionary<string, string>: When template_id was set this keeps the template section names only.
TemplateTags Dictionary<string, string>: When template_id was set this keeps the template tags.
Uid double: User ID whom owns the virtual router instance.
Uname string: User Name whom owns the virtual router instance.

DefaultTags map[string]string: Default tags defined in the provider configuration.
Gid float64: Group ID which owns the virtual router instance.
Gname string: Group Name which owns the virtual router instance.
Id string: The provider-assigned unique ID for this managed resource.
Lcmstate float64: LCM State of the virtual router instance.
State float64: State of the virtual router instance.
TagsAll map[string]string: Result of the applied default_tags and then resource tags.
TemplateDisks []VirtualRouterInstanceTemplateDisk: this contains the template disks description.
TemplateSectionNames map[string]string: When template_id was set this keeps the template section names only.
TemplateTags map[string]string: When template_id was set this keeps the template tags.
Uid float64: User ID whom owns the virtual router instance.
Uname string: User Name whom owns the virtual router instance.

defaultTags Map<String,String>: Default tags defined in the provider configuration.
gid Double: Group ID which owns the virtual router instance.
gname String: Group Name which owns the virtual router instance.
id String: The provider-assigned unique ID for this managed resource.
lcmstate Double: LCM State of the virtual router instance.
state Double: State of the virtual router instance.
tagsAll Map<String,String>: Result of the applied default_tags and then resource tags.
templateDisks List<VirtualRouterInstanceTemplateDisk>: this contains the template disks description.
templateSectionNames Map<String,String>: When template_id was set this keeps the template section names only.
templateTags Map<String,String>: When template_id was set this keeps the template tags.
uid Double: User ID whom owns the virtual router instance.
uname String: User Name whom owns the virtual router instance.

defaultTags {[key: string]: string}: Default tags defined in the provider configuration.
gid number: Group ID which owns the virtual router instance.
gname string: Group Name which owns the virtual router instance.
id string: The provider-assigned unique ID for this managed resource.
lcmstate number: LCM State of the virtual router instance.
state number: State of the virtual router instance.
tagsAll {[key: string]: string}: Result of the applied default_tags and then resource tags.
templateDisks VirtualRouterInstanceTemplateDisk[]: this contains the template disks description.
templateSectionNames {[key: string]: string}: When template_id was set this keeps the template section names only.
templateTags {[key: string]: string}: When template_id was set this keeps the template tags.
uid number: User ID whom owns the virtual router instance.
uname string: User Name whom owns the virtual router instance.

default_tags Mapping[str, str]: Default tags defined in the provider configuration.
gid float: Group ID which owns the virtual router instance.
gname str: Group Name which owns the virtual router instance.
id str: The provider-assigned unique ID for this managed resource.
lcmstate float: LCM State of the virtual router instance.
state float: State of the virtual router instance.
tags_all Mapping[str, str]: Result of the applied default_tags and then resource tags.
template_disks Sequence[VirtualRouterInstanceTemplateDisk]: this contains the template disks description.
template_section_names Mapping[str, str]: When template_id was set this keeps the template section names only.
template_tags Mapping[str, str]: When template_id was set this keeps the template tags.
uid float: User ID whom owns the virtual router instance.
uname str: User Name whom owns the virtual router instance.

defaultTags Map<String>: Default tags defined in the provider configuration.
gid Number: Group ID which owns the virtual router instance.
gname String: Group Name which owns the virtual router instance.
id String: The provider-assigned unique ID for this managed resource.
lcmstate Number: LCM State of the virtual router instance.
state Number: State of the virtual router instance.
tagsAll Map<String>: Result of the applied default_tags and then resource tags.
templateDisks List<Property Map>: this contains the template disks description.
templateSectionNames Map<String>: When template_id was set this keeps the template section names only.
templateTags Map<String>: When template_id was set this keeps the template tags.
uid Number: User ID whom owns the virtual router instance.
uname String: User Name whom owns the virtual router instance.

Look up Existing VirtualRouterInstance Resource

Get an existing VirtualRouterInstance 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?: VirtualRouterInstanceState, opts?: CustomResourceOptions): VirtualRouterInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[Mapping[str, str]] = None,
        cpu: Optional[float] = None,
        cpumodel: Optional[VirtualRouterInstanceCpumodelArgs] = None,
        default_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        disks: Optional[Sequence[VirtualRouterInstanceDiskArgs]] = None,
        gid: Optional[float] = None,
        gname: Optional[str] = None,
        graphics: Optional[VirtualRouterInstanceGraphicsArgs] = None,
        group: Optional[str] = None,
        hard_shutdown: Optional[bool] = None,
        lcmstate: Optional[float] = None,
        lock: Optional[str] = None,
        memory: Optional[float] = None,
        name: Optional[str] = None,
        on_disk_change: Optional[str] = None,
        os: Optional[VirtualRouterInstanceOsArgs] = None,
        pending: Optional[bool] = None,
        permissions: Optional[str] = None,
        raw: Optional[VirtualRouterInstanceRawArgs] = None,
        sched_ds_requirements: Optional[str] = None,
        sched_requirements: Optional[str] = None,
        state: Optional[float] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        template_disks: Optional[Sequence[VirtualRouterInstanceTemplateDiskArgs]] = None,
        template_section_names: Optional[Mapping[str, str]] = None,
        template_sections: Optional[Sequence[VirtualRouterInstanceTemplateSectionArgs]] = None,
        template_tags: Optional[Mapping[str, str]] = None,
        timeout: Optional[float] = None,
        timeouts: Optional[VirtualRouterInstanceTimeoutsArgs] = None,
        uid: Optional[float] = None,
        uname: Optional[str] = None,
        vcpu: Optional[float] = None,
        virtual_router_id: Optional[float] = None,
        virtual_router_instance_id: Optional[str] = None,
        vmgroup: Optional[VirtualRouterInstanceVmgroupArgs] = None) -> VirtualRouterInstance

func GetVirtualRouterInstance(ctx *Context, name string, id IDInput, state *VirtualRouterInstanceState, opts ...ResourceOption) (*VirtualRouterInstance, error)

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

public static VirtualRouterInstance get(String name, Output<String> id, VirtualRouterInstanceState state, CustomResourceOptions options)

resources:  _:    type: opennebula:VirtualRouterInstance    get:      id: ${id}

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.

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:

Context Dictionary<string, string>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
Cpu double: Amount of CPU shares assigned to the VM.
Cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
DefaultTags Dictionary<string, string>: Default tags defined in the provider configuration.
Description string: The description of the template.
Disks List<VirtualRouterInstanceDisk>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
Gid double: Group ID which owns the virtual router instance.
Gname string: Group Name which owns the virtual router instance.
Graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
Group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
HardShutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
Lcmstate double: LCM State of the virtual router instance.
Lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
Memory double: Amount of RAM assigned to the VM in MB.
Name string: The name of the virtual router instance.
OnDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
Os VirtualRouterInstanceOs: See OS parameters below for details.
Pending bool: Pending state during VM creation. Defaults to false.
Permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
Raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
SchedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
SchedRequirements string: Scheduling requirements to deploy the resource following specific rule.
State double: State of the virtual router instance.
Tags Dictionary<string, string>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
TagsAll Dictionary<string, string>: Result of the applied default_tags and then resource tags.
TemplateDisks List<VirtualRouterInstanceTemplateDisk>: this contains the template disks description.
TemplateSectionNames Dictionary<string, string>: When template_id was set this keeps the template section names only.
TemplateSections List<VirtualRouterInstanceTemplateSection>: Add custom section to the resource
TemplateTags Dictionary<string, string>: When template_id was set this keeps the template tags.
Timeout double: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
Timeouts VirtualRouterInstanceTimeouts
Uid double: User ID whom owns the virtual router instance.
Uname string: User Name whom owns the virtual router instance.
Vcpu double: Number of virtual CPUs assigned to the virtual machine
VirtualRouterId double: The ID of the parent virtual router resource.
VirtualRouterInstanceId string: ID of the virtual router instance.
Vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

Context map[string]string: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
Cpu float64: Amount of CPU shares assigned to the VM.
Cpumodel VirtualRouterInstanceCpumodelArgs: Definition of CPU Model type for the Virtual Machine
DefaultTags map[string]string: Default tags defined in the provider configuration.
Description string: The description of the template.
Disks []VirtualRouterInstanceDiskArgs: Can be specified multiple times to attach several disks. See Disk parameters below for details.
Gid float64: Group ID which owns the virtual router instance.
Gname string: Group Name which owns the virtual router instance.
Graphics VirtualRouterInstanceGraphicsArgs: See Graphics parameters below for details.
Group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
HardShutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
Lcmstate float64: LCM State of the virtual router instance.
Lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
Memory float64: Amount of RAM assigned to the VM in MB.
Name string: The name of the virtual router instance.
OnDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
Os VirtualRouterInstanceOsArgs: See OS parameters below for details.
Pending bool: Pending state during VM creation. Defaults to false.
Permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
Raw VirtualRouterInstanceRawArgs: Low-level hypervisor tuning
SchedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
SchedRequirements string: Scheduling requirements to deploy the resource following specific rule.
State float64: State of the virtual router instance.
Tags map[string]string: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
TagsAll map[string]string: Result of the applied default_tags and then resource tags.
TemplateDisks []VirtualRouterInstanceTemplateDiskArgs: this contains the template disks description.
TemplateSectionNames map[string]string: When template_id was set this keeps the template section names only.
TemplateSections []VirtualRouterInstanceTemplateSectionArgs: Add custom section to the resource
TemplateTags map[string]string: When template_id was set this keeps the template tags.
Timeout float64: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
Timeouts VirtualRouterInstanceTimeoutsArgs
Uid float64: User ID whom owns the virtual router instance.
Uname string: User Name whom owns the virtual router instance.
Vcpu float64: Number of virtual CPUs assigned to the virtual machine
VirtualRouterId float64: The ID of the parent virtual router resource.
VirtualRouterInstanceId string: ID of the virtual router instance.
Vmgroup VirtualRouterInstanceVmgroupArgs: See VM group parameters below for details. Changing this argument triggers a new resource.

context Map<String,String>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu Double: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
defaultTags Map<String,String>: Default tags defined in the provider configuration.
description String: The description of the template.
disks List<VirtualRouterInstanceDisk>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
gid Double: Group ID which owns the virtual router instance.
gname String: Group Name which owns the virtual router instance.
graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
group String: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown Boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lcmstate Double: LCM State of the virtual router instance.
lock String: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory Double: Amount of RAM assigned to the VM in MB.
name String: The name of the virtual router instance.
onDiskChange String: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOs: See OS parameters below for details.
pending Boolean: Pending state during VM creation. Defaults to false.
permissions String: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
schedDsRequirements String: Storage placement requirements to deploy the resource following specific rule.
schedRequirements String: Scheduling requirements to deploy the resource following specific rule.
state Double: State of the virtual router instance.
tags Map<String,String>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
tagsAll Map<String,String>: Result of the applied default_tags and then resource tags.
templateDisks List<VirtualRouterInstanceTemplateDisk>: this contains the template disks description.
templateSectionNames Map<String,String>: When template_id was set this keeps the template section names only.
templateSections List<VirtualRouterInstanceTemplateSection>: Add custom section to the resource
templateTags Map<String,String>: When template_id was set this keeps the template tags.
timeout Double: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeouts
uid Double: User ID whom owns the virtual router instance.
uname String: User Name whom owns the virtual router instance.
vcpu Double: Number of virtual CPUs assigned to the virtual machine
virtualRouterId Double: The ID of the parent virtual router resource.
virtualRouterInstanceId String: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

context {[key: string]: string}: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu number: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodel: Definition of CPU Model type for the Virtual Machine
defaultTags {[key: string]: string}: Default tags defined in the provider configuration.
description string: The description of the template.
disks VirtualRouterInstanceDisk[]: Can be specified multiple times to attach several disks. See Disk parameters below for details.
gid number: Group ID which owns the virtual router instance.
gname string: Group Name which owns the virtual router instance.
graphics VirtualRouterInstanceGraphics: See Graphics parameters below for details.
group string: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lcmstate number: LCM State of the virtual router instance.
lock string: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory number: Amount of RAM assigned to the VM in MB.
name string: The name of the virtual router instance.
onDiskChange string: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOs: See OS parameters below for details.
pending boolean: Pending state during VM creation. Defaults to false.
permissions string: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRaw: Low-level hypervisor tuning
schedDsRequirements string: Storage placement requirements to deploy the resource following specific rule.
schedRequirements string: Scheduling requirements to deploy the resource following specific rule.
state number: State of the virtual router instance.
tags {[key: string]: string}: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
tagsAll {[key: string]: string}: Result of the applied default_tags and then resource tags.
templateDisks VirtualRouterInstanceTemplateDisk[]: this contains the template disks description.
templateSectionNames {[key: string]: string}: When template_id was set this keeps the template section names only.
templateSections VirtualRouterInstanceTemplateSection[]: Add custom section to the resource
templateTags {[key: string]: string}: When template_id was set this keeps the template tags.
timeout number: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeouts
uid number: User ID whom owns the virtual router instance.
uname string: User Name whom owns the virtual router instance.
vcpu number: Number of virtual CPUs assigned to the virtual machine
virtualRouterId number: The ID of the parent virtual router resource.
virtualRouterInstanceId string: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroup: See VM group parameters below for details. Changing this argument triggers a new resource.

context Mapping[str, str]: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu float: Amount of CPU shares assigned to the VM.
cpumodel VirtualRouterInstanceCpumodelArgs: Definition of CPU Model type for the Virtual Machine
default_tags Mapping[str, str]: Default tags defined in the provider configuration.
description str: The description of the template.
disks Sequence[VirtualRouterInstanceDiskArgs]: Can be specified multiple times to attach several disks. See Disk parameters below for details.
gid float: Group ID which owns the virtual router instance.
gname str: Group Name which owns the virtual router instance.
graphics VirtualRouterInstanceGraphicsArgs: See Graphics parameters below for details.
group str: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hard_shutdown bool: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lcmstate float: LCM State of the virtual router instance.
lock str: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory float: Amount of RAM assigned to the VM in MB.
name str: The name of the virtual router instance.
on_disk_change str: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os VirtualRouterInstanceOsArgs: See OS parameters below for details.
pending bool: Pending state during VM creation. Defaults to false.
permissions str: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw VirtualRouterInstanceRawArgs: Low-level hypervisor tuning
sched_ds_requirements str: Storage placement requirements to deploy the resource following specific rule.
sched_requirements str: Scheduling requirements to deploy the resource following specific rule.
state float: State of the virtual router instance.
tags Mapping[str, str]: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
tags_all Mapping[str, str]: Result of the applied default_tags and then resource tags.
template_disks Sequence[VirtualRouterInstanceTemplateDiskArgs]: this contains the template disks description.
template_section_names Mapping[str, str]: When template_id was set this keeps the template section names only.
template_sections Sequence[VirtualRouterInstanceTemplateSectionArgs]: Add custom section to the resource
template_tags Mapping[str, str]: When template_id was set this keeps the template tags.
timeout float: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts VirtualRouterInstanceTimeoutsArgs
uid float: User ID whom owns the virtual router instance.
uname str: User Name whom owns the virtual router instance.
vcpu float: Number of virtual CPUs assigned to the virtual machine
virtual_router_id float: The ID of the parent virtual router resource.
virtual_router_instance_id str: ID of the virtual router instance.
vmgroup VirtualRouterInstanceVmgroupArgs: See VM group parameters below for details. Changing this argument triggers a new resource.

context Map<String>: Array of free form key=value pairs, rendered and added to the CONTEXT variables for the VM. Recommended to include: NETWORK = "YES" and SET_HOSTNAME = "$NAME".
cpu Number: Amount of CPU shares assigned to the VM.
cpumodel Property Map: Definition of CPU Model type for the Virtual Machine
defaultTags Map<String>: Default tags defined in the provider configuration.
description String: The description of the template.
disks List<Property Map>: Can be specified multiple times to attach several disks. See Disk parameters below for details.
gid Number: Group ID which owns the virtual router instance.
gname String: Group Name which owns the virtual router instance.
graphics Property Map: See Graphics parameters below for details.
group String: Name of the group which owns the virtual router instance. Defaults to the caller primary group.
hardShutdown Boolean: Immediately poweroff/terminate/reboot/undeploy the VM. (default: false)
lcmstate Number: LCM State of the virtual router instance.
lock String: Lock the VM with a specific lock level. Supported values: USE, MANAGE, ADMIN, ALL or UNLOCK.
memory Number: Amount of RAM assigned to the VM in MB.
name String: The name of the virtual router instance.
onDiskChange String: Select the behavior for changing disk images. Supported values: RECREATE or SWAP (default). RECREATE forces recreation of the vm and SWAP adopts the standard behavior of hot-swapping the disks. NOTE: This property does not affect the behavior of adding new disks.
os Property Map: See OS parameters below for details.
pending Boolean: Pending state during VM creation. Defaults to false.
permissions String: Permissions applied on virtual router instance. Defaults to the UMASK in OpenNebula (in UNIX Format: owner-group-other => Use-Manage-Admin).
raw Property Map: Low-level hypervisor tuning
schedDsRequirements String: Storage placement requirements to deploy the resource following specific rule.
schedRequirements String: Scheduling requirements to deploy the resource following specific rule.
state Number: State of the virtual router instance.
tags Map<String>: Map of tags (key=value) assigned to the resource. Override matching tags present in the default_tags atribute when configured in the provider block. See tags usage related documentation for more information.
tagsAll Map<String>: Result of the applied default_tags and then resource tags.
templateDisks List<Property Map>: this contains the template disks description.
templateSectionNames Map<String>: When template_id was set this keeps the template section names only.
templateSections List<Property Map>: Add custom section to the resource
templateTags Map<String>: When template_id was set this keeps the template tags.
timeout Number: Timeout (in minutes) within resource should be available. Default: 3 minutes
Deprecated: Deprecated
timeouts Property Map
uid Number: User ID whom owns the virtual router instance.
uname String: User Name whom owns the virtual router instance.
vcpu Number: Number of virtual CPUs assigned to the virtual machine
virtualRouterId Number: The ID of the parent virtual router resource.
virtualRouterInstanceId String: ID of the virtual router instance.
vmgroup Property Map: See VM group parameters below for details. Changing this argument triggers a new resource.

Supporting Types

VirtualRouterInstanceCpumodel, VirtualRouterInstanceCpumodelArgs

Model string

Model string

model String

model string

model str

model String

VirtualRouterInstanceDisk, VirtualRouterInstanceDiskArgs

Cache string

ComputedCache string

ComputedDevPrefix string

ComputedDiscard string

ComputedDriver string

OpenNebula image driver.

ComputedIo string

ComputedSize double

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

ComputedTarget string

Target name device on the virtual router instance. Depends of the image dev_prefix.

ComputedVolatileFormat string

Format of the Image: raw or qcow2.

DevPrefix string

Discard string

DiskId double

disk attachment identifier

Driver string

OpenNebula image driver.

ImageId double

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

Io string

Size double

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

Target string

Target name device on the virtual router instance. Depends of the image dev_prefix.

VolatileFormat string

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

VolatileType string

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

Cache string

ComputedCache string

ComputedDevPrefix string

ComputedDiscard string

ComputedDriver string

OpenNebula image driver.

ComputedIo string

ComputedSize float64

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

ComputedTarget string

Target name device on the virtual router instance. Depends of the image dev_prefix.

ComputedVolatileFormat string

Format of the Image: raw or qcow2.

DevPrefix string

Discard string

DiskId float64

disk attachment identifier

Driver string

OpenNebula image driver.

ImageId float64

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

Io string

Size float64

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

Target string

Target name device on the virtual router instance. Depends of the image dev_prefix.

VolatileFormat string

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

VolatileType string

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache String

computedCache String

computedDevPrefix String

computedDiscard String

computedDriver String

OpenNebula image driver.

computedIo String

computedSize Double

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

computedTarget String

Target name device on the virtual router instance. Depends of the image dev_prefix.

computedVolatileFormat String

Format of the Image: raw or qcow2.

devPrefix String

discard String

diskId Double

disk attachment identifier

driver String

OpenNebula image driver.

imageId Double

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

io String

size Double

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

target String

Target name device on the virtual router instance. Depends of the image dev_prefix.

volatileFormat String

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

volatileType String

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache string

computedCache string

computedDevPrefix string

computedDiscard string

computedDriver string

OpenNebula image driver.

computedIo string

computedSize number

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

computedTarget string

Target name device on the virtual router instance. Depends of the image dev_prefix.

computedVolatileFormat string

Format of the Image: raw or qcow2.

devPrefix string

discard string

diskId number

disk attachment identifier

driver string

OpenNebula image driver.

imageId number

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

io string

size number

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

target string

Target name device on the virtual router instance. Depends of the image dev_prefix.

volatileFormat string

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

volatileType string

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache str

computed_cache str

computed_dev_prefix str

computed_discard str

computed_driver str

OpenNebula image driver.

computed_io str

computed_size float

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

computed_target str

Target name device on the virtual router instance. Depends of the image dev_prefix.

computed_volatile_format str

Format of the Image: raw or qcow2.

dev_prefix str

discard str

disk_id float

disk attachment identifier

driver str

OpenNebula image driver.

image_id float

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

io str

size float

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

target str

Target name device on the virtual router instance. Depends of the image dev_prefix.

volatile_format str

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

volatile_type str

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache String

computedCache String

computedDevPrefix String

computedDiscard String

computedDriver String

OpenNebula image driver.

computedIo String

computedSize Number

Size (in MB) of the image attached to the virtual router instance. Not possible to change a cloned image size.

computedTarget String

Target name device on the virtual router instance. Depends of the image dev_prefix.

computedVolatileFormat String

Format of the Image: raw or qcow2.

devPrefix String

discard String

diskId Number

disk attachment identifier

driver String

OpenNebula image driver.

imageId Number

ID of the image to attach to the virtual router instance. Defaults to -1 if not set: this skip Image attchment to the VM. Conflicts with volatile_type and volatile_format.

io String

size Number

Size (in MB) of the image. If set, it will resize the image disk to the targeted size. The size must be greater than the current one.

target String

Target name device on the virtual router instance. Depends of the image dev_prefix.

volatileFormat String

Format of the Image: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

A disk update will be triggered in adding or removing a disk section, or by a modification of any of these parameters: image_id, target, driver

volatileType String

Type of the disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

VirtualRouterInstanceGraphics, VirtualRouterInstanceGraphicsArgs

Listen string: Binding address.
Type string: Generally set to VNC.
Keymap string: Keyboard mapping.
Passwd string
Port string: Binding Port.
RandomPasswd bool

Listen string: Binding address.
Type string: Generally set to VNC.
Keymap string: Keyboard mapping.
Passwd string
Port string: Binding Port.
RandomPasswd bool

listen String: Binding address.
type String: Generally set to VNC.
keymap String: Keyboard mapping.
passwd String
port String: Binding Port.
randomPasswd Boolean

listen string: Binding address.
type string: Generally set to VNC.
keymap string: Keyboard mapping.
passwd string
port string: Binding Port.
randomPasswd boolean

listen str: Binding address.
type str: Generally set to VNC.
keymap str: Keyboard mapping.
passwd str
port str: Binding Port.
random_passwd bool

listen String: Binding address.
type String: Generally set to VNC.
keymap String: Keyboard mapping.
passwd String
port String: Binding Port.
randomPasswd Boolean

VirtualRouterInstanceOs, VirtualRouterInstanceOsArgs

Arch string: Hardware architecture of the virtual router instance. Must fit the host architecture.
Boot string: OS disk to use to boot on.

Arch string: Hardware architecture of the virtual router instance. Must fit the host architecture.
Boot string: OS disk to use to boot on.

arch String: Hardware architecture of the virtual router instance. Must fit the host architecture.
boot String: OS disk to use to boot on.

arch string: Hardware architecture of the virtual router instance. Must fit the host architecture.
boot string: OS disk to use to boot on.

arch str: Hardware architecture of the virtual router instance. Must fit the host architecture.
boot str: OS disk to use to boot on.

arch String: Hardware architecture of the virtual router instance. Must fit the host architecture.
boot String: OS disk to use to boot on.

VirtualRouterInstanceRaw, VirtualRouterInstanceRawArgs

Data string: Low-level data to pass to the hypervisor
Type string: Name of the hypervisor: kvm, lxd, vmware

Data string: Low-level data to pass to the hypervisor
Type string: Name of the hypervisor: kvm, lxd, vmware

data String: Low-level data to pass to the hypervisor
type String: Name of the hypervisor: kvm, lxd, vmware

data string: Low-level data to pass to the hypervisor
type string: Name of the hypervisor: kvm, lxd, vmware

data str: Low-level data to pass to the hypervisor
type str: Name of the hypervisor: kvm, lxd, vmware

data String: Low-level data to pass to the hypervisor
type String: Name of the hypervisor: kvm, lxd, vmware

VirtualRouterInstanceTemplateDisk, VirtualRouterInstanceTemplateDiskArgs

Cache string

DevPrefix string

Discard string

Driver string

OpenNebula image driver.

ImageId double

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

Io string

Size double

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

Target string

Target name device on the virtual machine. Depends of the image dev_prefix.

VolatileFormat string

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

VolatileType string

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

Cache string

DevPrefix string

Discard string

Driver string

OpenNebula image driver.

ImageId float64

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

Io string

Size float64

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

Target string

Target name device on the virtual machine. Depends of the image dev_prefix.

VolatileFormat string

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

VolatileType string

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache String

devPrefix String

discard String

driver String

OpenNebula image driver.

imageId Double

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

io String

size Double

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

target String

Target name device on the virtual machine. Depends of the image dev_prefix.

volatileFormat String

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

volatileType String

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache string

devPrefix string

discard string

driver string

OpenNebula image driver.

imageId number

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

io string

size number

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

target string

Target name device on the virtual machine. Depends of the image dev_prefix.

volatileFormat string

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

volatileType string

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache str

dev_prefix str

discard str

driver str

OpenNebula image driver.

image_id float

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

io str

size float

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

target str

Target name device on the virtual machine. Depends of the image dev_prefix.

volatile_format str

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

volatile_type str

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

cache String

devPrefix String

discard String

driver String

OpenNebula image driver.

imageId Number

ID of the image to attach to the virtual machine. Conflicts with volatile_type and volatile_format.

io String

size Number

Size (in MB) of the image attached to the virtual machine. Not possible to change a cloned image size.

target String

Target name device on the virtual machine. Depends of the image dev_prefix.

volatileFormat String

Format of the volatile disk: raw or qcow2. Conflicts with image_id.

Minimum 1 item. Maximum 8 items.

volatileType String

Type of the volatile disk: swap or fs. Type swap is not supported in vcenter. Conflicts with image_id.

VirtualRouterInstanceTemplateSection, VirtualRouterInstanceTemplateSectionArgs

Name string: The vector name.
Elements Dictionary<string, string>: Collection of custom tags.

Name string: The vector name.
Elements map[string]string: Collection of custom tags.

name String: The vector name.
elements Map<String,String>: Collection of custom tags.

name string: The vector name.
elements {[key: string]: string}: Collection of custom tags.

name str: The vector name.
elements Mapping[str, str]: Collection of custom tags.

name String: The vector name.
elements Map<String>: Collection of custom tags.

VirtualRouterInstanceTimeouts, VirtualRouterInstanceTimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

VirtualRouterInstanceVmgroup, VirtualRouterInstanceVmgroupArgs

Role string: role of the VM group to use.
VmgroupId double: ID of the VM group to use.

Role string: role of the VM group to use.
VmgroupId float64: ID of the VM group to use.

role String: role of the VM group to use.
vmgroupId Double: ID of the VM group to use.

role string: role of the VM group to use.
vmgroupId number: ID of the VM group to use.

role str: role of the VM group to use.
vmgroup_id float: ID of the VM group to use.

role String: role of the VM group to use.
vmgroupId Number: ID of the VM group to use.

Import

opennebula_virtual_router_instance can be imported using its ID:

$ pulumi import opennebula:index/virtualRouterInstance:VirtualRouterInstance example 123

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

Package Details

Repository: opennebula opennebula/terraform-provider-opennebula
License
Notes: This Pulumi package is based on the opennebula Terraform Provider.

opennebula 1.4.1 published on Monday, Apr 14, 2025 by opennebula

opennebula/terraform-provider-opennebula

opennebula.VirtualRouterInstance

On this page

On this page

Example Usage

Instantiate from a template

Create VirtualRouterInstance Resource

Constructor syntax

Parameters

Constructor example

VirtualRouterInstance Resource Properties

Inputs

Outputs

Look up Existing VirtualRouterInstance Resource

Supporting Types

VirtualRouterInstanceCpumodel, VirtualRouterInstanceCpumodelArgs

VirtualRouterInstanceDisk, VirtualRouterInstanceDiskArgs

VirtualRouterInstanceGraphics, VirtualRouterInstanceGraphicsArgs

VirtualRouterInstanceOs, VirtualRouterInstanceOsArgs

VirtualRouterInstanceRaw, VirtualRouterInstanceRawArgs

VirtualRouterInstanceTemplateDisk, VirtualRouterInstanceTemplateDiskArgs

VirtualRouterInstanceTemplateSection, VirtualRouterInstanceTemplateSectionArgs

VirtualRouterInstanceTimeouts, VirtualRouterInstanceTimeoutsArgs

VirtualRouterInstanceVmgroup, VirtualRouterInstanceVmgroupArgs

Import

Package Details

On this page

On this page