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

vcd.Catalog

Explore with Pulumi AI

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

    Create Catalog Resource

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

    Constructor syntax

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

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cache_enabled: Optional[bool] = None,
            catalog_id: Optional[str] = None,
            delete_force: Optional[bool] = None,
            delete_recursive: Optional[bool] = None,
            description: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            metadata_entries: Optional[Sequence[CatalogMetadataEntryArgs]] = None,
            name: Optional[str] = None,
            org: Optional[str] = None,
            password: Optional[str] = None,
            preserve_identity_information: Optional[bool] = None,
            publish_enabled: Optional[bool] = None,
            storage_profile_id: Optional[str] = None)
    func NewCatalog(ctx *Context, name string, args *CatalogArgs, opts ...ResourceOption) (*Catalog, error)
    public Catalog(string name, CatalogArgs? args = null, CustomResourceOptions? opts = null)
    public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

    type: vcd:Catalog
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 CatalogArgs
    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 CatalogArgs
    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 CatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogArgs
    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 catalogResource = new Vcd.Catalog("catalogResource", new()
{
    CacheEnabled = false,
    CatalogId = "string",
    DeleteForce = false,
    DeleteRecursive = false,
    Description = "string",
    MetadataEntries = new[]
    {
        new Vcd.Inputs.CatalogMetadataEntryArgs
        {
            IsSystem = false,
            Key = "string",
            Type = "string",
            UserAccess = "string",
            Value = "string",
        },
    },
    Name = "string",
    Org = "string",
    Password = "string",
    PreserveIdentityInformation = false,
    PublishEnabled = false,
    StorageProfileId = "string",
});

    example, err := vcd.NewCatalog(ctx, "catalogResource", &vcd.CatalogArgs{
	CacheEnabled:    pulumi.Bool(false),
	CatalogId:       pulumi.String("string"),
	DeleteForce:     pulumi.Bool(false),
	DeleteRecursive: pulumi.Bool(false),
	Description:     pulumi.String("string"),
	MetadataEntries: vcd.CatalogMetadataEntryArray{
		&vcd.CatalogMetadataEntryArgs{
			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"),
	Password:                    pulumi.String("string"),
	PreserveIdentityInformation: pulumi.Bool(false),
	PublishEnabled:              pulumi.Bool(false),
	StorageProfileId:            pulumi.String("string"),
})

    var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
    .cacheEnabled(false)
    .catalogId("string")
    .deleteForce(false)
    .deleteRecursive(false)
    .description("string")
    .metadataEntries(CatalogMetadataEntryArgs.builder()
        .isSystem(false)
        .key("string")
        .type("string")
        .userAccess("string")
        .value("string")
        .build())
    .name("string")
    .org("string")
    .password("string")
    .preserveIdentityInformation(false)
    .publishEnabled(false)
    .storageProfileId("string")
    .build());

    catalog_resource = vcd.Catalog("catalogResource",
    cache_enabled=False,
    catalog_id="string",
    delete_force=False,
    delete_recursive=False,
    description="string",
    metadata_entries=[{
        "is_system": False,
        "key": "string",
        "type": "string",
        "user_access": "string",
        "value": "string",
    }],
    name="string",
    org="string",
    password="string",
    preserve_identity_information=False,
    publish_enabled=False,
    storage_profile_id="string")

    const catalogResource = new vcd.Catalog("catalogResource", {
    cacheEnabled: false,
    catalogId: "string",
    deleteForce: false,
    deleteRecursive: false,
    description: "string",
    metadataEntries: [{
        isSystem: false,
        key: "string",
        type: "string",
        userAccess: "string",
        value: "string",
    }],
    name: "string",
    org: "string",
    password: "string",
    preserveIdentityInformation: false,
    publishEnabled: false,
    storageProfileId: "string",
});

    type: vcd:Catalog
properties:
    cacheEnabled: false
    catalogId: string
    deleteForce: false
    deleteRecursive: false
    description: string
    metadataEntries:
        - isSystem: false
          key: string
          type: string
          userAccess: string
          value: string
    name: string
    org: string
    password: string
    preserveIdentityInformation: false
    publishEnabled: false
    storageProfileId: string

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

    CacheEnabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    CatalogId string
    DeleteForce bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    DeleteRecursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    Description string
    Description of catalog
    Metadata Dictionary<string, string>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    MetadataEntries List<CatalogMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    Catalog name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    Password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    PreserveIdentityInformation bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    PublishEnabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    CacheEnabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    CatalogId string
    DeleteForce bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    DeleteRecursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    Description string
    Description of catalog
    Metadata map[string]string
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    MetadataEntries []CatalogMetadataEntryArgs
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    Catalog name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    Password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    PreserveIdentityInformation bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    PublishEnabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    cacheEnabled Boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId String
    deleteForce Boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive Boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description String
    Description of catalog
    metadata Map<String,String>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries List<CatalogMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    Catalog name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    password String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation Boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled Boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    cacheEnabled boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId string
    deleteForce boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description string
    Description of catalog
    metadata {[key: string]: string}
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries CatalogMetadataEntry[]
    A set of metadata entries to assign. See Metadata section for details.
    name string
    Catalog name
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    storageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    cache_enabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalog_id str
    delete_force bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    delete_recursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description str
    Description of catalog
    metadata Mapping[str, str]
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadata_entries Sequence[CatalogMetadataEntryArgs]
    A set of metadata entries to assign. See Metadata section for details.
    name str
    Catalog name
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    password str
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserve_identity_information bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publish_enabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    storage_profile_id str
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    cacheEnabled Boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId String
    deleteForce Boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive Boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description String
    Description of catalog
    metadata Map<String>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    Catalog name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    password String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation Boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled Boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.

    Outputs

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

    CatalogVersion double
    (v3.6+) Version number from this catalog.
    Created string
    (v3.6+) Date and time of catalog creation
    Href string
    Catalog HREF
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    IsShared bool
    (v3.6+) Indicates if the catalog is shared.
    MediaItemLists List<string>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    NumberOfMedia double
    (v3.6+) Number of media items available in this catalog.
    NumberOfVappTemplates double
    (v3.6+) Number of vApp templates available in this catalog.
    OwnerName string
    (v3.6+) Owner of the catalog.
    PublishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    PublishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    VappTemplateLists List<string>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    CatalogVersion float64
    (v3.6+) Version number from this catalog.
    Created string
    (v3.6+) Date and time of catalog creation
    Href string
    Catalog HREF
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    IsShared bool
    (v3.6+) Indicates if the catalog is shared.
    MediaItemLists []string
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    NumberOfMedia float64
    (v3.6+) Number of media items available in this catalog.
    NumberOfVappTemplates float64
    (v3.6+) Number of vApp templates available in this catalog.
    OwnerName string
    (v3.6+) Owner of the catalog.
    PublishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    PublishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    VappTemplateLists []string
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    catalogVersion Double
    (v3.6+) Version number from this catalog.
    created String
    (v3.6+) Date and time of catalog creation
    href String
    Catalog HREF
    id String
    The provider-assigned unique ID for this managed resource.
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared Boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists List<String>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    numberOfMedia Double
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates Double
    (v3.6+) Number of vApp templates available in this catalog.
    ownerName String
    (v3.6+) Owner of the catalog.
    publishSubscriptionType String
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl String
    (v3.8+) URL to which other catalogs can subscribe.
    vappTemplateLists List<String>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    catalogVersion number
    (v3.6+) Version number from this catalog.
    created string
    (v3.6+) Date and time of catalog creation
    href string
    Catalog HREF
    id string
    The provider-assigned unique ID for this managed resource.
    isLocal boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists string[]
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    numberOfMedia number
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates number
    (v3.6+) Number of vApp templates available in this catalog.
    ownerName string
    (v3.6+) Owner of the catalog.
    publishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    vappTemplateLists string[]
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    catalog_version float
    (v3.6+) Version number from this catalog.
    created str
    (v3.6+) Date and time of catalog creation
    href str
    Catalog HREF
    id str
    The provider-assigned unique ID for this managed resource.
    is_local bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    is_published bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    is_shared bool
    (v3.6+) Indicates if the catalog is shared.
    media_item_lists Sequence[str]
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    number_of_media float
    (v3.6+) Number of media items available in this catalog.
    number_of_vapp_templates float
    (v3.6+) Number of vApp templates available in this catalog.
    owner_name str
    (v3.6+) Owner of the catalog.
    publish_subscription_type str
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publish_subscription_url str
    (v3.8+) URL to which other catalogs can subscribe.
    vapp_template_lists Sequence[str]
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    catalogVersion Number
    (v3.6+) Version number from this catalog.
    created String
    (v3.6+) Date and time of catalog creation
    href String
    Catalog HREF
    id String
    The provider-assigned unique ID for this managed resource.
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared Boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists List<String>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    numberOfMedia Number
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates Number
    (v3.6+) Number of vApp templates available in this catalog.
    ownerName String
    (v3.6+) Owner of the catalog.
    publishSubscriptionType String
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl String
    (v3.8+) URL to which other catalogs can subscribe.
    vappTemplateLists List<String>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.

    Look up Existing Catalog Resource

    Get an existing Catalog 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?: CatalogState, opts?: CustomResourceOptions): Catalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cache_enabled: Optional[bool] = None,
        catalog_id: Optional[str] = None,
        catalog_version: Optional[float] = None,
        created: Optional[str] = None,
        delete_force: Optional[bool] = None,
        delete_recursive: Optional[bool] = None,
        description: Optional[str] = None,
        href: Optional[str] = None,
        is_local: Optional[bool] = None,
        is_published: Optional[bool] = None,
        is_shared: Optional[bool] = None,
        media_item_lists: Optional[Sequence[str]] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[CatalogMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        number_of_media: Optional[float] = None,
        number_of_vapp_templates: Optional[float] = None,
        org: Optional[str] = None,
        owner_name: Optional[str] = None,
        password: Optional[str] = None,
        preserve_identity_information: Optional[bool] = None,
        publish_enabled: Optional[bool] = None,
        publish_subscription_type: Optional[str] = None,
        publish_subscription_url: Optional[str] = None,
        storage_profile_id: Optional[str] = None,
        vapp_template_lists: Optional[Sequence[str]] = None) -> Catalog
    func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
    public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
    public static Catalog get(String name, Output<String> id, CatalogState state, CustomResourceOptions options)
    resources:  _:    type: vcd:Catalog    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:
    CacheEnabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    CatalogId string
    CatalogVersion double
    (v3.6+) Version number from this catalog.
    Created string
    (v3.6+) Date and time of catalog creation
    DeleteForce bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    DeleteRecursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    Description string
    Description of catalog
    Href string
    Catalog HREF
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    IsShared bool
    (v3.6+) Indicates if the catalog is shared.
    MediaItemLists List<string>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    Metadata Dictionary<string, string>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    MetadataEntries List<CatalogMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    Catalog name
    NumberOfMedia double
    (v3.6+) Number of media items available in this catalog.
    NumberOfVappTemplates double
    (v3.6+) Number of vApp templates available in this catalog.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    OwnerName string
    (v3.6+) Owner of the catalog.
    Password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    PreserveIdentityInformation bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    PublishEnabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    PublishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    PublishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    VappTemplateLists List<string>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    CacheEnabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    CatalogId string
    CatalogVersion float64
    (v3.6+) Version number from this catalog.
    Created string
    (v3.6+) Date and time of catalog creation
    DeleteForce bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    DeleteRecursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    Description string
    Description of catalog
    Href string
    Catalog HREF
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    IsShared bool
    (v3.6+) Indicates if the catalog is shared.
    MediaItemLists []string
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    Metadata map[string]string
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    MetadataEntries []CatalogMetadataEntryArgs
    A set of metadata entries to assign. See Metadata section for details.
    Name string
    Catalog name
    NumberOfMedia float64
    (v3.6+) Number of media items available in this catalog.
    NumberOfVappTemplates float64
    (v3.6+) Number of vApp templates available in this catalog.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    OwnerName string
    (v3.6+) Owner of the catalog.
    Password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    PreserveIdentityInformation bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    PublishEnabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    PublishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    PublishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    VappTemplateLists []string
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    cacheEnabled Boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId String
    catalogVersion Double
    (v3.6+) Version number from this catalog.
    created String
    (v3.6+) Date and time of catalog creation
    deleteForce Boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive Boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description String
    Description of catalog
    href String
    Catalog HREF
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared Boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists List<String>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    metadata Map<String,String>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries List<CatalogMetadataEntry>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    Catalog name
    numberOfMedia Double
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates Double
    (v3.6+) Number of vApp templates available in this catalog.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    ownerName String
    (v3.6+) Owner of the catalog.
    password String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation Boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled Boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    publishSubscriptionType String
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl String
    (v3.8+) URL to which other catalogs can subscribe.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    vappTemplateLists List<String>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    cacheEnabled boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId string
    catalogVersion number
    (v3.6+) Version number from this catalog.
    created string
    (v3.6+) Date and time of catalog creation
    deleteForce boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description string
    Description of catalog
    href string
    Catalog HREF
    isLocal boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists string[]
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    metadata {[key: string]: string}
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries CatalogMetadataEntry[]
    A set of metadata entries to assign. See Metadata section for details.
    name string
    Catalog name
    numberOfMedia number
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates number
    (v3.6+) Number of vApp templates available in this catalog.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    ownerName string
    (v3.6+) Owner of the catalog.
    password string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    publishSubscriptionType string
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl string
    (v3.8+) URL to which other catalogs can subscribe.
    storageProfileId string
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    vappTemplateLists string[]
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    cache_enabled bool
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalog_id str
    catalog_version float
    (v3.6+) Version number from this catalog.
    created str
    (v3.6+) Date and time of catalog creation
    delete_force bool
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    delete_recursive bool
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description str
    Description of catalog
    href str
    Catalog HREF
    is_local bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    is_published bool
    (v3.6+) Indicates if this catalog is shared to all organizations.
    is_shared bool
    (v3.6+) Indicates if the catalog is shared.
    media_item_lists Sequence[str]
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    metadata Mapping[str, str]
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadata_entries Sequence[CatalogMetadataEntryArgs]
    A set of metadata entries to assign. See Metadata section for details.
    name str
    Catalog name
    number_of_media float
    (v3.6+) Number of media items available in this catalog.
    number_of_vapp_templates float
    (v3.6+) Number of vApp templates available in this catalog.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    owner_name str
    (v3.6+) Owner of the catalog.
    password str
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserve_identity_information bool
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publish_enabled bool
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    publish_subscription_type str
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publish_subscription_url str
    (v3.8+) URL to which other catalogs can subscribe.
    storage_profile_id str
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    vapp_template_lists Sequence[str]
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.
    cacheEnabled Boolean
    Enable early catalog export to optimize synchronization. Default is false. It is recommended to set it to true when publishing the catalog.
    catalogId String
    catalogVersion Number
    (v3.6+) Version number from this catalog.
    created String
    (v3.6+) Date and time of catalog creation
    deleteForce Boolean
    When destroying use delete_force=true with delete_recursive=true to remove a catalog and any objects it contains, regardless of their state. Default is false
    deleteRecursive Boolean
    When destroying use delete_recursive=true to remove the catalog and any objects it contains that are in a state that normally allows removal. Default is false
    description String
    Description of catalog
    href String
    Catalog HREF
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    (v3.6+) Indicates if this catalog is shared to all organizations.
    isShared Boolean
    (v3.6+) Indicates if the catalog is shared.
    mediaItemLists List<String>
    (v3.8+) List of media item names in this catalog, in alphabetical order.
    metadata Map<String>
    Use metadata_entry instead. Key value map of metadata to assign.

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    A set of metadata entries to assign. See Metadata section for details.
    name String
    Catalog name
    numberOfMedia Number
    (v3.6+) Number of media items available in this catalog.
    numberOfVappTemplates Number
    (v3.6+) Number of vApp templates available in this catalog.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations. When using a catalog shared from another organization, this field must have the name of that one, not the current one. If you don't know the name of the sharing org, and put the current one, an error message will list the possible names.
    ownerName String
    (v3.6+) Owner of the catalog.
    password String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password.
    preserveIdentityInformation Boolean
    Enable include BIOS UUIDs and MAC addresses in the downloaded OVF package. Preserving the identity information limits the portability of the package, and you should use it only when necessary. Default is false.
    publishEnabled Boolean
    Enable allows to publish a catalog externally to make its vApp templates and media files available for subscription by organizations outside the Cloud Director installation. Default is false.
    publishSubscriptionType String
    (v3.6+) Shows if the catalog is PUBLISHED, if it is a subscription from another one (SUBSCRIBED), or none of those (UNPUBLISHED).
    publishSubscriptionUrl String
    (v3.8+) URL to which other catalogs can subscribe.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog. Note. Data source vcd.getStorageProfile can help to lookup storage profile ID.
    vappTemplateLists List<String>
    (v3.8+) List of vApp template names in this catalog, in alphabetical order.

    Supporting Types

    CatalogMetadataEntry, CatalogMetadataEntryArgs

    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