Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. VappContainer
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.VappContainer

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

The vsphere.VappContainer resource can be used to create and manage vApps.

For more information on vSphere vApps, see the VMware vSphere product documentation.

Basic Example

The example below sets up a vSphere vApp container in a compute cluster which uses the default settings for CPU and memory reservations, shares, and limits. The compute cluster needs to already exist in vSphere.

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

const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const computeCluster = datacenter.then(datacenter => vsphere.getComputeCluster({
    name: "cluster-01",
    datacenterId: datacenter.id,
}));
const vappContainer = new vsphere.VappContainer("vapp_container", {
    name: "vapp-01",
    parentResourcePoolId: computeCluster.then(computeCluster => computeCluster.resourcePoolId),
});
Copy
import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc-01")
compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
    datacenter_id=datacenter.id)
vapp_container = vsphere.VappContainer("vapp_container",
    name="vapp-01",
    parent_resource_pool_id=compute_cluster.resource_pool_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		datacenter, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
			Name: pulumi.StringRef("dc-01"),
		}, nil)
		if err != nil {
			return err
		}
		computeCluster, err := vsphere.LookupComputeCluster(ctx, &vsphere.LookupComputeClusterArgs{
			Name:         "cluster-01",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vsphere.NewVappContainer(ctx, "vapp_container", &vsphere.VappContainerArgs{
			Name:                 pulumi.String("vapp-01"),
			ParentResourcePoolId: pulumi.String(computeCluster.ResourcePoolId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var datacenter = VSphere.GetDatacenter.Invoke(new()
    {
        Name = "dc-01",
    });

    var computeCluster = VSphere.GetComputeCluster.Invoke(new()
    {
        Name = "cluster-01",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var vappContainer = new VSphere.VappContainer("vapp_container", new()
    {
        Name = "vapp-01",
        ParentResourcePoolId = computeCluster.Apply(getComputeClusterResult => getComputeClusterResult.ResourcePoolId),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetDatacenterArgs;
import com.pulumi.vsphere.inputs.GetComputeClusterArgs;
import com.pulumi.vsphere.VappContainer;
import com.pulumi.vsphere.VappContainerArgs;
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) {
        final var datacenter = VsphereFunctions.getDatacenter(GetDatacenterArgs.builder()
            .name("dc-01")
            .build());

        final var computeCluster = VsphereFunctions.getComputeCluster(GetComputeClusterArgs.builder()
            .name("cluster-01")
            .datacenterId(datacenter.id())
            .build());

        var vappContainer = new VappContainer("vappContainer", VappContainerArgs.builder()
            .name("vapp-01")
            .parentResourcePoolId(computeCluster.resourcePoolId())
            .build());

    }
}
Copy
resources:
  vappContainer:
    type: vsphere:VappContainer
    name: vapp_container
    properties:
      name: vapp-01
      parentResourcePoolId: ${computeCluster.resourcePoolId}
variables:
  datacenter:
    fn::invoke:
      function: vsphere:getDatacenter
      arguments:
        name: dc-01
  computeCluster:
    fn::invoke:
      function: vsphere:getComputeCluster
      arguments:
        name: cluster-01
        datacenterId: ${datacenter.id}
Copy

Example with a Virtual Machine

The example below builds off the basic example, but includes a virtual machine in the new vApp container. To accomplish this, the resource_pool_id of the virtual machine is set to the id of the vApp container.

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

const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const computeCluster = datacenter.then(datacenter => vsphere.getComputeCluster({
    name: "cluster-01",
    datacenterId: datacenter.id,
}));
const datastore = datacenter.then(datacenter => vsphere.getDatastore({
    name: "datastore-01",
    datacenterId: datacenter.id,
}));
const network = datacenter.then(datacenter => vsphere.getNetwork({
    name: "VM Network",
    datacenterId: datacenter.id,
}));
const vappContainer = new vsphere.VappContainer("vapp_container", {
    name: "vapp-01",
    parentResourcePoolId: computeCluster.then(computeCluster => computeCluster.resourcePoolId),
});
const vm = new vsphere.VirtualMachine("vm", {
    name: "foo",
    resourcePoolId: vappContainerVsphereVappContainer.id,
    datastoreId: datastore.then(datastore => datastore.id),
    numCpus: 1,
    memory: 1024,
    guestId: "ubuntu64Guest",
    networkInterfaces: [{
        networkId: network.then(network => network.id),
    }],
    disks: [{
        label: "disk0",
        size: 20,
    }],
});
Copy
import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc-01")
compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
    datacenter_id=datacenter.id)
datastore = vsphere.get_datastore(name="datastore-01",
    datacenter_id=datacenter.id)
network = vsphere.get_network(name="VM Network",
    datacenter_id=datacenter.id)
vapp_container = vsphere.VappContainer("vapp_container",
    name="vapp-01",
    parent_resource_pool_id=compute_cluster.resource_pool_id)
vm = vsphere.VirtualMachine("vm",
    name="foo",
    resource_pool_id=vapp_container_vsphere_vapp_container["id"],
    datastore_id=datastore.id,
    num_cpus=1,
    memory=1024,
    guest_id="ubuntu64Guest",
    network_interfaces=[{
        "network_id": network.id,
    }],
    disks=[{
        "label": "disk0",
        "size": 20,
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		datacenter, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
			Name: pulumi.StringRef("dc-01"),
		}, nil)
		if err != nil {
			return err
		}
		computeCluster, err := vsphere.LookupComputeCluster(ctx, &vsphere.LookupComputeClusterArgs{
			Name:         "cluster-01",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		datastore, err := vsphere.GetDatastore(ctx, &vsphere.GetDatastoreArgs{
			Name:         "datastore-01",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		network, err := vsphere.GetNetwork(ctx, &vsphere.GetNetworkArgs{
			Name:         "VM Network",
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vsphere.NewVappContainer(ctx, "vapp_container", &vsphere.VappContainerArgs{
			Name:                 pulumi.String("vapp-01"),
			ParentResourcePoolId: pulumi.String(computeCluster.ResourcePoolId),
		})
		if err != nil {
			return err
		}
		_, err = vsphere.NewVirtualMachine(ctx, "vm", &vsphere.VirtualMachineArgs{
			Name:           pulumi.String("foo"),
			ResourcePoolId: pulumi.Any(vappContainerVsphereVappContainer.Id),
			DatastoreId:    pulumi.String(datastore.Id),
			NumCpus:        pulumi.Int(1),
			Memory:         pulumi.Int(1024),
			GuestId:        pulumi.String("ubuntu64Guest"),
			NetworkInterfaces: vsphere.VirtualMachineNetworkInterfaceArray{
				&vsphere.VirtualMachineNetworkInterfaceArgs{
					NetworkId: pulumi.String(network.Id),
				},
			},
			Disks: vsphere.VirtualMachineDiskArray{
				&vsphere.VirtualMachineDiskArgs{
					Label: pulumi.String("disk0"),
					Size:  pulumi.Int(20),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var datacenter = VSphere.GetDatacenter.Invoke(new()
    {
        Name = "dc-01",
    });

    var computeCluster = VSphere.GetComputeCluster.Invoke(new()
    {
        Name = "cluster-01",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var datastore = VSphere.GetDatastore.Invoke(new()
    {
        Name = "datastore-01",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var network = VSphere.GetNetwork.Invoke(new()
    {
        Name = "VM Network",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var vappContainer = new VSphere.VappContainer("vapp_container", new()
    {
        Name = "vapp-01",
        ParentResourcePoolId = computeCluster.Apply(getComputeClusterResult => getComputeClusterResult.ResourcePoolId),
    });

    var vm = new VSphere.VirtualMachine("vm", new()
    {
        Name = "foo",
        ResourcePoolId = vappContainerVsphereVappContainer.Id,
        DatastoreId = datastore.Apply(getDatastoreResult => getDatastoreResult.Id),
        NumCpus = 1,
        Memory = 1024,
        GuestId = "ubuntu64Guest",
        NetworkInterfaces = new[]
        {
            new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
            {
                NetworkId = network.Apply(getNetworkResult => getNetworkResult.Id),
            },
        },
        Disks = new[]
        {
            new VSphere.Inputs.VirtualMachineDiskArgs
            {
                Label = "disk0",
                Size = 20,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetDatacenterArgs;
import com.pulumi.vsphere.inputs.GetComputeClusterArgs;
import com.pulumi.vsphere.inputs.GetDatastoreArgs;
import com.pulumi.vsphere.inputs.GetNetworkArgs;
import com.pulumi.vsphere.VappContainer;
import com.pulumi.vsphere.VappContainerArgs;
import com.pulumi.vsphere.VirtualMachine;
import com.pulumi.vsphere.VirtualMachineArgs;
import com.pulumi.vsphere.inputs.VirtualMachineNetworkInterfaceArgs;
import com.pulumi.vsphere.inputs.VirtualMachineDiskArgs;
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) {
        final var datacenter = VsphereFunctions.getDatacenter(GetDatacenterArgs.builder()
            .name("dc-01")
            .build());

        final var computeCluster = VsphereFunctions.getComputeCluster(GetComputeClusterArgs.builder()
            .name("cluster-01")
            .datacenterId(datacenter.id())
            .build());

        final var datastore = VsphereFunctions.getDatastore(GetDatastoreArgs.builder()
            .name("datastore-01")
            .datacenterId(datacenter.id())
            .build());

        final var network = VsphereFunctions.getNetwork(GetNetworkArgs.builder()
            .name("VM Network")
            .datacenterId(datacenter.id())
            .build());

        var vappContainer = new VappContainer("vappContainer", VappContainerArgs.builder()
            .name("vapp-01")
            .parentResourcePoolId(computeCluster.resourcePoolId())
            .build());

        var vm = new VirtualMachine("vm", VirtualMachineArgs.builder()
            .name("foo")
            .resourcePoolId(vappContainerVsphereVappContainer.id())
            .datastoreId(datastore.id())
            .numCpus(1)
            .memory(1024)
            .guestId("ubuntu64Guest")
            .networkInterfaces(VirtualMachineNetworkInterfaceArgs.builder()
                .networkId(network.id())
                .build())
            .disks(VirtualMachineDiskArgs.builder()
                .label("disk0")
                .size(20)
                .build())
            .build());

    }
}
Copy
resources:
  vappContainer:
    type: vsphere:VappContainer
    name: vapp_container
    properties:
      name: vapp-01
      parentResourcePoolId: ${computeCluster.resourcePoolId}
  vm:
    type: vsphere:VirtualMachine
    properties:
      name: foo
      resourcePoolId: ${vappContainerVsphereVappContainer.id}
      datastoreId: ${datastore.id}
      numCpus: 1
      memory: 1024
      guestId: ubuntu64Guest
      networkInterfaces:
        - networkId: ${network.id}
      disks:
        - label: disk0
          size: 20
variables:
  datacenter:
    fn::invoke:
      function: vsphere:getDatacenter
      arguments:
        name: dc-01
  computeCluster:
    fn::invoke:
      function: vsphere:getComputeCluster
      arguments:
        name: cluster-01
        datacenterId: ${datacenter.id}
  datastore:
    fn::invoke:
      function: vsphere:getDatastore
      arguments:
        name: datastore-01
        datacenterId: ${datacenter.id}
  network:
    fn::invoke:
      function: vsphere:getNetwork
      arguments:
        name: VM Network
        datacenterId: ${datacenter.id}
Copy

Create VappContainer Resource

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

Constructor syntax

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

@overload
def VappContainer(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  parent_resource_pool_id: Optional[str] = None,
                  memory_expandable: Optional[bool] = None,
                  memory_reservation: Optional[int] = None,
                  cpu_share_level: Optional[str] = None,
                  cpu_shares: Optional[int] = None,
                  custom_attributes: Optional[Mapping[str, str]] = None,
                  cpu_expandable: Optional[bool] = None,
                  memory_limit: Optional[int] = None,
                  cpu_reservation: Optional[int] = None,
                  memory_share_level: Optional[str] = None,
                  memory_shares: Optional[int] = None,
                  name: Optional[str] = None,
                  parent_folder_id: Optional[str] = None,
                  cpu_limit: Optional[int] = None,
                  tags: Optional[Sequence[str]] = None)
func NewVappContainer(ctx *Context, name string, args VappContainerArgs, opts ...ResourceOption) (*VappContainer, error)
public VappContainer(string name, VappContainerArgs args, CustomResourceOptions? opts = null)
public VappContainer(String name, VappContainerArgs args)
public VappContainer(String name, VappContainerArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VappContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VappContainerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VappContainerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VappContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VappContainerArgs
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 vappContainerResource = new VSphere.VappContainer("vappContainerResource", new()
{
    ParentResourcePoolId = "string",
    MemoryExpandable = false,
    MemoryReservation = 0,
    CpuShareLevel = "string",
    CpuShares = 0,
    CustomAttributes = 
    {
        { "string", "string" },
    },
    CpuExpandable = false,
    MemoryLimit = 0,
    CpuReservation = 0,
    MemoryShareLevel = "string",
    MemoryShares = 0,
    Name = "string",
    ParentFolderId = "string",
    CpuLimit = 0,
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := vsphere.NewVappContainer(ctx, "vappContainerResource", &vsphere.VappContainerArgs{
	ParentResourcePoolId: pulumi.String("string"),
	MemoryExpandable:     pulumi.Bool(false),
	MemoryReservation:    pulumi.Int(0),
	CpuShareLevel:        pulumi.String("string"),
	CpuShares:            pulumi.Int(0),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CpuExpandable:    pulumi.Bool(false),
	MemoryLimit:      pulumi.Int(0),
	CpuReservation:   pulumi.Int(0),
	MemoryShareLevel: pulumi.String("string"),
	MemoryShares:     pulumi.Int(0),
	Name:             pulumi.String("string"),
	ParentFolderId:   pulumi.String("string"),
	CpuLimit:         pulumi.Int(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var vappContainerResource = new VappContainer("vappContainerResource", VappContainerArgs.builder()
    .parentResourcePoolId("string")
    .memoryExpandable(false)
    .memoryReservation(0)
    .cpuShareLevel("string")
    .cpuShares(0)
    .customAttributes(Map.of("string", "string"))
    .cpuExpandable(false)
    .memoryLimit(0)
    .cpuReservation(0)
    .memoryShareLevel("string")
    .memoryShares(0)
    .name("string")
    .parentFolderId("string")
    .cpuLimit(0)
    .tags("string")
    .build());
Copy
vapp_container_resource = vsphere.VappContainer("vappContainerResource",
    parent_resource_pool_id="string",
    memory_expandable=False,
    memory_reservation=0,
    cpu_share_level="string",
    cpu_shares=0,
    custom_attributes={
        "string": "string",
    },
    cpu_expandable=False,
    memory_limit=0,
    cpu_reservation=0,
    memory_share_level="string",
    memory_shares=0,
    name="string",
    parent_folder_id="string",
    cpu_limit=0,
    tags=["string"])
Copy
const vappContainerResource = new vsphere.VappContainer("vappContainerResource", {
    parentResourcePoolId: "string",
    memoryExpandable: false,
    memoryReservation: 0,
    cpuShareLevel: "string",
    cpuShares: 0,
    customAttributes: {
        string: "string",
    },
    cpuExpandable: false,
    memoryLimit: 0,
    cpuReservation: 0,
    memoryShareLevel: "string",
    memoryShares: 0,
    name: "string",
    parentFolderId: "string",
    cpuLimit: 0,
    tags: ["string"],
});
Copy
type: vsphere:VappContainer
properties:
    cpuExpandable: false
    cpuLimit: 0
    cpuReservation: 0
    cpuShareLevel: string
    cpuShares: 0
    customAttributes:
        string: string
    memoryExpandable: false
    memoryLimit: 0
    memoryReservation: 0
    memoryShareLevel: string
    memoryShares: 0
    name: string
    parentFolderId: string
    parentResourcePoolId: string
    tags:
        - string
Copy

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

ParentResourcePoolId This property is required. string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
CpuExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
CpuLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
CpuReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
CpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
CpuShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
CustomAttributes Dictionary<string, string>
A list of custom attributes to set on this resource.
MemoryExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
MemoryLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
MemoryReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
MemoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
MemoryShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
Name string
The name of the vApp container.
ParentFolderId string
The managed object ID of the vApp container's parent folder.
Tags List<string>
The IDs of any tags to attach to this resource.
ParentResourcePoolId This property is required. string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
CpuExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
CpuLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
CpuReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
CpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
CpuShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
CustomAttributes map[string]string
A list of custom attributes to set on this resource.
MemoryExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
MemoryLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
MemoryReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
MemoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
MemoryShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
Name string
The name of the vApp container.
ParentFolderId string
The managed object ID of the vApp container's parent folder.
Tags []string
The IDs of any tags to attach to this resource.
parentResourcePoolId This property is required. String
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
cpuExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit Integer
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation Integer
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares Integer
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes Map<String,String>
A list of custom attributes to set on this resource.
memoryExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit Integer
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation Integer
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares Integer
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name String
The name of the vApp container.
parentFolderId String
The managed object ID of the vApp container's parent folder.
tags List<String>
The IDs of any tags to attach to this resource.
parentResourcePoolId This property is required. string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
cpuExpandable boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes {[key: string]: string}
A list of custom attributes to set on this resource.
memoryExpandable boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name string
The name of the vApp container.
parentFolderId string
The managed object ID of the vApp container's parent folder.
tags string[]
The IDs of any tags to attach to this resource.
parent_resource_pool_id This property is required. str
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
cpu_expandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpu_limit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpu_reservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpu_share_level str
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpu_shares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
custom_attributes Mapping[str, str]
A list of custom attributes to set on this resource.
memory_expandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memory_limit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memory_reservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memory_share_level str
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memory_shares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name str
The name of the vApp container.
parent_folder_id str
The managed object ID of the vApp container's parent folder.
tags Sequence[str]
The IDs of any tags to attach to this resource.
parentResourcePoolId This property is required. String
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
cpuExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit Number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation Number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares Number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes Map<String>
A list of custom attributes to set on this resource.
memoryExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit Number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation Number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares Number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name String
The name of the vApp container.
parentFolderId String
The managed object ID of the vApp container's parent folder.
tags List<String>
The IDs of any tags to attach to this resource.

Outputs

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

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

Look up Existing VappContainer Resource

Get an existing VappContainer 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?: VappContainerState, opts?: CustomResourceOptions): VappContainer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cpu_expandable: Optional[bool] = None,
        cpu_limit: Optional[int] = None,
        cpu_reservation: Optional[int] = None,
        cpu_share_level: Optional[str] = None,
        cpu_shares: Optional[int] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        memory_expandable: Optional[bool] = None,
        memory_limit: Optional[int] = None,
        memory_reservation: Optional[int] = None,
        memory_share_level: Optional[str] = None,
        memory_shares: Optional[int] = None,
        name: Optional[str] = None,
        parent_folder_id: Optional[str] = None,
        parent_resource_pool_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> VappContainer
func GetVappContainer(ctx *Context, name string, id IDInput, state *VappContainerState, opts ...ResourceOption) (*VappContainer, error)
public static VappContainer Get(string name, Input<string> id, VappContainerState? state, CustomResourceOptions? opts = null)
public static VappContainer get(String name, Output<String> id, VappContainerState state, CustomResourceOptions options)
resources:  _:    type: vsphere:VappContainer    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CpuExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
CpuLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
CpuReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
CpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
CpuShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
CustomAttributes Dictionary<string, string>
A list of custom attributes to set on this resource.
MemoryExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
MemoryLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
MemoryReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
MemoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
MemoryShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
Name string
The name of the vApp container.
ParentFolderId string
The managed object ID of the vApp container's parent folder.
ParentResourcePoolId string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
Tags List<string>
The IDs of any tags to attach to this resource.
CpuExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
CpuLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
CpuReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
CpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
CpuShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
CustomAttributes map[string]string
A list of custom attributes to set on this resource.
MemoryExpandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
MemoryLimit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
MemoryReservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
MemoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
MemoryShares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
Name string
The name of the vApp container.
ParentFolderId string
The managed object ID of the vApp container's parent folder.
ParentResourcePoolId string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
Tags []string
The IDs of any tags to attach to this resource.
cpuExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit Integer
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation Integer
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares Integer
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes Map<String,String>
A list of custom attributes to set on this resource.
memoryExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit Integer
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation Integer
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares Integer
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name String
The name of the vApp container.
parentFolderId String
The managed object ID of the vApp container's parent folder.
parentResourcePoolId String
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
tags List<String>
The IDs of any tags to attach to this resource.
cpuExpandable boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes {[key: string]: string}
A list of custom attributes to set on this resource.
memoryExpandable boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel string
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name string
The name of the vApp container.
parentFolderId string
The managed object ID of the vApp container's parent folder.
parentResourcePoolId string
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
tags string[]
The IDs of any tags to attach to this resource.
cpu_expandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpu_limit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpu_reservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpu_share_level str
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpu_shares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
custom_attributes Mapping[str, str]
A list of custom attributes to set on this resource.
memory_expandable bool
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memory_limit int
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memory_reservation int
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memory_share_level str
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memory_shares int
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name str
The name of the vApp container.
parent_folder_id str
The managed object ID of the vApp container's parent folder.
parent_resource_pool_id str
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
tags Sequence[str]
The IDs of any tags to attach to this resource.
cpuExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
cpuLimit Number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
cpuReservation Number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
cpuShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
cpuShares Number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
customAttributes Map<String>
A list of custom attributes to set on this resource.
memoryExpandable Boolean
Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
memoryLimit Number
The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
memoryReservation Number
Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
memoryShareLevel String
The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
memoryShares Number
The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
name String
The name of the vApp container.
parentFolderId String
The managed object ID of the vApp container's parent folder.
parentResourcePoolId String
The managed object ID of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
tags List<String>
The IDs of any tags to attach to this resource.

Import

An existing vApp container can be imported into this resource via

the path to the vApp container, using the following command:

Example:

$ pulumi import vsphere:index/vappContainer:VappContainer vapp_container /dc-01/host/cluster-01/Resources/resource-pool-01/vapp-01
Copy

The example above would import the vApp container named vapp-01 that is

located in the resource pool resource-pool-01 that is part of the host cluster

cluster-01 in the dc-01 datacenter.

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

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere