com.vmware.content.subscribed_library

probe

POST /com/vmware/content/subscribed-library?~action=probe

Probes remote library subscription information, including URL, SSL certificate and password. The resulting com.vmware.content.subscribed_library.probe_result structure describes whether or not the subscription configuration is successful.
Request:
Representations:
{
    "subscription_info"{
        "authentication_method""BASIC",
        "automatic_sync_enabled"true,
        "on_demand"true,
        "password""secret string",
        "ssl_thumbprint""string",
        "subscription_url""http://myurl.com",
        "user_name""string"
    }
}
<?xml version="1.0" ?>
<ns0:Probe-Input xmlns:ns0="http://vmware.com/content/subscribed_library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <subscription_info>
    <user_name>string</user_name>
    <ssl_thumbprint>string</ssl_thumbprint>
    <on_demand>true</on_demand>
    <automatic_sync_enabled>true</automatic_sync_enabled>
    <subscription_url>http://myurl.com</subscription_url>
    <authentication_method>BASIC</authentication_method>
    <password>secret string</password>
  </subscription_info>
</ns0:Probe-Input>
POST /com/vmware/content/subscribed-library?~action=probe
&subscription_info.user_name=string
&subscription_info.ssl_thumbprint=string
&subscription_info.on_demand=true
&subscription_info.automatic_sync_enabled=true
&subscription_info.subscription_url=http%3A%2F%2Fmyurl.com
&subscription_info.authentication_method=BASIC
&subscription_info.password=secret+string

Parameters:
Name Type Required Description
subscription_info
 *
subscription_info Yes The subscription info to be probed.

Response:
Representations:
{
    "value"{
        "error_messages"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            }
        ],
        "ssl_thumbprint""string",
        "status""SUCCESS"
    }
}
<?xml version="1.0" ?>
<ns0:Probe-Result xmlns:ns0="http://vmware.com/content/subscribed_library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <ssl_thumbprint>string</ssl_thumbprint>
    <status>SUCCESS</status>
    <error_messages-array>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
    </error_messages-array>
  </value>
</ns0:Probe-Result>

Parameters:
Name Type Required Description
result probe_result Yes The subscription info probe result.

Errors:
None

Copyright © 2014. All Rights Reserved.