Developer Documentation

SubscriptionsCreateSpecSubscribedLibrary

The Subscriptions.CreateSpecSubscribedLibrary structure defines the subscribed library information used to create the subscription.


Properties

Required Property Name Type Description
required location SubscriptionsLocation Enum

Location of the subscribed library relative to the published library.

optional new_subscribed_library SubscriptionsCreateSpecNewSubscribedLibrary

Specification for creating a new subscribed library associated with the subscription. This field is optional and it is only relevant when the value of Subscriptions.CreateSpecSubscribedLibrary.target is CREATE_NEW.

required placement SubscriptionsCreateSpecPlacement

Placement specification for the virtual machine template library items on the subscribed library. This field is currently required. In future, if this is unset, the system will attempt to choose a suitable placement specification for the virtual machine template items; if a placement specification cannot be chosen, publish of virtual machine template items will fail.

optional subscribed_library string

Identifier of the existing subscribed library to associate with the subscription. Only the subscribed libraries for which SubscriptionInfo.subscription-url property is set to the PublishInfo.publish-url of the published library can be associated with the subscription. This field is optional and it is only relevant when the value of Subscriptions.CreateSpecSubscribedLibrary.target is USE_EXISTING. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.

required target CreateSpecSubscribedLibraryTarget Enum

Specifies whether the target subscribed library should be newly created or an existing subscribed library should be used.

optional vcenter SubscriptionsCreateSpecVcenter

Specification for the subscribed library’s vCenter Server instance. This field is optional and it is only relevant when the value of Subscriptions.CreateSpecSubscribedLibrary.location is REMOTE.

Feedback

Was this page helpful?