VMware Cloud Director API - PublishExternalCatalogParams

VMware Cloud Director API - PublishExternalCatalogParams

PublishExternalCatalogParamsType

Element:
PublishExternalCatalogParams
Type:
PublishExternalCatalogParamsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Configuration parameters for a catalog that is published externally.
Since:
5.5
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.publishExternalCatalogParams+xml
application/vnd.vmware.admin.publishExternalCatalogParams+json
Extends:
VCloudExtensibleType
XML Representation:
<PublishExternalCatalogParams xmlns="http://www.vmware.com/vcloud/v1.5">
    <IsPublishedExternally> xs:boolean </IsPublishedExternally>
    <catalogPublishedUrl> xs:string </catalogPublishedUrl>
    <Password> xs:string </Password>
    <IsCacheEnabled> xs:boolean </IsCacheEnabled>
    <PreserveIdentityInfoFlag> xs:boolean </PreserveIdentityInfoFlag>
</PublishExternalCatalogParams>

Elements

Element Type Required Modifiable Since Deprecated Description
IsCacheEnabled boolean No always 5.5 True enables content caching for this catalog. All items in the catalog are created and stored in transfer storage. If false, items are not placed in transfer storage until they are requested by a subscriber. Note that access to this attribute is reserved to users with role that includes the right 'Catalog: VCSP Publish Subscribe Caching'.
IsPublishedExternally boolean No always 5.5 True enables external publication as configured by these parameters.
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.
PreserveIdentityInfoFlag boolean No always 5.5 True includes BIOS UUIDs and MAC addresses in the downloaded OVF package. If false, those information will be excluded.
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.
catalogPublishedUrl string No always 5.5 Read-only endpoint URL supplied by the server. External subscribers can connect to the catalog at this URL.

Operations

CRUD Operation Description Since Deprecated
as input POST /admin/catalog/{id}/action/publishToExternalOrganizations Publish a catalog to external orgs. 5.5