content subscribed library: probe
Request Body Structure:
"password": "secret string",
Request Body Parameters:
|bold = required|
|subscription_info||subscription_info||The subscription info to be probed.|
|subscription_info.authentication_method||string||Indicate how the subscribed library should authenticate (
BASIC: Require HTTP Basic authentication matching a specified username and password.
NONE: Require no authentication.Optional. This field must be provided for the
|subscription_info.automatic_sync_enabled||boolean||Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global content.configuration_model.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 sync or sync. In other words, manual synchronization is still available even when automatic synchronization is disabled. Optional. This field must be provided for the
|subscription_info.on_demand||boolean||Indicates whether a library item's content will be synchronized only on demand.
If this is set to
Items without synchronized content can be forcefully synchronized in advance using the sync call with
If this value is set to
|subscription_info.password||secret||The password to use when authenticating.
The password must be set when using a password-based authentication method; empty strings are not allowed.Optional. This field is optional for the
|subscription_info.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.Optional. This field is optional for the
|subscription_info.subscription_url||URI||The URL of the endpoint where the metadata for the remotely published library is being served.
This URL can be the content.library.publish_info.publish_url of the published library (for example, https://server/path/lib.json).
If the source content comes from a published library with content.library.publish_info.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:
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 content.library.storage_backing.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.Optional. This field must be provided for the
|subscription_info.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.Optional. This field is optional for the
HTTP Status Code: 200
|bold = required|
|value||probe_result||The subscription info probe result.|
|value.status||string||The status of probe result. This will be one of
SUCCESS: Indicates that the probe was successful.
INVALID_URL: Indicates that the supplied URL was not valid.
TIMED_OUT: Indicates that the probe timed out while attempting to connect to the URL.
HOST_NOT_FOUND: Indicates that the host in the URL could not be found.
RESOURCE_NOT_FOUND: Indicates that the given resource at the URL was not found.
INVALID_CREDENTIALS: Indicates that the connection was rejected due to invalid credentials.
CERTIFICATE_ERROR: Indicates that the provided server certificate thumbprint in content.library.subscription_info.ssl_thumbprint is invalid. In this case, the returned #sslThumbprint should be set in content.library.subscription_info.ssl_thumbprint.
UNKNOWN_ERROR: Indicates an unspecified error different from the other error cases defined in content.subscribed_library.probe_result.status.
|value.ssl_thumbprint||string||The SSL thumbprint for the remote endpoint. Optional. An SSL thumbprint is only returned if the host is secured with SSL/TLS.|
|value.error_messages||localizable_message||If the probe result is in an error status, this field will contain the detailed error messages.|
|value.error_messages.id||string||Unique identifier of the localizable string or message template.
This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
|value.error_messages.default_message||string||The value of this localizable string or message template in the
|value.error_messages.args||string||Arguments to be substituted into a message template.|