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

vcd.SubscribedCatalog

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create SubscribedCatalog Resource

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

    Constructor syntax

    new SubscribedCatalog(name: string, args: SubscribedCatalogArgs, opts?: CustomResourceOptions);
    @overload
    def SubscribedCatalog(resource_name: str,
                          args: SubscribedCatalogArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SubscribedCatalog(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          subscription_url: Optional[str] = None,
                          subscribed_catalog_id: Optional[str] = None,
                          delete_force: Optional[bool] = None,
                          make_local_copy: Optional[bool] = None,
                          name: Optional[str] = None,
                          org: Optional[str] = None,
                          storage_profile_id: Optional[str] = None,
                          store_tasks: Optional[bool] = None,
                          cancel_failed_tasks: Optional[bool] = None,
                          delete_recursive: Optional[bool] = None,
                          sync_all: Optional[bool] = None,
                          subscription_password: Optional[str] = None,
                          sync_all_media_items: Optional[bool] = None,
                          sync_all_vapp_templates: Optional[bool] = None,
                          sync_catalog: Optional[bool] = None,
                          sync_media_items: Optional[Sequence[str]] = None,
                          sync_on_refresh: Optional[bool] = None,
                          sync_vapp_templates: Optional[Sequence[str]] = None)
    func NewSubscribedCatalog(ctx *Context, name string, args SubscribedCatalogArgs, opts ...ResourceOption) (*SubscribedCatalog, error)
    public SubscribedCatalog(string name, SubscribedCatalogArgs args, CustomResourceOptions? opts = null)
    public SubscribedCatalog(String name, SubscribedCatalogArgs args)
    public SubscribedCatalog(String name, SubscribedCatalogArgs args, CustomResourceOptions options)
    
    type: vcd:SubscribedCatalog
    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 SubscribedCatalogArgs
    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 SubscribedCatalogArgs
    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 SubscribedCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscribedCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscribedCatalogArgs
    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 subscribedCatalogResource = new Vcd.SubscribedCatalog("subscribedCatalogResource", new()
    {
        SubscriptionUrl = "string",
        SubscribedCatalogId = "string",
        DeleteForce = false,
        MakeLocalCopy = false,
        Name = "string",
        Org = "string",
        StorageProfileId = "string",
        StoreTasks = false,
        CancelFailedTasks = false,
        DeleteRecursive = false,
        SyncAll = false,
        SubscriptionPassword = "string",
        SyncAllMediaItems = false,
        SyncAllVappTemplates = false,
        SyncCatalog = false,
        SyncMediaItems = new[]
        {
            "string",
        },
        SyncOnRefresh = false,
        SyncVappTemplates = new[]
        {
            "string",
        },
    });
    
    example, err := vcd.NewSubscribedCatalog(ctx, "subscribedCatalogResource", &vcd.SubscribedCatalogArgs{
    	SubscriptionUrl:      pulumi.String("string"),
    	SubscribedCatalogId:  pulumi.String("string"),
    	DeleteForce:          pulumi.Bool(false),
    	MakeLocalCopy:        pulumi.Bool(false),
    	Name:                 pulumi.String("string"),
    	Org:                  pulumi.String("string"),
    	StorageProfileId:     pulumi.String("string"),
    	StoreTasks:           pulumi.Bool(false),
    	CancelFailedTasks:    pulumi.Bool(false),
    	DeleteRecursive:      pulumi.Bool(false),
    	SyncAll:              pulumi.Bool(false),
    	SubscriptionPassword: pulumi.String("string"),
    	SyncAllMediaItems:    pulumi.Bool(false),
    	SyncAllVappTemplates: pulumi.Bool(false),
    	SyncCatalog:          pulumi.Bool(false),
    	SyncMediaItems: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SyncOnRefresh: pulumi.Bool(false),
    	SyncVappTemplates: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var subscribedCatalogResource = new SubscribedCatalog("subscribedCatalogResource", SubscribedCatalogArgs.builder()
        .subscriptionUrl("string")
        .subscribedCatalogId("string")
        .deleteForce(false)
        .makeLocalCopy(false)
        .name("string")
        .org("string")
        .storageProfileId("string")
        .storeTasks(false)
        .cancelFailedTasks(false)
        .deleteRecursive(false)
        .syncAll(false)
        .subscriptionPassword("string")
        .syncAllMediaItems(false)
        .syncAllVappTemplates(false)
        .syncCatalog(false)
        .syncMediaItems("string")
        .syncOnRefresh(false)
        .syncVappTemplates("string")
        .build());
    
    subscribed_catalog_resource = vcd.SubscribedCatalog("subscribedCatalogResource",
        subscription_url="string",
        subscribed_catalog_id="string",
        delete_force=False,
        make_local_copy=False,
        name="string",
        org="string",
        storage_profile_id="string",
        store_tasks=False,
        cancel_failed_tasks=False,
        delete_recursive=False,
        sync_all=False,
        subscription_password="string",
        sync_all_media_items=False,
        sync_all_vapp_templates=False,
        sync_catalog=False,
        sync_media_items=["string"],
        sync_on_refresh=False,
        sync_vapp_templates=["string"])
    
    const subscribedCatalogResource = new vcd.SubscribedCatalog("subscribedCatalogResource", {
        subscriptionUrl: "string",
        subscribedCatalogId: "string",
        deleteForce: false,
        makeLocalCopy: false,
        name: "string",
        org: "string",
        storageProfileId: "string",
        storeTasks: false,
        cancelFailedTasks: false,
        deleteRecursive: false,
        syncAll: false,
        subscriptionPassword: "string",
        syncAllMediaItems: false,
        syncAllVappTemplates: false,
        syncCatalog: false,
        syncMediaItems: ["string"],
        syncOnRefresh: false,
        syncVappTemplates: ["string"],
    });
    
    type: vcd:SubscribedCatalog
    properties:
        cancelFailedTasks: false
        deleteForce: false
        deleteRecursive: false
        makeLocalCopy: false
        name: string
        org: string
        storageProfileId: string
        storeTasks: false
        subscribedCatalogId: string
        subscriptionPassword: string
        subscriptionUrl: string
        syncAll: false
        syncAllMediaItems: false
        syncAllVappTemplates: false
        syncCatalog: false
        syncMediaItems:
            - string
        syncOnRefresh: false
        syncVappTemplates:
            - string
    

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

    SubscriptionUrl string
    The URL to subscribe to the external catalog.
    CancelFailedTasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    MakeLocalCopy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    Name string
    Catalog name
    Org string
    The name of organization to use, optional if defined at provider level.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog.
    StoreTasks bool
    if true, saves the list of tasks to a file for later update.
    SubscribedCatalogId string
    SubscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    SyncAll bool
    If true, synchronise this catalog and all items.
    SyncAllMediaItems bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    SyncAllVappTemplates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    SyncCatalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    SyncMediaItems List<string>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    SyncOnRefresh bool
    Boolean value that shows if sync should be performed on every refresh.
    SyncVappTemplates List<string>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    SubscriptionUrl string
    The URL to subscribe to the external catalog.
    CancelFailedTasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    MakeLocalCopy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    Name string
    Catalog name
    Org string
    The name of organization to use, optional if defined at provider level.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog.
    StoreTasks bool
    if true, saves the list of tasks to a file for later update.
    SubscribedCatalogId string
    SubscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    SyncAll bool
    If true, synchronise this catalog and all items.
    SyncAllMediaItems bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    SyncAllVappTemplates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    SyncCatalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    SyncMediaItems []string
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    SyncOnRefresh bool
    Boolean value that shows if sync should be performed on every refresh.
    SyncVappTemplates []string
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    subscriptionUrl String
    The URL to subscribe to the external catalog.
    cancelFailedTasks Boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    makeLocalCopy Boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    name String
    Catalog name
    org String
    The name of organization to use, optional if defined at provider level.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog.
    storeTasks Boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId String
    subscriptionPassword String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    syncAll Boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems Boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates Boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog Boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems List<String>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh Boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates List<String>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    subscriptionUrl string
    The URL to subscribe to the external catalog.
    cancelFailedTasks boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    makeLocalCopy boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    name string
    Catalog name
    org string
    The name of organization to use, optional if defined at provider level.
    storageProfileId string
    Allows to set specific storage profile to be used for catalog.
    storeTasks boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId string
    subscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    syncAll boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems string[]
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates string[]
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    subscription_url str
    The URL to subscribe to the external catalog.
    cancel_failed_tasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    make_local_copy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    name str
    Catalog name
    org str
    The name of organization to use, optional if defined at provider level.
    storage_profile_id str
    Allows to set specific storage profile to be used for catalog.
    store_tasks bool
    if true, saves the list of tasks to a file for later update.
    subscribed_catalog_id str
    subscription_password str
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    sync_all bool
    If true, synchronise this catalog and all items.
    sync_all_media_items bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    sync_all_vapp_templates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    sync_catalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    sync_media_items Sequence[str]
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    sync_on_refresh bool
    Boolean value that shows if sync should be performed on every refresh.
    sync_vapp_templates Sequence[str]
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    subscriptionUrl String
    The URL to subscribe to the external catalog.
    cancelFailedTasks Boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    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.
    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.
    makeLocalCopy Boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    name String
    Catalog name
    org String
    The name of organization to use, optional if defined at provider level.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog.
    storeTasks Boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId String
    subscriptionPassword String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    syncAll Boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems Boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates Boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog Boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems List<String>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh Boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates List<String>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.

    Outputs

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

    CatalogVersion double
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    Created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    Description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    FailedTasks List<string>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    Href string
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    IsShared bool
    Indicates if the catalog is shared.
    MediaItemLists List<string>
    List of media item names in this catalog, in alphabetical order.
    Metadata Dictionary<string, string>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    NumberOfMedia double
    Number of media items available in this catalog.
    NumberOfVappTemplates double
    Number of vApp templates available in this catalog.
    OwnerName string
    Owner of the catalog.
    PublishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    RunningTasks List<string>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    TasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    VappTemplateLists List<string>
    List of vApp template names in this catalog, in alphabetical order.
    CatalogVersion float64
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    Created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    Description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    FailedTasks []string
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    Href string
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    IsShared bool
    Indicates if the catalog is shared.
    MediaItemLists []string
    List of media item names in this catalog, in alphabetical order.
    Metadata map[string]string
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    NumberOfMedia float64
    Number of media items available in this catalog.
    NumberOfVappTemplates float64
    Number of vApp templates available in this catalog.
    OwnerName string
    Owner of the catalog.
    PublishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    RunningTasks []string
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    TasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    VappTemplateLists []string
    List of vApp template names in this catalog, in alphabetical order.
    catalogVersion Double
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created String
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    description String
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks List<String>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href String
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    isShared Boolean
    Indicates if the catalog is shared.
    mediaItemLists List<String>
    List of media item names in this catalog, in alphabetical order.
    metadata Map<String,String>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    numberOfMedia Double
    Number of media items available in this catalog.
    numberOfVappTemplates Double
    Number of vApp templates available in this catalog.
    ownerName String
    Owner of the catalog.
    publishSubscriptionType String
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks List<String>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    tasksFileName String
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists List<String>
    List of vApp template names in this catalog, in alphabetical order.
    catalogVersion number
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks string[]
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href string
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    isShared boolean
    Indicates if the catalog is shared.
    mediaItemLists string[]
    List of media item names in this catalog, in alphabetical order.
    metadata {[key: string]: string}
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    numberOfMedia number
    Number of media items available in this catalog.
    numberOfVappTemplates number
    Number of vApp templates available in this catalog.
    ownerName string
    Owner of the catalog.
    publishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks string[]
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    tasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists string[]
    List of vApp template names in this catalog, in alphabetical order.
    catalog_version float
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created str
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    description str
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failed_tasks Sequence[str]
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href str
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    is_shared bool
    Indicates if the catalog is shared.
    media_item_lists Sequence[str]
    List of media item names in this catalog, in alphabetical order.
    metadata Mapping[str, str]
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    number_of_media float
    Number of media items available in this catalog.
    number_of_vapp_templates float
    Number of vApp templates available in this catalog.
    owner_name str
    Owner of the catalog.
    publish_subscription_type str
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    running_tasks Sequence[str]
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    tasks_file_name str
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vapp_template_lists Sequence[str]
    List of vApp template names in this catalog, in alphabetical order.
    catalogVersion Number
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created String
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    description String
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks List<String>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href String
    the catalog's Hyper reference.
    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
    Indicates if this catalog is available for subscription. (Always false)
    isShared Boolean
    Indicates if the catalog is shared.
    mediaItemLists List<String>
    List of media item names in this catalog, in alphabetical order.
    metadata Map<String>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    numberOfMedia Number
    Number of media items available in this catalog.
    numberOfVappTemplates Number
    Number of vApp templates available in this catalog.
    ownerName String
    Owner of the catalog.
    publishSubscriptionType String
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks List<String>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    tasksFileName String
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists List<String>
    List of vApp template names in this catalog, in alphabetical order.

    Look up Existing SubscribedCatalog Resource

    Get an existing SubscribedCatalog 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?: SubscribedCatalogState, opts?: CustomResourceOptions): SubscribedCatalog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cancel_failed_tasks: Optional[bool] = None,
            catalog_version: Optional[float] = None,
            created: Optional[str] = None,
            delete_force: Optional[bool] = None,
            delete_recursive: Optional[bool] = None,
            description: Optional[str] = None,
            failed_tasks: Optional[Sequence[str]] = None,
            href: Optional[str] = None,
            is_local: Optional[bool] = None,
            is_published: Optional[bool] = None,
            is_shared: Optional[bool] = None,
            make_local_copy: Optional[bool] = None,
            media_item_lists: Optional[Sequence[str]] = None,
            metadata: Optional[Mapping[str, str]] = 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,
            publish_subscription_type: Optional[str] = None,
            running_tasks: Optional[Sequence[str]] = None,
            storage_profile_id: Optional[str] = None,
            store_tasks: Optional[bool] = None,
            subscribed_catalog_id: Optional[str] = None,
            subscription_password: Optional[str] = None,
            subscription_url: Optional[str] = None,
            sync_all: Optional[bool] = None,
            sync_all_media_items: Optional[bool] = None,
            sync_all_vapp_templates: Optional[bool] = None,
            sync_catalog: Optional[bool] = None,
            sync_media_items: Optional[Sequence[str]] = None,
            sync_on_refresh: Optional[bool] = None,
            sync_vapp_templates: Optional[Sequence[str]] = None,
            tasks_file_name: Optional[str] = None,
            vapp_template_lists: Optional[Sequence[str]] = None) -> SubscribedCatalog
    func GetSubscribedCatalog(ctx *Context, name string, id IDInput, state *SubscribedCatalogState, opts ...ResourceOption) (*SubscribedCatalog, error)
    public static SubscribedCatalog Get(string name, Input<string> id, SubscribedCatalogState? state, CustomResourceOptions? opts = null)
    public static SubscribedCatalog get(String name, Output<String> id, SubscribedCatalogState state, CustomResourceOptions options)
    resources:  _:    type: vcd:SubscribedCatalog    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:
    CancelFailedTasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    CatalogVersion double
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    Created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    Description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    FailedTasks List<string>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    Href string
    the catalog's Hyper reference.
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    Indicates if this catalog is available for subscription. (Always false)
    IsShared bool
    Indicates if the catalog is shared.
    MakeLocalCopy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    MediaItemLists List<string>
    List of media item names in this catalog, in alphabetical order.
    Metadata Dictionary<string, string>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    Name string
    Catalog name
    NumberOfMedia double
    Number of media items available in this catalog.
    NumberOfVappTemplates double
    Number of vApp templates available in this catalog.
    Org string
    The name of organization to use, optional if defined at provider level.
    OwnerName string
    Owner of the catalog.
    PublishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    RunningTasks List<string>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog.
    StoreTasks bool
    if true, saves the list of tasks to a file for later update.
    SubscribedCatalogId string
    SubscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    SubscriptionUrl string
    The URL to subscribe to the external catalog.
    SyncAll bool
    If true, synchronise this catalog and all items.
    SyncAllMediaItems bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    SyncAllVappTemplates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    SyncCatalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    SyncMediaItems List<string>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    SyncOnRefresh bool
    Boolean value that shows if sync should be performed on every refresh.
    SyncVappTemplates List<string>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    TasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    VappTemplateLists List<string>
    List of vApp template names in this catalog, in alphabetical order.
    CancelFailedTasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    CatalogVersion float64
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    Created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    Description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    FailedTasks []string
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    Href string
    the catalog's Hyper reference.
    IsLocal bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    IsPublished bool
    Indicates if this catalog is available for subscription. (Always false)
    IsShared bool
    Indicates if the catalog is shared.
    MakeLocalCopy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    MediaItemLists []string
    List of media item names in this catalog, in alphabetical order.
    Metadata map[string]string
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    Name string
    Catalog name
    NumberOfMedia float64
    Number of media items available in this catalog.
    NumberOfVappTemplates float64
    Number of vApp templates available in this catalog.
    Org string
    The name of organization to use, optional if defined at provider level.
    OwnerName string
    Owner of the catalog.
    PublishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    RunningTasks []string
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    StorageProfileId string
    Allows to set specific storage profile to be used for catalog.
    StoreTasks bool
    if true, saves the list of tasks to a file for later update.
    SubscribedCatalogId string
    SubscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    SubscriptionUrl string
    The URL to subscribe to the external catalog.
    SyncAll bool
    If true, synchronise this catalog and all items.
    SyncAllMediaItems bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    SyncAllVappTemplates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    SyncCatalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    SyncMediaItems []string
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    SyncOnRefresh bool
    Boolean value that shows if sync should be performed on every refresh.
    SyncVappTemplates []string
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    TasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    VappTemplateLists []string
    List of vApp template names in this catalog, in alphabetical order.
    cancelFailedTasks Boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    catalogVersion Double
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created String
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    description String
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks List<String>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href String
    the catalog's Hyper reference.
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    Indicates if this catalog is available for subscription. (Always false)
    isShared Boolean
    Indicates if the catalog is shared.
    makeLocalCopy Boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    mediaItemLists List<String>
    List of media item names in this catalog, in alphabetical order.
    metadata Map<String,String>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    name String
    Catalog name
    numberOfMedia Double
    Number of media items available in this catalog.
    numberOfVappTemplates Double
    Number of vApp templates available in this catalog.
    org String
    The name of organization to use, optional if defined at provider level.
    ownerName String
    Owner of the catalog.
    publishSubscriptionType String
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks List<String>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog.
    storeTasks Boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId String
    subscriptionPassword String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    subscriptionUrl String
    The URL to subscribe to the external catalog.
    syncAll Boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems Boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates Boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog Boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems List<String>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh Boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates List<String>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    tasksFileName String
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists List<String>
    List of vApp template names in this catalog, in alphabetical order.
    cancelFailedTasks boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    catalogVersion number
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created string
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    description string
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks string[]
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href string
    the catalog's Hyper reference.
    isLocal boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished boolean
    Indicates if this catalog is available for subscription. (Always false)
    isShared boolean
    Indicates if the catalog is shared.
    makeLocalCopy boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    mediaItemLists string[]
    List of media item names in this catalog, in alphabetical order.
    metadata {[key: string]: string}
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    name string
    Catalog name
    numberOfMedia number
    Number of media items available in this catalog.
    numberOfVappTemplates number
    Number of vApp templates available in this catalog.
    org string
    The name of organization to use, optional if defined at provider level.
    ownerName string
    Owner of the catalog.
    publishSubscriptionType string
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks string[]
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    storageProfileId string
    Allows to set specific storage profile to be used for catalog.
    storeTasks boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId string
    subscriptionPassword string
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    subscriptionUrl string
    The URL to subscribe to the external catalog.
    syncAll boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems string[]
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates string[]
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    tasksFileName string
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists string[]
    List of vApp template names in this catalog, in alphabetical order.
    cancel_failed_tasks bool
    When true, the subscribed catalog will attempt canceling failed tasks.
    catalog_version float
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created str
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    description str
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failed_tasks Sequence[str]
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href str
    the catalog's Hyper reference.
    is_local bool
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    is_published bool
    Indicates if this catalog is available for subscription. (Always false)
    is_shared bool
    Indicates if the catalog is shared.
    make_local_copy bool
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    media_item_lists Sequence[str]
    List of media item names in this catalog, in alphabetical order.
    metadata Mapping[str, str]
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    name str
    Catalog name
    number_of_media float
    Number of media items available in this catalog.
    number_of_vapp_templates float
    Number of vApp templates available in this catalog.
    org str
    The name of organization to use, optional if defined at provider level.
    owner_name str
    Owner of the catalog.
    publish_subscription_type str
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    running_tasks Sequence[str]
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    storage_profile_id str
    Allows to set specific storage profile to be used for catalog.
    store_tasks bool
    if true, saves the list of tasks to a file for later update.
    subscribed_catalog_id str
    subscription_password str
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    subscription_url str
    The URL to subscribe to the external catalog.
    sync_all bool
    If true, synchronise this catalog and all items.
    sync_all_media_items bool
    If true, synchronise all media items. Not to be used when sync_all is set.
    sync_all_vapp_templates bool
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    sync_catalog bool
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    sync_media_items Sequence[str]
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    sync_on_refresh bool
    Boolean value that shows if sync should be performed on every refresh.
    sync_vapp_templates Sequence[str]
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    tasks_file_name str
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vapp_template_lists Sequence[str]
    List of vApp template names in this catalog, in alphabetical order.
    cancelFailedTasks Boolean
    When true, the subscribed catalog will attempt canceling failed tasks.
    catalogVersion Number
    Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
    created String
    Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
    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.
    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.
    description String
    Description of catalog. This is inherited from the publishing catalog and updated on sync.
    failedTasks List<String>
    List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
    href String
    the catalog's Hyper reference.
    isLocal Boolean
    (v3.8.1+) Indicates if this catalog was created in the current organization.
    isPublished Boolean
    Indicates if this catalog is available for subscription. (Always false)
    isShared Boolean
    Indicates if the catalog is shared.
    makeLocalCopy Boolean
    If true, subscription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalog items unless a sync operation is performed. It can only be false if the user configured in the provider is the System administrator.
    mediaItemLists List<String>
    List of media item names in this catalog, in alphabetical order.
    metadata Map<String>
    (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
    name String
    Catalog name
    numberOfMedia Number
    Number of media items available in this catalog.
    numberOfVappTemplates Number
    Number of vApp templates available in this catalog.
    org String
    The name of organization to use, optional if defined at provider level.
    ownerName String
    Owner of the catalog.
    publishSubscriptionType String
    Shows if the catalog is published, if it is a subscription from another one or none of those. (Always SUBSCRIBED)
    runningTasks List<String>
    List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
    storageProfileId String
    Allows to set specific storage profile to be used for catalog.
    storeTasks Boolean
    if true, saves the list of tasks to a file for later update.
    subscribedCatalogId String
    subscriptionPassword String
    An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
    subscriptionUrl String
    The URL to subscribe to the external catalog.
    syncAll Boolean
    If true, synchronise this catalog and all items.
    syncAllMediaItems Boolean
    If true, synchronise all media items. Not to be used when sync_all is set.
    syncAllVappTemplates Boolean
    If true, synchronise all vApp templates. Not to be used when sync_all is set.
    syncCatalog Boolean
    If true, synchronise this catalog. Not to be used when sync_all is set. This operation fetches the list of items. If make_local_copy is set, it also synchronises all the items.
    syncMediaItems List<String>
    Synchronise a list of media items. Not to be used when sync_all or sync_all_media_items are set.
    syncOnRefresh Boolean
    Boolean value that shows if sync should be performed on every refresh.
    syncVappTemplates List<String>
    Synchronise a list of vApp templates. Not to be used when sync_all or sync_all_vapp_templates are set.
    tasksFileName String
    Where the running tasks IDs have been stored. Only if store_tasks is set.
    vappTemplateLists List<String>
    List of vApp template names in this catalog, in alphabetical order.

    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