VMware Cloud Director API - ExternalCatalogSubscriptionParams

ExternalCatalogSubscriptionParamsType

Element:

ExternalCatalogSubscriptionParams

Type:

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Configuration parameters for a catalog that has an external subscription.

Since:

5.5

Schema:

vCloudEntities.xsd

Media type(s):

application/vnd.vmware.admin.externalCatalogSubscriptionParams+xml
application/vnd.vmware.admin.externalCatalogSubscriptionParams+json

Extends:

VCloudExtensibleType

XML Representation:

<ExternalCatalogSubscriptionParams xmlns="http://www.vmware.com/vcloud/v1.5">
    <SubscribeToExternalFeeds> xs:boolean </SubscribeToExternalFeeds>
    <Location> xs:string </Location>
    <Password> xs:string </Password>
    <LocalCopy> xs:boolean </LocalCopy>
    <LibraryId> xs:string </LibraryId>
</ExternalCatalogSubscriptionParams>

Elements

Element	Type	Required	Modifiable	Since	Description
LibraryId	string	No	always	31.0	When library exists locally, include library id
LocalCopy	boolean	No	always	5.5	If true, subcription to a catalog creates a local copy of all items. Defaults to false, which does not create a local copy of catalogItems unless sync operation is performed.
Location	string	No	always	5.5	Endpoint URL to subscribe to.
Password	string	No	always	5.5	Password required when connecting to the endpoint. Passing in six asterisks '******' indicates to keep current password. Passing in null or empty string indicates to remove password.
SubscribeToExternalFeeds	boolean	No	always	5.5	True enables the external subscription configured by these parameters.
VCloudExtension	VCloudExtensionType	No	always	5.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /admin/catalog/{id}/action/subscribeToExternalCatalog	Subscribe to an external catalog.	5.5