Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. CatalogVappTemplate
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.CatalogVappTemplate

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create CatalogVappTemplate Resource

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

    Constructor syntax

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

@overload
def CatalogVappTemplate(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        catalog_id: Optional[str] = None,
                        capture_vapp: Optional[CatalogVappTemplateCaptureVappArgs] = None,
                        catalog_vapp_template_id: Optional[str] = None,
                        description: Optional[str] = None,
                        lease: Optional[CatalogVappTemplateLeaseArgs] = None,
                        metadata: Optional[Mapping[str, str]] = None,
                        metadata_entries: Optional[Sequence[CatalogVappTemplateMetadataEntryArgs]] = None,
                        name: Optional[str] = None,
                        org: Optional[str] = None,
                        ova_path: Optional[str] = None,
                        ovf_url: Optional[str] = None,
                        upload_piece_size: Optional[float] = None)
    func NewCatalogVappTemplate(ctx *Context, name string, args CatalogVappTemplateArgs, opts ...ResourceOption) (*CatalogVappTemplate, error)
    public CatalogVappTemplate(string name, CatalogVappTemplateArgs args, CustomResourceOptions? opts = null)
    public CatalogVappTemplate(String name, CatalogVappTemplateArgs args)
public CatalogVappTemplate(String name, CatalogVappTemplateArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args CatalogVappTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CatalogVappTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CatalogVappTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogVappTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogVappTemplateArgs
    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 catalogVappTemplateResource = new Vcd.CatalogVappTemplate("catalogVappTemplateResource", new()
{
    CatalogId = "string",
    CaptureVapp = new Vcd.Inputs.CatalogVappTemplateCaptureVappArgs
    {
        CopyTpmOnInstantiate = false,
        CustomizeOnInstantiate = false,
        OverwriteCatalogItemId = "string",
        SourceId = "string",
    },
    CatalogVappTemplateId = "string",
    Description = "string",
    Lease = new Vcd.Inputs.CatalogVappTemplateLeaseArgs
    {
        StorageLeaseInSec = 0,
    },
    MetadataEntries = new[]
    {
        new Vcd.Inputs.CatalogVappTemplateMetadataEntryArgs
        {
            IsSystem = false,
            Key = "string",
            Type = "string",
            UserAccess = "string",
            Value = "string",
        },
    },
    Name = "string",
    Org = "string",
    OvaPath = "string",
    OvfUrl = "string",
    UploadPieceSize = 0,
});

    example, err := vcd.NewCatalogVappTemplate(ctx, "catalogVappTemplateResource", &vcd.CatalogVappTemplateArgs{
	CatalogId: pulumi.String("string"),
	CaptureVapp: &vcd.CatalogVappTemplateCaptureVappArgs{
		CopyTpmOnInstantiate:   pulumi.Bool(false),
		CustomizeOnInstantiate: pulumi.Bool(false),
		OverwriteCatalogItemId: pulumi.String("string"),
		SourceId:               pulumi.String("string"),
	},
	CatalogVappTemplateId: pulumi.String("string"),
	Description:           pulumi.String("string"),
	Lease: &vcd.CatalogVappTemplateLeaseArgs{
		StorageLeaseInSec: pulumi.Float64(0),
	},
	MetadataEntries: vcd.CatalogVappTemplateMetadataEntryArray{
		&vcd.CatalogVappTemplateMetadataEntryArgs{
			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"),
	OvaPath:         pulumi.String("string"),
	OvfUrl:          pulumi.String("string"),
	UploadPieceSize: pulumi.Float64(0),
})

    var catalogVappTemplateResource = new CatalogVappTemplate("catalogVappTemplateResource", CatalogVappTemplateArgs.builder()
    .catalogId("string")
    .captureVapp(CatalogVappTemplateCaptureVappArgs.builder()
        .copyTpmOnInstantiate(false)
        .customizeOnInstantiate(false)
        .overwriteCatalogItemId("string")
        .sourceId("string")
        .build())
    .catalogVappTemplateId("string")
    .description("string")
    .lease(CatalogVappTemplateLeaseArgs.builder()
        .storageLeaseInSec(0)
        .build())
    .metadataEntries(CatalogVappTemplateMetadataEntryArgs.builder()
        .isSystem(false)
        .key("string")
        .type("string")
        .userAccess("string")
        .value("string")
        .build())
    .name("string")
    .org("string")
    .ovaPath("string")
    .ovfUrl("string")
    .uploadPieceSize(0)
    .build());

    catalog_vapp_template_resource = vcd.CatalogVappTemplate("catalogVappTemplateResource",
    catalog_id="string",
    capture_vapp={
        "copy_tpm_on_instantiate": False,
        "customize_on_instantiate": False,
        "overwrite_catalog_item_id": "string",
        "source_id": "string",
    },
    catalog_vapp_template_id="string",
    description="string",
    lease={
        "storage_lease_in_sec": 0,
    },
    metadata_entries=[{
        "is_system": False,
        "key": "string",
        "type": "string",
        "user_access": "string",
        "value": "string",
    }],
    name="string",
    org="string",
    ova_path="string",
    ovf_url="string",
    upload_piece_size=0)

    const catalogVappTemplateResource = new vcd.CatalogVappTemplate("catalogVappTemplateResource", {
    catalogId: "string",
    captureVapp: {
        copyTpmOnInstantiate: false,
        customizeOnInstantiate: false,
        overwriteCatalogItemId: "string",
        sourceId: "string",
    },
    catalogVappTemplateId: "string",
    description: "string",
    lease: {
        storageLeaseInSec: 0,
    },
    metadataEntries: [{
        isSystem: false,
        key: "string",
        type: "string",
        userAccess: "string",
        value: "string",
    }],
    name: "string",
    org: "string",
    ovaPath: "string",
    ovfUrl: "string",
    uploadPieceSize: 0,
});

    type: vcd:CatalogVappTemplate
properties:
    captureVapp:
        copyTpmOnInstantiate: false
        customizeOnInstantiate: false
        overwriteCatalogItemId: string
        sourceId: string
    catalogId: string
    catalogVappTemplateId: string
    description: string
    lease:
        storageLeaseInSec: 0
    metadataEntries:
        - isSystem: false
          key: string
          type: string
          userAccess: string
          value: string
    name: string
    org: string
    ovaPath: string
    ovfUrl: string
    uploadPieceSize: 0

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

    CatalogId string
    ID of the Catalog where to upload the OVA file
    CaptureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    CatalogVappTemplateId string
    Description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    Lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    Metadata Dictionary<string, string>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    MetadataEntries List<CatalogVappTemplateMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    vApp Template name in Catalog
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OvaPath string
    Absolute or relative path to file to upload
    OvfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    UploadPieceSize double
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    CatalogId string
    ID of the Catalog where to upload the OVA file
    CaptureVapp CatalogVappTemplateCaptureVappArgs
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    CatalogVappTemplateId string
    Description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    Lease CatalogVappTemplateLeaseArgs
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    Metadata map[string]string
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    MetadataEntries []CatalogVappTemplateMetadataEntryArgs
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    vApp Template name in Catalog
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OvaPath string
    Absolute or relative path to file to upload
    OvfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    UploadPieceSize float64
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    catalogId String
    ID of the Catalog where to upload the OVA file
    captureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogVappTemplateId String
    description String
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Map<String,String>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries List<CatalogVappTemplateMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    vApp Template name in Catalog
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath String
    Absolute or relative path to file to upload
    ovfUrl String
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize Double
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    catalogId string
    ID of the Catalog where to upload the OVA file
    captureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogVappTemplateId string
    description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata {[key: string]: string}
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries CatalogVappTemplateMetadataEntry[]
    A set of metadata entries to assign. See Metadata section for details.
    name string
    vApp Template name in Catalog
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath string
    Absolute or relative path to file to upload
    ovfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize number
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    catalog_id str
    ID of the Catalog where to upload the OVA file
    capture_vapp CatalogVappTemplateCaptureVappArgs
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalog_vapp_template_id str
    description str
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    lease CatalogVappTemplateLeaseArgs
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Mapping[str, str]
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadata_entries Sequence[CatalogVappTemplateMetadataEntryArgs]
    A set of metadata entries to assign. See Metadata section for details.
    name str
    vApp Template name in Catalog
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ova_path str
    Absolute or relative path to file to upload
    ovf_url str
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    upload_piece_size float
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    catalogId String
    ID of the Catalog where to upload the OVA file
    captureVapp Property Map
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogVappTemplateId String
    description String
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    lease Property Map
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Map<String>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    vApp Template name in Catalog
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath String
    Absolute or relative path to file to upload
    ovfUrl String
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize Number
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB

    Outputs

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

    CatalogItemId string
    Catalog Item ID
    Created string
    Timestamp of when the vApp Template was created
    Id string
    The provider-assigned unique ID for this managed resource.
    InheritedMetadata Dictionary<string, string>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    VdcId string
    The VDC ID to which this vApp Template belongs
    VmNames List<string>
    Set of VM names within the vApp template
    CatalogItemId string
    Catalog Item ID
    Created string
    Timestamp of when the vApp Template was created
    Id string
    The provider-assigned unique ID for this managed resource.
    InheritedMetadata map[string]string
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    VdcId string
    The VDC ID to which this vApp Template belongs
    VmNames []string
    Set of VM names within the vApp template
    catalogItemId String
    Catalog Item ID
    created String
    Timestamp of when the vApp Template was created
    id String
    The provider-assigned unique ID for this managed resource.
    inheritedMetadata Map<String,String>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    vdcId String
    The VDC ID to which this vApp Template belongs
    vmNames List<String>
    Set of VM names within the vApp template
    catalogItemId string
    Catalog Item ID
    created string
    Timestamp of when the vApp Template was created
    id string
    The provider-assigned unique ID for this managed resource.
    inheritedMetadata {[key: string]: string}
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    vdcId string
    The VDC ID to which this vApp Template belongs
    vmNames string[]
    Set of VM names within the vApp template
    catalog_item_id str
    Catalog Item ID
    created str
    Timestamp of when the vApp Template was created
    id str
    The provider-assigned unique ID for this managed resource.
    inherited_metadata Mapping[str, str]
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    vdc_id str
    The VDC ID to which this vApp Template belongs
    vm_names Sequence[str]
    Set of VM names within the vApp template
    catalogItemId String
    Catalog Item ID
    created String
    Timestamp of when the vApp Template was created
    id String
    The provider-assigned unique ID for this managed resource.
    inheritedMetadata Map<String>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    vdcId String
    The VDC ID to which this vApp Template belongs
    vmNames List<String>
    Set of VM names within the vApp template

    Look up Existing CatalogVappTemplate Resource

    Get an existing CatalogVappTemplate 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?: CatalogVappTemplateState, opts?: CustomResourceOptions): CatalogVappTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capture_vapp: Optional[CatalogVappTemplateCaptureVappArgs] = None,
        catalog_id: Optional[str] = None,
        catalog_item_id: Optional[str] = None,
        catalog_vapp_template_id: Optional[str] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        inherited_metadata: Optional[Mapping[str, str]] = None,
        lease: Optional[CatalogVappTemplateLeaseArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[CatalogVappTemplateMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        ova_path: Optional[str] = None,
        ovf_url: Optional[str] = None,
        upload_piece_size: Optional[float] = None,
        vdc_id: Optional[str] = None,
        vm_names: Optional[Sequence[str]] = None) -> CatalogVappTemplate
    func GetCatalogVappTemplate(ctx *Context, name string, id IDInput, state *CatalogVappTemplateState, opts ...ResourceOption) (*CatalogVappTemplate, error)
    public static CatalogVappTemplate Get(string name, Input<string> id, CatalogVappTemplateState? state, CustomResourceOptions? opts = null)
    public static CatalogVappTemplate get(String name, Output<String> id, CatalogVappTemplateState state, CustomResourceOptions options)
    resources:  _:    type: vcd:CatalogVappTemplate    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CaptureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    CatalogId string
    ID of the Catalog where to upload the OVA file
    CatalogItemId string
    Catalog Item ID
    CatalogVappTemplateId string
    Created string
    Timestamp of when the vApp Template was created
    Description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    InheritedMetadata Dictionary<string, string>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    Lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    Metadata Dictionary<string, string>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    MetadataEntries List<CatalogVappTemplateMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    vApp Template name in Catalog
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OvaPath string
    Absolute or relative path to file to upload
    OvfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    UploadPieceSize double
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    VdcId string
    The VDC ID to which this vApp Template belongs
    VmNames List<string>
    Set of VM names within the vApp template
    CaptureVapp CatalogVappTemplateCaptureVappArgs
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    CatalogId string
    ID of the Catalog where to upload the OVA file
    CatalogItemId string
    Catalog Item ID
    CatalogVappTemplateId string
    Created string
    Timestamp of when the vApp Template was created
    Description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    InheritedMetadata map[string]string
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    Lease CatalogVappTemplateLeaseArgs
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    Metadata map[string]string
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    MetadataEntries []CatalogVappTemplateMetadataEntryArgs
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    vApp Template name in Catalog
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OvaPath string
    Absolute or relative path to file to upload
    OvfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    UploadPieceSize float64
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    VdcId string
    The VDC ID to which this vApp Template belongs
    VmNames []string
    Set of VM names within the vApp template
    captureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogId String
    ID of the Catalog where to upload the OVA file
    catalogItemId String
    Catalog Item ID
    catalogVappTemplateId String
    created String
    Timestamp of when the vApp Template was created
    description String
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    inheritedMetadata Map<String,String>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Map<String,String>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries List<CatalogVappTemplateMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    vApp Template name in Catalog
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath String
    Absolute or relative path to file to upload
    ovfUrl String
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize Double
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    vdcId String
    The VDC ID to which this vApp Template belongs
    vmNames List<String>
    Set of VM names within the vApp template
    captureVapp CatalogVappTemplateCaptureVapp
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogId string
    ID of the Catalog where to upload the OVA file
    catalogItemId string
    Catalog Item ID
    catalogVappTemplateId string
    created string
    Timestamp of when the vApp Template was created
    description string
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    inheritedMetadata {[key: string]: string}
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    lease CatalogVappTemplateLease
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata {[key: string]: string}
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries CatalogVappTemplateMetadataEntry[]
    A set of metadata entries to assign. See Metadata section for details.
    name string
    vApp Template name in Catalog
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath string
    Absolute or relative path to file to upload
    ovfUrl string
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize number
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    vdcId string
    The VDC ID to which this vApp Template belongs
    vmNames string[]
    Set of VM names within the vApp template
    capture_vapp CatalogVappTemplateCaptureVappArgs
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalog_id str
    ID of the Catalog where to upload the OVA file
    catalog_item_id str
    Catalog Item ID
    catalog_vapp_template_id str
    created str
    Timestamp of when the vApp Template was created
    description str
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    inherited_metadata Mapping[str, str]
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    lease CatalogVappTemplateLeaseArgs
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Mapping[str, str]
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadata_entries Sequence[CatalogVappTemplateMetadataEntryArgs]
    A set of metadata entries to assign. See Metadata section for details.
    name str
    vApp Template name in Catalog
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ova_path str
    Absolute or relative path to file to upload
    ovf_url str
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    upload_piece_size float
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    vdc_id str
    The VDC ID to which this vApp Template belongs
    vm_names Sequence[str]
    Set of VM names within the vApp template
    captureVapp Property Map
    A configuration block to create template from existing vApp (Standalone VM or vApp)
    catalogId String
    ID of the Catalog where to upload the OVA file
    catalogItemId String
    Catalog Item ID
    catalogVappTemplateId String
    created String
    Timestamp of when the vApp Template was created
    description String
    Description of the vApp Template. Not to be used with ovf_url when target OVA has a description
    inheritedMetadata Map<String>
    A map that contains metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM
    lease Property Map
    The information about the vApp Template lease. It includes the field below. When this section is included, the field is mandatory. If lease value is higher than the one allowed for the whole Org, we get an error
    metadata Map<String>
    Use metadata_entry instead. Key/value map of metadata to assign to the associated vApp Template

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    vApp Template name in Catalog
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ovaPath String
    Absolute or relative path to file to upload
    ovfUrl String
    URL to OVF file. Only OVF (not OVA) files are supported by VCD uploading by URL
    uploadPieceSize Number
    Size in MB for splitting upload size. It can possibly impact upload performance. Default 1MB
    vdcId String
    The VDC ID to which this vApp Template belongs
    vmNames List<String>
    Set of VM names within the vApp template

    Supporting Types

    CatalogVappTemplateCaptureVapp, CatalogVappTemplateCaptureVappArgs

    CopyTpmOnInstantiate bool
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    CustomizeOnInstantiate bool
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    OverwriteCatalogItemId string
    An existing catalog item ID to overwrite
    SourceId string
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')
    CopyTpmOnInstantiate bool
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    CustomizeOnInstantiate bool
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    OverwriteCatalogItemId string
    An existing catalog item ID to overwrite
    SourceId string
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')
    copyTpmOnInstantiate Boolean
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    customizeOnInstantiate Boolean
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    overwriteCatalogItemId String
    An existing catalog item ID to overwrite
    sourceId String
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')
    copyTpmOnInstantiate boolean
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    customizeOnInstantiate boolean
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    overwriteCatalogItemId string
    An existing catalog item ID to overwrite
    sourceId string
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')
    copy_tpm_on_instantiate bool
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    customize_on_instantiate bool
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    overwrite_catalog_item_id str
    An existing catalog item ID to overwrite
    source_id str
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')
    copyTpmOnInstantiate Boolean
    Defines if Trusted Platform Module should be copied (false) or created (true). Default 'false'. VCD 10.4.2+
    customizeOnInstantiate Boolean
    Marks if instantiating applies customization settings ('true'). Default is 'false` - create an identical copy.
    overwriteCatalogItemId String
    An existing catalog item ID to overwrite
    sourceId String
    Source vApp ID (can be a vApp ID or 'vapp_id' field of standalone VM 'vcd_vm')

    CatalogVappTemplateLease, CatalogVappTemplateLeaseArgs

    StorageLeaseInSec double
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.
    StorageLeaseInSec float64
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.
    storageLeaseInSec Double
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.
    storageLeaseInSec number
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.
    storage_lease_in_sec float
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.
    storageLeaseInSec Number
    How long the vApp Template is available before being automatically deleted or marked as expired. 0 means never expires (or maximum allowed by parent Org). Regular values accepted from 3600+.

    CatalogVappTemplateMetadataEntry, CatalogVappTemplateMetadataEntryArgs

    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.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd