Library_Subscriptions_CreateSpecSubscribedLibrary

Library_Subscriptions_CreateSpecSubscribedLibrary
Library_Subscriptions_CreateSpecSubscribedLibrary

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

JSON Example
{
    "target": "string",
    "new_subscribed_library": {
        "name": "string",
        "description": "string",
        "storage_backings": [
            {
                "type": "string",
                "datastore_id": "string",
                "storage_uri": "string"
            }
        ],
        "automatic_sync_enabled": false,
        "on_demand": false
    },
    "subscribed_library": "string",
    "location": "string",
    "vcenter": {
        "hostname": "string",
        "https_port": 0
    },
    "placement": {
        "folder": "string",
        "cluster": "string",
        "resource_pool": "string",
        "host": "string",
        "network": "string"
    }
}
target
Required

The Subscriptions.CreateSpecSubscribedLibrary.Target enumerated type defines the options related to the target subscribed library which will be associated with the subscription.
CREATE_NEW : Create a new subscribed library.
USE_EXISTING : Use the specified existing subscribed library.

new_subscribed_library
Optional

The Subscriptions.CreateSpecNewSubscribedLibrary structure defines the information required to create a new subscribed library.

string
subscribed_library
Optional

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.

location
Required

The Subscriptions.Location enumerated type defines the location of subscribed library relative to the published library.
LOCAL : The subscribed library belongs to the same vCenter instance as the published library.
REMOTE : The subscribed library belongs to a different vCenter instance than the published library.

vcenter
Optional

The Subscriptions.CreateSpecVcenter structure defines information about the vCenter Server instance where the subscribed library associated with the subscription exists or will be created.

placement
Required

The Subscriptions.CreateSpecPlacement structure defines the placement information for the subscribed library's virtual machine template library items. Storage location of the virtual machine template items is defined by the subscribed library's storage backing. This placement information needs to be compatible with the subscribed library's storage backing. The Subscriptions.CreateSpecPlacement structure is only applicable for the virtual machine template library items of the subscribed library.