VMware Cloud Director API - AdminCatalog

AdminCatalogType

Element:

AdminCatalog

Type:

AdminCatalogType

Namespace:

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

Description:

Represents the admin view of a catalog.

Since:

1.5

Schema:

vCloudEntities.xsd

Media type(s):

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

Extends:

CatalogType

XML Representation:

<AdminCatalog xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <Owner href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Owner>
    <CatalogItems>
        <CatalogItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </CatalogItems>
    <IsPublished> xs:boolean </IsPublished>
    <IsSharedWithManagedOrgs> xs:boolean </IsSharedWithManagedOrgs>
    <IsSharedWithPeersParentManagedOrgs> xs:boolean </IsSharedWithPeersParentManagedOrgs>
    <DateCreated> xs:dateTime </DateCreated>
    <VersionNumber> xs:long </VersionNumber>
    <DistributedCatalogParams>
        <IsDistributed> xs:boolean </IsDistributed>
        <DistributedCatalogId> xs:string </DistributedCatalogId>
        <OnDeleteAction> xs:string </OnDeleteAction>
        <DistributedCatalogName> xs:string </DistributedCatalogName>
        <BoundAccessLevel> xs:string </BoundAccessLevel>
        <DistributionHealthy> xs:boolean </DistributionHealthy>
        <IsPrimary> xs:boolean </IsPrimary>
    </DistributedCatalogParams>
    <Healthy> xs:boolean </Healthy>
    <CatalogStorageProfiles>
        <VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </CatalogStorageProfiles>
    <ExternalCatalogSubscriptionParams>
        <SubscribeToExternalFeeds> xs:boolean </SubscribeToExternalFeeds>
        <Location> xs:string </Location>
        <Password> xs:string </Password>
        <LocalCopy> xs:boolean </LocalCopy>
        <LibraryId> xs:string </LibraryId>
    </ExternalCatalogSubscriptionParams>
    <PublishExternalCatalogParams>
        <IsPublishedExternally> xs:boolean </IsPublishedExternally>
        <catalogPublishedUrl> xs:string </catalogPublishedUrl>
        <Password> xs:string </Password>
        <IsCacheEnabled> xs:boolean </IsCacheEnabled>
        <PreserveIdentityInfoFlag> xs:boolean </PreserveIdentityInfoFlag>
    </PublishExternalCatalogParams>
</AdminCatalog>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	The URI of the entity.
type	string	No	always	1.5	The MIME type of the entity.
id	string	No	none	1.5	The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey	string	No	create	5.1	Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	1.5	The name of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
CatalogItems	CatalogItemsType	No	always	1.5	Container for CatalogItem elements.
CatalogStorageProfiles	CatalogStorageProfilesType	No	always	5.5	Container for VdcStorageProfile elements that reference storage profiles used by this catalog.
DateCreated	dateTime	No	none	5.1	Creation date and time of the catalog.
Description	string	No	always	1.5	Optional description.
DistributedCatalogParams	DistributedCatalogParamsType	No	always	39.0	Parameters to make a Distributed Catalog. Distributed Catalogs can read/write data only from a special type of storage that enables data synchronization.
ExternalCatalogSubscriptionParams	ExternalCatalogSubscriptionParamsType	No	always	5.5	Configuration parameters for a catalog that has an external subscription.
Healthy	boolean	No	always	39.0	False if the catalog has issues that need further investigation via the issues endpoint for this catalog.
IsPublished	boolean	No	always	1.5	True if the catalog is shared with all organizations in the system not managed by the organization the catalog belongs to. This value is read-only in the user view. To modify it, an administrator must use the publish link in the admin view of the catalog.
IsSharedWithManagedOrgs	boolean	No	always	39.0	True if the catalog is shared with all organizations in the system managed by the organization the catalog belongs to.
IsSharedWithPeersParentManagedOrgs	boolean	No	always	39.0	True if the catalog is shared with all organizations which are managed by the organization the catalog belongs to and all the other sub-provider organizations and non sub-provider tenant organizations.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
Owner	OwnerType	No	none	1.5	Catalog owner.
PublishExternalCatalogParams	PublishExternalCatalogParamsType	No	always	5.5	Configuration parameters for a catalog that is published externally.
Tasks	TasksInProgressType	No	none	1.5	A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VersionNumber	long	No	none	5.5	Represents the current version number of the catalog.

Operations

CRUD	Operation	Description	Since
create	POST /admin/org/{id}/catalogs	Create a catalog.	0.9
read	GET /admin/catalog/{id}	Retrieve a catalog.	0.9
update	PUT /admin/catalog/{id}	Update the name, description storage profiles and distributed catalog settings of a catalog.	0.9
delete	DELETE /admin/catalog/{id}	Delete a catalog.
action	POST /admin/catalog/{id}/action/publish	Publish a catalog.	1.0
action	POST /admin/catalog/{id}/action/publishToExternalOrganizations	Publish a catalog to external orgs.	5.5
action	POST /admin/catalog/{id}/action/subscribeToExternalCatalog	Subscribe to an external catalog.	5.5