1. Types
  2. content
  3. library

content library: publish info

The publish_info structure defines how a local library is published publicly for synchronization to other libraries.

Representations:

{
    "authentication_method": "BASIC",
    "password": "secret string",
    "persist_json_enabled": true,
    "publish_url": "http://myurl.com",
    "published": true,
    "user_name": "string"
}
<?xml version="1.0" ?>
<ns0:PublishInfo xmlns:ns0="http://vmware.com/content/library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <user_name>string</user_name>
  <publish_url>http://myurl.com</publish_url>
  <authentication_method>BASIC</authentication_method>
  <published>true</published>
  <persist_json_enabled>true</persist_json_enabled>
  <password>secret string</password>
</ns0:PublishInfo>

Attributes:

Name Type Description
Optional
authentication_method string Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.

Indicates how a subscribed library should authenticate to the published library endpoint. Value is one of:
BASIC: Require HTTP Basic authentication matching a specified username and password.
NONE: Require no authentication.Optional. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
published boolean Whether the local library is published.

Optional. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
publish_url URI The URL to which the library metadata is published by the Content Library Service.

This value can be used to set the content.library.subscription_info.subscription_url property when creating a subscribed library.

Optional. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
user_name string The username to require for authentication.

Optional. This field is optional for the create and update operation. When the authentication is not required, the username can be left unset. When the authentication method is basic, the username is ignored in the current release. It defaults to "vcsp". It is preferable to leave this unset. If specified, it must be set to "vcsp".
password secret The password to require for authentication.

Optional. This field is optional for the create operation. When the authentication method is NONE, the password can be left unset. When the authentication method is BASIC, the password should be a non-empty string. This field is optional for the update operation. Leaving it unset during update indicates that the password is not changed. This field is not used for the get or list operation.
persist_json_enabled boolean Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.

Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the content.library.subscription_info.subscription_url. When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.

For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.

For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.

Optional. This field is optional for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.