1. Packages
  2. Vcd Provider
  3. API Docs
  4. Vapp
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.Vapp

Explore with Pulumi AI

Create Vapp Resource

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

Constructor syntax

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

@overload
def Vapp(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         guest_properties: Optional[Mapping[str, str]] = None,
         lease: Optional[VappLeaseArgs] = None,
         metadata: Optional[Mapping[str, str]] = None,
         metadata_entries: Optional[Sequence[VappMetadataEntryArgs]] = None,
         name: Optional[str] = None,
         org: Optional[str] = None,
         power_on: Optional[bool] = None,
         vapp_id: Optional[str] = None,
         vdc: Optional[str] = None)
func NewVapp(ctx *Context, name string, args *VappArgs, opts ...ResourceOption) (*Vapp, error)
public Vapp(string name, VappArgs? args = null, CustomResourceOptions? opts = null)
public Vapp(String name, VappArgs args)
public Vapp(String name, VappArgs args, CustomResourceOptions options)
type: vcd:Vapp
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 VappArgs
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 VappArgs
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 VappArgs
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 VappArgs
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. VappArgs
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 vappResource = new Vcd.Vapp("vappResource", new()
{
    Description = "string",
    GuestProperties = 
    {
        { "string", "string" },
    },
    Lease = new Vcd.Inputs.VappLeaseArgs
    {
        RuntimeLeaseInSec = 0,
        StorageLeaseInSec = 0,
    },
    MetadataEntries = new[]
    {
        new Vcd.Inputs.VappMetadataEntryArgs
        {
            IsSystem = false,
            Key = "string",
            Type = "string",
            UserAccess = "string",
            Value = "string",
        },
    },
    Name = "string",
    Org = "string",
    PowerOn = false,
    VappId = "string",
    Vdc = "string",
});
Copy
example, err := vcd.NewVapp(ctx, "vappResource", &vcd.VappArgs{
Description: pulumi.String("string"),
GuestProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Lease: &.VappLeaseArgs{
RuntimeLeaseInSec: pulumi.Float64(0),
StorageLeaseInSec: pulumi.Float64(0),
},
MetadataEntries: .VappMetadataEntryArray{
&.VappMetadataEntryArgs{
IsSystem: pulumi.Bool(false),
Key: pulumi.String("string"),
Type: pulumi.String("string"),
UserAccess: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Org: pulumi.String("string"),
PowerOn: pulumi.Bool(false),
VappId: pulumi.String("string"),
Vdc: pulumi.String("string"),
})
Copy
var vappResource = new Vapp("vappResource", VappArgs.builder()
    .description("string")
    .guestProperties(Map.of("string", "string"))
    .lease(VappLeaseArgs.builder()
        .runtimeLeaseInSec(0)
        .storageLeaseInSec(0)
        .build())
    .metadataEntries(VappMetadataEntryArgs.builder()
        .isSystem(false)
        .key("string")
        .type("string")
        .userAccess("string")
        .value("string")
        .build())
    .name("string")
    .org("string")
    .powerOn(false)
    .vappId("string")
    .vdc("string")
    .build());
Copy
vapp_resource = vcd.Vapp("vappResource",
    description="string",
    guest_properties={
        "string": "string",
    },
    lease={
        "runtime_lease_in_sec": 0,
        "storage_lease_in_sec": 0,
    },
    metadata_entries=[{
        "is_system": False,
        "key": "string",
        "type": "string",
        "user_access": "string",
        "value": "string",
    }],
    name="string",
    org="string",
    power_on=False,
    vapp_id="string",
    vdc="string")
Copy
const vappResource = new vcd.Vapp("vappResource", {
    description: "string",
    guestProperties: {
        string: "string",
    },
    lease: {
        runtimeLeaseInSec: 0,
        storageLeaseInSec: 0,
    },
    metadataEntries: [{
        isSystem: false,
        key: "string",
        type: "string",
        userAccess: "string",
        value: "string",
    }],
    name: "string",
    org: "string",
    powerOn: false,
    vappId: "string",
    vdc: "string",
});
Copy
type: vcd:Vapp
properties:
    description: string
    guestProperties:
        string: string
    lease:
        runtimeLeaseInSec: 0
        storageLeaseInSec: 0
    metadataEntries:
        - isSystem: false
          key: string
          type: string
          userAccess: string
          value: string
    name: string
    org: string
    powerOn: false
    vappId: string
    vdc: string
Copy

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

Description string
An optional description for the vApp, up to 256 characters.
GuestProperties Dictionary<string, string>
Key value map of vApp guest properties
Lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
Metadata Dictionary<string, string>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

MetadataEntries List<VappMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
Name string
A unique name for the vApp
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PowerOn bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
VappId string
Vdc string
The name of VDC to use, optional if defined at provider level
Description string
An optional description for the vApp, up to 256 characters.
GuestProperties map[string]string
Key value map of vApp guest properties
Lease VappLeaseArgs
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
Metadata map[string]string
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

MetadataEntries []VappMetadataEntryArgs
A set of metadata entries to assign. See Metadata section for details.
Name string
A unique name for the vApp
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PowerOn bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
VappId string
Vdc string
The name of VDC to use, optional if defined at provider level
description String
An optional description for the vApp, up to 256 characters.
guestProperties Map<String,String>
Key value map of vApp guest properties
lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Map<String,String>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries List<VappMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
name String
A unique name for the vApp
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn Boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
vappId String
vdc String
The name of VDC to use, optional if defined at provider level
description string
An optional description for the vApp, up to 256 characters.
guestProperties {[key: string]: string}
Key value map of vApp guest properties
lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata {[key: string]: string}
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries VappMetadataEntry[]
A set of metadata entries to assign. See Metadata section for details.
name string
A unique name for the vApp
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
vappId string
vdc string
The name of VDC to use, optional if defined at provider level
description str
An optional description for the vApp, up to 256 characters.
guest_properties Mapping[str, str]
Key value map of vApp guest properties
lease VappLeaseArgs
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Mapping[str, str]
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadata_entries Sequence[VappMetadataEntryArgs]
A set of metadata entries to assign. See Metadata section for details.
name str
A unique name for the vApp
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
power_on bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
vapp_id str
vdc str
The name of VDC to use, optional if defined at provider level
description String
An optional description for the vApp, up to 256 characters.
guestProperties Map<String>
Key value map of vApp guest properties
lease Property Map
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Map<String>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries List<Property Map>
A set of metadata entries to assign. See Metadata section for details.
name String
A unique name for the vApp
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn Boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
vappId String
vdc String
The name of VDC to use, optional if defined at provider level

Outputs

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

Href string
(Computed) The vApp Hyper Reference.
Id string
The provider-assigned unique ID for this managed resource.
InheritedMetadata Dictionary<string, string>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
Status double
(Computed; v2.5+) The vApp status as a numeric code.
StatusText string
(Computed; v2.5+) The vApp status as text.
VappNetworkNames List<string>
(v3.13.0+) A list of vApp network names included in this vApp
VappOrgNetworkNames List<string>
(v3.13.0+) A list of vApp Org network names included in this vApp
VmNames List<string>
(v3.13.0+) A list of VM names included in this vApp
Href string
(Computed) The vApp Hyper Reference.
Id string
The provider-assigned unique ID for this managed resource.
InheritedMetadata map[string]string
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
Status float64
(Computed; v2.5+) The vApp status as a numeric code.
StatusText string
(Computed; v2.5+) The vApp status as text.
VappNetworkNames []string
(v3.13.0+) A list of vApp network names included in this vApp
VappOrgNetworkNames []string
(v3.13.0+) A list of vApp Org network names included in this vApp
VmNames []string
(v3.13.0+) A list of VM names included in this vApp
href String
(Computed) The vApp Hyper Reference.
id String
The provider-assigned unique ID for this managed resource.
inheritedMetadata Map<String,String>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
status Double
(Computed; v2.5+) The vApp status as a numeric code.
statusText String
(Computed; v2.5+) The vApp status as text.
vappNetworkNames List<String>
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames List<String>
(v3.13.0+) A list of vApp Org network names included in this vApp
vmNames List<String>
(v3.13.0+) A list of VM names included in this vApp
href string
(Computed) The vApp Hyper Reference.
id string
The provider-assigned unique ID for this managed resource.
inheritedMetadata {[key: string]: string}
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
status number
(Computed; v2.5+) The vApp status as a numeric code.
statusText string
(Computed; v2.5+) The vApp status as text.
vappNetworkNames string[]
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames string[]
(v3.13.0+) A list of vApp Org network names included in this vApp
vmNames string[]
(v3.13.0+) A list of VM names included in this vApp
href str
(Computed) The vApp Hyper Reference.
id str
The provider-assigned unique ID for this managed resource.
inherited_metadata Mapping[str, str]
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
status float
(Computed; v2.5+) The vApp status as a numeric code.
status_text str
(Computed; v2.5+) The vApp status as text.
vapp_network_names Sequence[str]
(v3.13.0+) A list of vApp network names included in this vApp
vapp_org_network_names Sequence[str]
(v3.13.0+) A list of vApp Org network names included in this vApp
vm_names Sequence[str]
(v3.13.0+) A list of VM names included in this vApp
href String
(Computed) The vApp Hyper Reference.
id String
The provider-assigned unique ID for this managed resource.
inheritedMetadata Map<String>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
status Number
(Computed; v2.5+) The vApp status as a numeric code.
statusText String
(Computed; v2.5+) The vApp status as text.
vappNetworkNames List<String>
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames List<String>
(v3.13.0+) A list of vApp Org network names included in this vApp
vmNames List<String>
(v3.13.0+) A list of VM names included in this vApp

Look up Existing Vapp Resource

Get an existing Vapp 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?: VappState, opts?: CustomResourceOptions): Vapp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        guest_properties: Optional[Mapping[str, str]] = None,
        href: Optional[str] = None,
        inherited_metadata: Optional[Mapping[str, str]] = None,
        lease: Optional[VappLeaseArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[VappMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        power_on: Optional[bool] = None,
        status: Optional[float] = None,
        status_text: Optional[str] = None,
        vapp_id: Optional[str] = None,
        vapp_network_names: Optional[Sequence[str]] = None,
        vapp_org_network_names: Optional[Sequence[str]] = None,
        vdc: Optional[str] = None,
        vm_names: Optional[Sequence[str]] = None) -> Vapp
func GetVapp(ctx *Context, name string, id IDInput, state *VappState, opts ...ResourceOption) (*Vapp, error)
public static Vapp Get(string name, Input<string> id, VappState? state, CustomResourceOptions? opts = null)
public static Vapp get(String name, Output<String> id, VappState state, CustomResourceOptions options)
resources:  _:    type: vcd:Vapp    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:
Description string
An optional description for the vApp, up to 256 characters.
GuestProperties Dictionary<string, string>
Key value map of vApp guest properties
Href string
(Computed) The vApp Hyper Reference.
InheritedMetadata Dictionary<string, string>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
Lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
Metadata Dictionary<string, string>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

MetadataEntries List<VappMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
Name string
A unique name for the vApp
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PowerOn bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
Status double
(Computed; v2.5+) The vApp status as a numeric code.
StatusText string
(Computed; v2.5+) The vApp status as text.
VappId string
VappNetworkNames List<string>
(v3.13.0+) A list of vApp network names included in this vApp
VappOrgNetworkNames List<string>
(v3.13.0+) A list of vApp Org network names included in this vApp
Vdc string
The name of VDC to use, optional if defined at provider level
VmNames List<string>
(v3.13.0+) A list of VM names included in this vApp
Description string
An optional description for the vApp, up to 256 characters.
GuestProperties map[string]string
Key value map of vApp guest properties
Href string
(Computed) The vApp Hyper Reference.
InheritedMetadata map[string]string
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
Lease VappLeaseArgs
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
Metadata map[string]string
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

MetadataEntries []VappMetadataEntryArgs
A set of metadata entries to assign. See Metadata section for details.
Name string
A unique name for the vApp
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PowerOn bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
Status float64
(Computed; v2.5+) The vApp status as a numeric code.
StatusText string
(Computed; v2.5+) The vApp status as text.
VappId string
VappNetworkNames []string
(v3.13.0+) A list of vApp network names included in this vApp
VappOrgNetworkNames []string
(v3.13.0+) A list of vApp Org network names included in this vApp
Vdc string
The name of VDC to use, optional if defined at provider level
VmNames []string
(v3.13.0+) A list of VM names included in this vApp
description String
An optional description for the vApp, up to 256 characters.
guestProperties Map<String,String>
Key value map of vApp guest properties
href String
(Computed) The vApp Hyper Reference.
inheritedMetadata Map<String,String>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Map<String,String>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries List<VappMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
name String
A unique name for the vApp
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn Boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
status Double
(Computed; v2.5+) The vApp status as a numeric code.
statusText String
(Computed; v2.5+) The vApp status as text.
vappId String
vappNetworkNames List<String>
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames List<String>
(v3.13.0+) A list of vApp Org network names included in this vApp
vdc String
The name of VDC to use, optional if defined at provider level
vmNames List<String>
(v3.13.0+) A list of VM names included in this vApp
description string
An optional description for the vApp, up to 256 characters.
guestProperties {[key: string]: string}
Key value map of vApp guest properties
href string
(Computed) The vApp Hyper Reference.
inheritedMetadata {[key: string]: string}
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
lease VappLease
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata {[key: string]: string}
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries VappMetadataEntry[]
A set of metadata entries to assign. See Metadata section for details.
name string
A unique name for the vApp
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
status number
(Computed; v2.5+) The vApp status as a numeric code.
statusText string
(Computed; v2.5+) The vApp status as text.
vappId string
vappNetworkNames string[]
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames string[]
(v3.13.0+) A list of vApp Org network names included in this vApp
vdc string
The name of VDC to use, optional if defined at provider level
vmNames string[]
(v3.13.0+) A list of VM names included in this vApp
description str
An optional description for the vApp, up to 256 characters.
guest_properties Mapping[str, str]
Key value map of vApp guest properties
href str
(Computed) The vApp Hyper Reference.
inherited_metadata Mapping[str, str]
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
lease VappLeaseArgs
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Mapping[str, str]
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadata_entries Sequence[VappMetadataEntryArgs]
A set of metadata entries to assign. See Metadata section for details.
name str
A unique name for the vApp
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
power_on bool
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
status float
(Computed; v2.5+) The vApp status as a numeric code.
status_text str
(Computed; v2.5+) The vApp status as text.
vapp_id str
vapp_network_names Sequence[str]
(v3.13.0+) A list of vApp network names included in this vApp
vapp_org_network_names Sequence[str]
(v3.13.0+) A list of vApp Org network names included in this vApp
vdc str
The name of VDC to use, optional if defined at provider level
vm_names Sequence[str]
(v3.13.0+) A list of VM names included in this vApp
description String
An optional description for the vApp, up to 256 characters.
guestProperties Map<String>
Key value map of vApp guest properties
href String
(Computed) The vApp Hyper Reference.
inheritedMetadata Map<String>
(Computed; v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the vApp (e.g. vapp.origin.id, vapp.origin.name, vapp.origin.type).
lease Property Map
the information about the vApp lease. It includes the fields below. When this section is included, both fields are mandatory. If lease values are higher than the ones allowed for the whole Org, the values are silently reduced to the highest value allowed.
metadata Map<String>
Use metadata_entry instead. Key value map of metadata to assign to this vApp. Key and value can be any string. (Since v2.2+ metadata is added directly to vApp instead of first VM in vApp)

Deprecated: Deprecated

metadataEntries List<Property Map>
A set of metadata entries to assign. See Metadata section for details.
name String
A unique name for the vApp
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
powerOn Boolean
A boolean value stating if this vApp should be powered on. Default is false. Works only on update when vApp already has VMs.
status Number
(Computed; v2.5+) The vApp status as a numeric code.
statusText String
(Computed; v2.5+) The vApp status as text.
vappId String
vappNetworkNames List<String>
(v3.13.0+) A list of vApp network names included in this vApp
vappOrgNetworkNames List<String>
(v3.13.0+) A list of vApp Org network names included in this vApp
vdc String
The name of VDC to use, optional if defined at provider level
vmNames List<String>
(v3.13.0+) A list of VM names included in this vApp

Supporting Types

VappLease
, VappLeaseArgs

RuntimeLeaseInSec This property is required. double
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
StorageLeaseInSec This property is required. double
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
RuntimeLeaseInSec This property is required. float64
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
StorageLeaseInSec This property is required. float64
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
runtimeLeaseInSec This property is required. Double
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
storageLeaseInSec This property is required. Double
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
runtimeLeaseInSec This property is required. number
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
storageLeaseInSec This property is required. number
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
runtime_lease_in_sec This property is required. float
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
storage_lease_in_sec This property is required. float
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
runtimeLeaseInSec This property is required. Number
How long any of the VMs in the vApp can run before the vApp is automatically powered off or suspended. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.
storageLeaseInSec This property is required. Number
How long the vApp is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by Org). Regular values accepted from 3600+.

VappMetadataEntry
, VappMetadataEntryArgs

IsSystem bool
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
Key string
Key of this metadata entry. Required if the metadata entry is not empty
Type string
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
UserAccess string
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
Value string
Value of this metadata entry. Required if the metadata entry is not empty
IsSystem bool
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
Key string
Key of this metadata entry. Required if the metadata entry is not empty
Type string
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
UserAccess string
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
Value string
Value of this metadata entry. Required if the metadata entry is not empty
isSystem Boolean
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key String
Key of this metadata entry. Required if the metadata entry is not empty
type String
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess String
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value String
Value of this metadata entry. Required if the metadata entry is not empty
isSystem boolean
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key string
Key of this metadata entry. Required if the metadata entry is not empty
type string
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess string
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value string
Value of this metadata entry. Required if the metadata entry is not empty
is_system bool
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key str
Key of this metadata entry. Required if the metadata entry is not empty
type str
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
user_access str
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value str
Value of this metadata entry. Required if the metadata entry is not empty
isSystem Boolean
Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key String
Key of this metadata entry. Required if the metadata entry is not empty
type String
Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess String
User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value String
Value of this metadata entry. Required if the metadata entry is not empty

Package Details

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