Developer Documentation

LibrarySubscriptionInfo

The SubscriptionInfo structure defines the subscription behavior for a subscribed library.


Properties

Required Property Name Type Description
optional authentication_method SubscriptionInfoAuthenticationMethod Enum

Indicate how the subscribed library should authenticate (AuthenticationMethod) with the published library endpoint. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional automatic_sync_enabled boolean

Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global ConfigurationModel.automatic-sync-enabled option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to SubscribedLibrary.sync or SubscribedItem.sync. In other words, manual synchronization is still available even when automatic synchronization is disabled. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional on_demand boolean

Indicates whether a library item’s content will be synchronized only on demand. If this is set to true, then the library item’s metadata will be synchronized but the item’s content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.

Items without synchronized content can be forcefully synchronized in advance using the SubscribedItem.sync call with forceSyncContent set to true. Once content has been synchronized, the content can removed with the SubscribedItem.evict call.

If this value is set to false, all content will be synchronized in advance.

This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional password string

The password to use when authenticating. The password must be set when using a password-based authentication method; empty strings are not allowed.

This field is optional for the create operation. It will not be present in the result of the get or list operations. It is optional for the update operation.

optional source_info LibrarySourceInfo

Information about the source published library. This field will be set for a subscribed library which is associated with a subscription of the published library. This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.

optional ssl_thumbprint string

An optional SHA-1 hash of the SSL certificate for the remote endpoint. If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is unset.

This field is optional for the create operation. It will not be present in the result of the get or list operations. It is optional for the update operation.

optional subscription_url string

The URL of the endpoint where the metadata for the remotely published library is being served. This URL can be the PublishInfo.publish-url of the published library (for example, https://server/path/lib.json).

If the source content comes from a published library with PublishInfo.persist-json-enabled, the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:

vSphere 6.5

  • ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
  • nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
  • nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
  • smb://server/path/mylibrary/lib.json (for SMB server)

vSphere 6.0

  • file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
  • file:///path/mylibrary/lib.json (for local file system)

When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the StorageBacking.storage-uri of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.

This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional user_name string

The username to use when authenticating. The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.

This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.

Feedback

Was this page helpful?