### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »

# content Package

## `content` Package

## `library_client` Module

The Content Library module provides classes and classes for defining and managing the library’s items, subscription, publication, and storage.

class `com.vmware.content.library_client.``Item`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Item` class provides methods for managing library items.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FindSpec`(name=None, library_id=None, source_id=None, type=None, cached=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Item.FindSpec` class specifies the properties that can be used as a filter to find library items. When multiple attributes are specified, all properties of the item must match the specification.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str` or `None`) – The name of the library item. The name is case-insensitive. See `ItemModel.name`. If not specified all library item names are searched. library_id (`str` or `None`) – The identifier of the library containing the item. See `ItemModel.library_id`. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.Library`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.Library`. If not specified all libraries are searched. source_id (`str` or `None`) – The identifier of the library item as reported by the publisher. See `ItemModel.source_id`. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.library.Item`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.library.Item`. If not specified all library items are searched. type (`str` or `None`) – The type of the library item. The type is case-insensitive. See `ItemModel.type`. If not specified all types are searched. cached (`bool` or `None`) – Whether the item is cached. Possible values are ‘true’ or ‘false’. See `ItemModel.cached`. If not specified all library items are searched.

  `Item.``RESOURCE_TYPE` = 'com.vmware.content.library.Item'

    Resource type for item.

  `Item.``copy`(source_library_item_id, destination_create_spec, client_token=None)

    Copies a library item.

    Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.

    If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.

    > A library item cannot be copied into a subscribed library.

    Parameters: | client_token (`str` or `None`) – A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example: `b8a2a2e3-2314-43cd-a871-6ede0f429751`. This token can be used to guarantee idempotent copy. If not specified copy is not idempotent. source_library_item_id (`str`) – Identifier of the existing library item from which the content will be copied. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. destination_create_spec (`ItemModel`) – Specification for the new library item to be created.
    Return type: | `str`
    Returns: | The identifier of the new library item into which the content is being copied. The return value will be an identifier for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library item with `source_library_item_id` does not exist, or if the library referenced by the `ItemModel.library_id` property of `destination_create_spec` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if one of the following is true for the new library item: name is empty name exceeds 80 characters description exceeds 1024 characters
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `client_token` does not conform to the UUID format.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the `ItemModel.library_id` property of `destination_create_spec` refers to a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if the copy operation failed because the source or destination library item is not accessible.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `source_library_item_id` requires `System.Read`. The resource `com.vmware.content.Library` referenced by the attribute `ItemModel.library_id` requires `ContentLibrary.AddLibraryItem`.

  `Item.``create`(create_spec, client_token=None)

    Creates a new library item.

    A new library item is created without any content. After creation, content can be added through the `com.vmware.content.library.item_client.UpdateSession` and `com.vmware.content.library.item.updatesession_client.File` classes.

    > A library item cannot be created in a subscribed library.

    Parameters: | client_token (`str` or `None`) – A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: `b8a2a2e3-2314-43cd-a871-6ede0f429751`. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent. create_spec (`ItemModel`) – Specification that defines the properties of the new library item.
    Return type: | `str`
    Returns: | Identifier of the new library item. The return value will be an identifier for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the `ItemModel.library_id` property of `create_spec` refers to a library that does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if one of the following is true for the new library item: name is empty name exceeds 80 characters description exceeds 1024 characters
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `client_token` does not conform to the UUID format.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the `ItemModel.library_id` property of `destinationCreateSpec` refers to a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the attribute `ItemModel.library_id` requires `ContentLibrary.AddLibraryItem`.

  `Item.``delete`(library_item_id)

    Deletes a library item.

    This method will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

    This method cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

    Parameters: | library_item_id (`str`) – Identifier of the library item to delete. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library item with the given `library_item_id` is a member of a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library item with the specified `library_item_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `library_item_id` requires `ContentLibrary.DeleteLibraryItem`.

  `Item.``find`(spec)

    Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested `Item.FindSpec`.

    Parameters: | spec (`Item.FindSpec`) – Specification describing what properties to filter on.
    Return type: | `list` of `str`
    Returns: | The `list` of identifiers of all the visible library items matching the given `spec`. The return value will contain identifiers for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if no properties are specified in the `spec`.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `com.vmware.content.Library` referenced by the attribute `Item.FindSpec.library_id` requires `System.Read`.

  `Item.``get`(library_item_id)

    Returns the `ItemModel` with the given identifier.

    Parameters: | library_item_id (`str`) – Identifier of the library item to return. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`.
    Return type: | `ItemModel`
    Returns: | The `ItemModel` instance with the given `library_item_id`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if no item with the given `library_item_id` exists.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `library_item_id` requires `System.Read`.

  `Item.``list`(library_id)

    Returns the identifiers of all items in the given library.

    Parameters: | library_id (`str`) – Identifier of the library whose items should be returned. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Return type: | `list` of `str`
    Returns: | The `list` of identifiers of the items in the library specified by `library_id`. The return value will contain identifiers for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library associated with `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `System.Read`.

  `Item.``update`(library_item_id, update_spec)

    Updates the specified properties of a library item.

    This is an incremental update to the library item. Attributes that are None in the update specification are left unchanged.

    This method cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

    Parameters: | library_item_id (`str`) – Identifier of the library item to update. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. update_spec (`ItemModel`) – Specification of the properties to set.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library item specified by `library_item_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library item corresponding to `library_item_id` is a member of a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if one of the following is true for the `update_spec`: name is empty name exceeds 80 characters description exceeds 1024 characters version is not equal to the current version of the library item
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `library_item_id` requires `ContentLibrary.UpdateLibraryItem`.

class `com.vmware.content.library_client.``ItemModel`(id=None, library_id=None, content_version=None, creation_time=None, description=None, last_modified_time=None, last_sync_time=None, metadata_version=None, name=None, cached=None, size=None, type=None, version=None, source_id=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `ItemModel` class represents a library item that has been stored in a library.

  A `ItemModel` represents a single logical unit to be managed within a `com.vmware.content_client.LibraryModel`. Items contain the actual content of a library, and their placement within a library determines policies that affect that content such as publishing.

  A library item can have a specified type, indicated with the `ItemModel.type` attribute. This property is associated with a Content Library Service plugin that supports specific types and provides additional services. The types available in a specific Content Library Service can be queried using the `com.vmware.content_client.Type` class. Items of an unknown or unspecified type are treated generically. Because subscribed library catalogs are synchronized as is, subscribing to a remote Content Library Service effectively gives you a library with the functionality of the remote service’s type adapter plugins, even if they are not installed locally.

  Items can be managed using the `Item` class and, for items in subscribed libraries, the `SubscribedItem` class.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | id (`str`) – A unique identifier for this library item. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.library.Item`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.library.Item`. This attribute is not used for the `create` method. It will not be present in the return value of the `get` or `list` methods. It is not used for the `update` method. library_id (`str`) – The identifier of the `com.vmware.content_client.LibraryModel` to which this item belongs. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.Library`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.Library`. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. content_version (`str`) – The version of the file content list of this library item. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. creation_time (`datetime.datetime`) – The date and time when this library item was created. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. description (`str`) – A human-readable description for this library item. This attribute is optional for the `create` method. Leaving it None during creation will result in an empty string value. It will always be present in the result of a `get` or `list` method. It is optional for the `update` method. Leaving it None during update indicates that the description remains unchanged. last_modified_time (`datetime.datetime`) – The date and time when the metadata for this library item was last changed. This attribute is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. last_sync_time (`datetime.datetime`) – The date and time when this library item was last synchronized. This attribute is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is None for a library item that belongs to a local library. This attribute is not used for the `create` method. It is optional in the return value of the `get` or `list` methods. It is not used for the `update` method. metadata_version (`str`) – A version number for the metadata of this library item. This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. name (`str`) – A human-readable name for this library item. The name may not be None or an empty string. The name does not have to be unique, even within the same library. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. cached (`bool`) – The status that indicates whether the library item is on disk or not. The library item is cached when all its files are on disk. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. size (`long`) – The library item size, in bytes. The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0. This attribute is not used for the `create` method. It is optional in the return value of the `get` or `list` methods. It is not used for the `update` method. type (`str`) – An optional type identifier which indicates the type adapter plugin to use. This attribute may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item. The types and plugins supported by the Content Library Service can be queried using the `com.vmware.content_client.Type` class. This attribute is optional for the `create` and `update` methods. During creation, if the type is left unspecified, or if the type is specified but does not have a corresponding type support plugin, then the type of the library item is considered to be generic and all data is treated as generic files. During update, if the type is not specified, then it is not updated. version (`str`) – A version number that is updated on metadata changes. This value is used to validate update requests to provide optimistic concurrency of changes. This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item. This attribute is not used for the `create` method. It will always be present in the result of a `get` or `list` method. It is optional for the `update` method. Leaving it None during update indicates that you do not need to detect concurrent updates. source_id (`str`) – The identifier of the `ItemModel` to which this item is synchronized to if the item belongs to a subscribed library. The value is None for a library item that belongs to a local library. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.library.Item`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.library.Item`. This attribute is not used for the `create` method. It is optional in the return value of the `get` or `list` methods. It is not used for the `update` method.

class `com.vmware.content.library_client.``OptimizationInfo`(optimize_remote_publishing=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `OptimizationInfo` class defines different optimizations and optimization parameters applied to particular library.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | optimize_remote_publishing (`bool`) – If set to `true` then library would be optimized for remote publishing. Turn it on if remote publishing is dominant use case for this library. Remote publishing means here that publisher and subscribers are not the part of the same `Vcenter` SSO domain. Any optimizations could be done as result of turning on this optimization during library creation. For example, library content could be stored in different format but optimizations are not limited to just storage format. Note, that value of this toggle could be set only during creation of the library and you would need to migrate your library in case you need to change this value (optimize the library for different use case). This attribute is optional for the `create` method. If not specified for the `create`, the default is for the library to not be optmized for specific use case. It is not used for the `update` method.

class `com.vmware.content.library_client.``PublishInfo`(authentication_method=None, published=None, publish_url=None, user_name=None, password=None, persist_json_enabled=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `PublishInfo` class defines how a local library is published publicly for synchronization to other libraries.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | authentication_method (`PublishInfo.AuthenticationMethod`) – Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. published (`bool`) – Whether the local library is published. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. publish_url (`str`) – The URL to which the library metadata is published by the Content Library Service. This value can be used to set the `SubscriptionInfo.subscription_url` property when creating a subscribed library. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. user_name (`str`) – The username to require for authentication. This attribute is optional for the `create` and `update` method. When the authentication is not required, the username can be left None. 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 (`str`) – The password to require for authentication. This attribute is optional for the `create` method. When the authentication method is `PublishInfo.AuthenticationMethod.NONE`, the password can be left None. When the authentication method is `PublishInfo.AuthenticationMethod.BASIC`, the password should be a non-empty string. This attribute is optional for the `update` method. Leaving it None during update indicates that the password is not changed. This attribute is not used for the `get` or `list` method. persist_json_enabled (`bool`) – 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 `SubscriptionInfo.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. This attribute is optional for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method.

  class `AuthenticationMethod`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `PublishInfo.AuthenticationMethod` class indicates how a subscribed library should authenticate to the published library endpoint.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `AuthenticationMethod` instance.

    `BASIC` = AuthenticationMethod(string=u'BASIC')

      Require HTTP Basic authentication matching a specified username and password.

    `NONE` = AuthenticationMethod(string=u'NONE')

      Require no authentication.

class `com.vmware.content.library_client.``StorageBacking`(type=None, datastore_id=None, storage_uri=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `StorageBacking` class defines a storage location where content in a library will be stored. The storage location can either be a Datastore or Other type.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | type (`StorageBacking.Type`) – Type (DATASTORE, OTHER) of `StorageBacking`. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. datastore_id (`str`) – Identifier of the datastore used to store the content in the library. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Datastore`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Datastore`. This attribute is optional and it is only relevant when the value of `type` is `StorageBacking.Type.DATASTORE`. storage_uri (`str`) – URI identifying the location used to store the content in the library. The following URI formats are supported: vSphere 6.5 nfs://server/path?version=4 (for vCenter Server Appliance only) - Specifies an NFS Version 4 server. nfs://server/path (for vCenter Server Appliance only) - Specifies an NFS Version 3 server. The nfs://server:/path format is also supported. smb://server/path - Specifies an SMB server or Windows share. vSphere 6.0 Update 1 nfs://server:/path (for vCenter Server Appliance only) file://unc-server/path (for vCenter Server for Windows only) file:///mount/point (for vCenter Server Appliance only) - Local file URIs are supported only when the path is a local mount point for an NFS file system. Use of file URIs is strongly discouraged. Instead, use an NFS URI to specify the remote file system. vSphere 6.0 nfs://server:/path (for vCenter Server Appliance only) file://unc-server/path (for vCenter Server for Windows only) file:///path - Local file URIs are supported but strongly discouraged because it may interfere with the performance of vCenter Server. This attribute is optional and it is only relevant when the value of `type` is `StorageBacking.Type.OTHER`.

  class `Type`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `StorageBacking.Type` class specifies the type of the `StorageBacking`.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `Type` instance.

    `DATASTORE` = Type(string=u'DATASTORE')

      The content of the library will be stored on a datastore.

      These are vCenter Server managed datastores, and are logical containers that hide specifics of each storage device. Depending on the type of storage you use, datastores can be backed by the following file system formats:

      - Virtual Machine File System (VMFS)
      - Network File System (NFS)
    `OTHER` = Type(string=u'OTHER')

      The content of the library will be stored on a remote file system.

      > Supports the following remote file systems:

      - NFS (on vCenter Server Appliance)
      - SMB (on vCenter Server Appliance and vCenter Server for Windows)

class `com.vmware.content.library_client.``SubscribedItem`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `SubscribedItem` class manages the unique features of library items that are members of a subscribed library.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  `evict`(library_item_id)

    Evicts the cached content of a library item in a subscribed library.

    This method allows the cached content of a library item to be removed to free up storage capacity. This method will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set `ItemModel.cached` to false.

    Parameters: | library_item_id (`str`) – Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library item specified by `library_item_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library item specified by `library_item_id` is not a member of a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementConfiguration` if the library item specified by `library_item_id` is a member of a subscribed library that does not synchronize on-demand.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `library_item_id` requires `ContentLibrary.EvictLibraryItem`.

  `sync`(library_item_id, force_sync_content)

    Forces the synchronization of an individual library item in a subscribed library.

    Synchronizing an individual item will update that item’s metadata from the remote source. If the source library item on the remote library has been deleted, this method will delete the library item from the subscribed library as well.

    The default behavior of the synchronization is determined by the `SubscriptionInfo` of the library which owns the library item.

    - If `SubscriptionInfo.on_demand` is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the `force_sync_content` parameter.
    - If `SubscriptionInfo.on_demand` is false, then this call will always synchronize the file content. The `force_sync_content` parameter is ignored when the subscription is not on-demand.

    When the file content has been synchronized, the `ItemModel.cached` attribute will be true.

    This method will return immediately and create an asynchronous task to perform the synchronization.

    Parameters: | library_item_id (`str`) – Identifier of the library item to synchronize. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. force_sync_content (`bool`) – Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library item specified by `library_item_id` could not be found.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library item specified by `library_item_id` is not a member of a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.library.Item` referenced by the parameter `library_item_id` requires `ContentLibrary.SyncLibraryItem`.

class `com.vmware.content.library_client.``SubscriptionInfo`(authentication_method=None, automatic_sync_enabled=None, on_demand=None, password=None, ssl_thumbprint=None, subscription_url=None, user_name=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `SubscriptionInfo` class defines the subscription behavior for a subscribed library.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | authentication_method (`SubscriptionInfo.AuthenticationMethod`) – Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. automatic_sync_enabled (`bool`) – Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global `com.vmware.content_client.ConfigurationModel.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 `com.vmware.content_client.SubscribedLibrary.sync()` or `SubscribedItem.sync()`. In other words, manual synchronization is still available even when automatic synchronization is disabled. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. on_demand (`bool`) – Indicates whether a library item’s content will be synchronized only on demand. If this is set to `true`, then the library item’s metadata will be synchronized but the item’s content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay. Items without synchronized content can be forcefully synchronized in advance using the `SubscribedItem.sync()` call with `forceSyncContent` set to true. Once content has been synchronized, the content can removed with the `SubscribedItem.evict()` call. If this value is set to `false`, all content will be synchronized in advance. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. password (`str`) – The password to use when authenticating. The password must be set when using a password-based authentication method; empty strings are not allowed. This attribute is optional for the `create` method. It will not be present in the return value of the `get` or `list` methods. It is optional for the `update` method. ssl_thumbprint (`str`) – 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 None. This attribute is optional for the `create` method. It will not be present in the return value of the `get` or `list` methods. It is optional for the `update` method. subscription_url (`str`) – The URL of the endpoint where the metadata for the remotely published library is being served. This URL can be the `PublishInfo.publish_url` of the published library (for example, https://server/path/lib.json). If the source content comes from a published library with `PublishInfo.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: vSphere 6.5 ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore) nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance) nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance) smb://server/path/mylibrary/lib.json (for SMB server) vSphere 6.0 file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows) file:///path/mylibrary/lib.json (for local file system) 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 `StorageBacking.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. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. user_name (`str`) – The username to use when authenticating. The username must be set when using a password-based authentication method. Empty strings are allowed for usernames. This attribute is optional for the `create` method. It is optional in the return value of the `get` or `list` methods. It is optional for the `update` method.

  class `AuthenticationMethod`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    Indicate how the subscribed library should authenticate with the published library endpoint.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `AuthenticationMethod` instance.

    `BASIC` = AuthenticationMethod(string=u'BASIC')

      Require HTTP Basic authentication matching a specified username and password.

    `NONE` = AuthenticationMethod(string=u'NONE')

      Require no authentication.

## Subpackages

- library Package
  - `library` Package
  - `item_client` Module
  - Subpackages
    - item Package
      - `item` Package
      - `downloadsession_client` Module
      - `updatesession_client` Module

### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »