Content APIs
The Content namespace provides schemas and resources for configuring global settings and permissions, and for managing libraries in the Content Library Service.
The Content Configuration resource provides operations to configure the global settings of the Content Library Service.
The configuration settings are used by the Content Library Service to control the behavior of various operations.
The Content Library resource manages general library functionalities.
The Content Library resource provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this resource will not affect the properties specific to the type of library. See also Content LocalLibrary and Content SubscribedLibrary.
The Content Library Item resource provides operations for managing library items.
The Content Library Item Changes resource provides operations to get a history of the content changes made to a library item.
This resource was added in vSphere API 6.9.1.
The Content Library Item DownloadSession resource manipulates download sessions, which are used to download content from the Content Library Service.
A download session is an object that tracks the download of content (that is, downloading content from the Content Library Service) and acts as a lease to keep the download links available.
The Content Library Item Downloadsession File resource provides access to the download links.
The Content Library Item Downloadsession File resource provides operations for accessing files within a download session.
After a download session is created against a library item, the Content Library Item Downloadsession File resource can be used to retrieve all downloadable content within the library item. Since the content may not be available immediately in a downloadable form on the server side, the client will have to prepare the file and wait for the file status to become Content Library Item Downloadsession File PrepareStatus.PREPARED.
See Content Library Item DownloadSession.
The Content Library Item File resource can be used to query for information on the files within a library item. Files are objects which are added to a library item through the Content Library Item UpdateSession and Content Library Item Updatesession File resources.
Content Library Item Storage is a resource that represents a specific instance of a file stored on a storage backing. Unlike Content Library Item File, which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in Content Library Item File, but will be represented multiple times (once for each storage backing) in Content Library Item Storage. The Content Library Item Storage resource provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.
The Content Library Item UpdateSession resource manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item.
An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific Content Library ItemModel, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.
Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
The management of the files within the session is done through the Content Library Item Updatesession File resource.
The Content Library Item Updatesession File resource provides operations for accessing files within an update session.
After an update session is created against a library item, the Content Library Item Updatesession File resource can be used to make changes to the underlying library item metadata as well as the content of the files. The following changes can be made:
- deleting an existing file within the library item. This deletes both the metadata and the content.
- updating an existing file with new content.
- adding a new file to the library item.
The above changes are not applied or visible until the session is completed. See Content Library Item UpdateSession.
The Content Library SubscribedItem resource manages the unique features of library items that are members of a subscribed library.
The Content Library Subscriptions resource provides operations for managing the subscription information of the subscribers of a published library.
This resource was added in vSphere API 6.7.2.
The Content LocalLibrary resource manages local libraries.
The Content LocalLibrary resource provides support for creating and maintaining local library instances. A local library may also use the Content Library resource to manage general library functionality.
The Content SecurityPolicies resource provides operations to manage security policies. A policy can be applied to a content library.
This resource was added in vSphere API 7.0.3.0.
The Content TrustedCertificates resource provides operations to create, modify, delete and read trusted certificates.
This resource was added in vSphere API 7.0.3.0.
The Content Type resource exposes the Content Library ItemModel types that this Content Library Service supports.
A library item has an optional type which can be specified with the Content Library ItemModel.type property. For items with a type that is supported by a plugin, the Content Library Service may understand the files which are part of the library item and can produce metadata for the item.
In other cases, uploads may require a process in which one upload implies subsequent uploads. For example, an Open Virtualization Format (OVF) package is composed of an OVF descriptor file and the associated virtual disk files. Uploading an OVF descriptor can enable the Content Library Service to understand that the complete OVF package requires additional disk files, and it can set up the transfers for the disks automatically by adding the file entries for the disks when the OVF descriptor is uploaded.
When a type is not supported by a plugin, or the type is not specified, the Content Library Service can handle a library item in a default way, without adding metadata to the item or guiding the upload process.