Probe Content Subscribed Library
Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibrary.ProbeResult structure describes whether or not the subscription configuration is successful. if you do not have all of the privileges described as follows:
- Operation execution requires ContentLibrary.ProbeSubscription.
Show optional properties
{
"subscription_info": {}
}{
"subscription_info": {
"authentication_method": "string",
"automatic_sync_enabled": false,
"on_demand": false,
"password": "string",
"ssl_thumbprint": "string",
"subscription_url": "string",
"user_name": "string",
"source_info": {
"source_library": "string",
"subscription": "string"
}
}
}The subscription info probe result.
{
"status": "string",
"ssl_thumbprint": "string",
"error_messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
}
]
}The SubscribedLibrary.ProbeResult.Status enumerated type defines the error status constants for the probe result.
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 in SubscriptionInfo.ssl-thumbprint is invalid. In this case, the returned #sslThumbprint should be set in SubscriptionInfo.ssl-thumbprint.
UNKNOWN_ERROR : Indicates an unspecified error different from the other error cases defined in SubscribedLibrary.ProbeResult.Status.
The SSL thumbprint for the remote endpoint. A SSL thumbprint is only returned if the host is secured with SSL/TLS.
If the probe result is in an error status, this field will contain the detailed error messages.
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
{
"messages": [
"Std_LocalizableMessage Object"
],
"data": {},
"error_type": "string"
}Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.
Some operations will not set this field when reporting errors.
Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"subscription_info":"{}"}' https://{api_host}/api/content/subscribed-library?action=probe
# Module 'VMware.Sdk.vSphere.Content'
$LibrarySourceInfo = Initialize-LibrarySourceInfo -SourceLibrary "MySourceLibrary" -Subscription "MySubscription"$LibrarySubscriptionInfo = Initialize-LibrarySubscriptionInfo -AuthenticationMethod "BASIC" -AutomaticSyncEnabled $false -OnDemand $false -Password "MyPassword" -SslThumbprint "MySslThumbprint" -SubscriptionUrl "MySubscriptionUrl" -UserName "MyUserName" -SourceInfo $LibrarySourceInfo$SubscribedLibraryProbeRequestBody = Initialize-SubscribedLibraryProbeRequestBody -SubscriptionInfo $LibrarySubscriptionInfoInvoke-ProbeContentSubscribedLibrary -SubscribedLibraryProbeRequestBody $SubscribedLibraryProbeRequestBody