vmware.vmware_rest.content_subscribedlibrary module – Creates a new subscribed library

Note

This module is part of the vmware.vmware_rest collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.content_subscribedlibrary.

New in vmware.vmware_rest 2.0.0

Synopsis

  • Creates a new subscribed library.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.3 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

client_token

string

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.

creation_time

string

The date and time when this library was created.

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.

description

string

A human-readable description for this library.

This field is optional for the create operation. Leaving it unset during creation will result in an empty string value. It will always be present in the result of a get or list operation. It is optional for the update operation. Leaving it unset during update indicates that the description should be left unchanged.

id

string

An identifier which uniquely identifies this LibraryModel.

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

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.content_library_info.

last_modified_time

string

The date and time when this library was last updated.

This field is updated automatically when the library properties are changed. This field is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this field.

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.

last_sync_time

string

The date and time when this library was last synchronized.

This field applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is unset for a local library.

This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.

library_id

string

Identifier of the subscribed library whose content should be evicted.

The parameter must be the id of a resource returned by vmware.vmware_rest.content_library_info. Required with state=[‘absent’, ‘evict’, ‘present’, ‘sync’]

name

string

The name of the library.

A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique.

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.

optimization_info

dictionary

Defines various optimizations and optimization parameters applied to this library.

This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.

Valid attributes are:

  • 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 field is optional for the create operation. 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 operation. ([‘present’])

publish_info

dictionary

Defines how this library is published so that it can be subscribed to by a remote subscribed library.

The PublishInfo defines where and how the metadata for this local library is accessible. A local library is only published publically if PublishInfo.published is true.

This field is optional for the create and update operations. If not specified during creation, the default is for the library to not be published. If not specified during update, the field is left unchanged.

Valid attributes are:

  • authentication_method (str): This option indicates how a subscribed library should authenticate to the published library endpoint. ([‘present’])

  • Accepted values:

  • BASIC

  • NONE

  • published (bool): Whether the local library is published.

This field is required for the LocalLibrary.create operation. It is optional for the LocalLibrary.update operation, and if unset the value will not be changed. When the existing authentication method is BASIC and the local library is published, the PublishInfo.current-password field is required before turning off publishing. This field will always be present in the results of the LocalLibrary.get operation. ([‘present’])

  • 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 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. ([‘present’])

  • user_name (str): The username to require for authentication.

This field is optional for the LocalLibrary.create and LocalLibrary.update operations. When the authentication method is NONE, 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”. ([‘present’])

  • password (str): The new password to require for authentication.

This field is optional for the LocalLibrary.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 LocalLibrary.update operation. Leaving it unset during update indicates that the password is not changed. When the password is changed, the PublishInfo.current-password field is required. This field is not used for the LocalLibrary.get operation. ([‘present’])

  • current_password (str): The current password to verify. This field is available starting in vSphere 6.7.

This field is unused for the LocalLibrary.create operation. This field is optional for the LocalLibrary.update operation. When the existing authentication method is NONE, the current password can be left unset. When the existing authentication method is BASIC, the current password is verified before applying the new PublishInfo.password, turning off authentication, or unpublishing the library. This field is not used for the LocalLibrary.get operation. ([‘present’])

  • 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 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. ([‘present’])

security_policy_id

string

Represents the security policy applied to this library.

Setting the field will make the library secure. This field is ignored in update operation if LibraryModel.unset-security-policy-id is set to true.

This field is optional for the create and update operations. If not set in create operation, the library will be insecure. If not specified in update operation, the field is left unchanged.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.content_library_info.

server_guid

string

The unique identifier of the vCenter server where the library exists.

This field is optional 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.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_cluster_info.

session_timeout

float

added in vmware.vmware_rest 2.1.0

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

state

string

Choices:

  • "absent"

  • "evict"

  • "present" ← (default)

  • "probe"

  • "sync"

storage_backings

list / elements=dictionary

The list of default storage backings which are available for this library.

A StorageBacking defines a default storage location which can be used to store files for library items in this library. Some library items, for instance, virtual machine template items, support files that may be distributed across various storage backings. One or more item files may or may not be located on the default storage backing.

Multiple default storage locations are not currently supported but may become supported in future releases.

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 not used for the update operation.

Valid attributes are:

  • type (str): This option specifies the type of the StorageBacking. ([‘present’])

  • Accepted values:

  • DATASTORE

  • OTHER

  • datastore_id (str): Identifier of the datastore used to store the content in the library.

This field is optional and it is only relevant when the value of StorageBacking.type is DATASTORE.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_datastore_info. ([‘present’])

  • storage_uri (str): URI identifying the location used to store the content in the library.

The following URI formats are supported:

vSphere 6.5

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

This field is optional and it is only relevant when the value of StorageBacking.type is OTHER. ([‘present’])

subscription_info

dictionary

Defines the subscription behavior for this Library.

The SubscriptionInfo defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting SubscriptionInfo.automatic-sync-enabled to false will halt subscription but will not remove existing cached data.

This field is optional for the create and update operations. If not specified during creation, a default will be created without an active subscription. If not specified during update, the field is left unchanged.

Valid attributes are:

  • authentication_method (str): Indicate how the subscribed library should authenticate with the published library endpoint. ([‘present’, ‘probe’])

  • Accepted values:

  • BASIC

  • NONE

  • automatic_sync_enabled (bool): Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global 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 SubscribedLibrary.sync or SubscribedItem.sync. In other words, manual synchronization is still available even when automatic synchronization is disabled.

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. ([‘present’, ‘probe’])

  • 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 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. ([‘present’, ‘probe’])

  • 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 field is optional for the create operation. It will not be present in the result of the get or list operations. It is optional for the update operation. ([‘present’, ‘probe’])

  • 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 unset. The specified sslThumbprint will not be checked for SSL certificate validation if {SubscriptionInfo#sslCertificate} is also set.

This field is optional for the create operation. It will not be present in the result of the get or list operations. It is optional for the update operation. ([‘present’, ‘probe’])

  • 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

vSphere 6.0

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 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. ([‘present’, ‘probe’])

  • 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 field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation. ([‘present’, ‘probe’])

  • source_info (dict): Information about the source published library. This field will be set for a subscribed library which is associated with a subscription of the published library.

This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation. ([‘present’, ‘probe’])

  • Accepted keys:

  • source_library (string): Identifier of the published library.

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.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.content_library_info.

  • subscription (string): Identifier of the subscription associated with the subscribed library.

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.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.content_library_subscriptions_info.

type

string

The library_type enumerated type defines the type of a LibraryModel.

The type of a library can be used to determine which additional services can be performed with a library.

Choices:

  • "LOCAL"

  • "SUBSCRIBED"

unset_security_policy_id

boolean

This represents the intent of the change to LibraryModel.security-policy-id in update operation.

If this field is set to true, any security policy applied to the library will be removed. If this field is set to false, any security policy applied to library will be changed to the value specified in LibraryModel.security-policy-id, if any.

This field is optional for the update operation. If unset, any existing security policy will be changed to the value specified in LibraryModel.security-policy-id, if any.

Choices:

  • false

  • true

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that runs the module.

If the value is not specified in the task, the value of

environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

version

string

A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data.

This value represents a number which is incremented every time library properties, such as name or description, are changed. It is not incremented by changes to a library item within the library, including adding or removing items. It is also not affected by tagging the library.

This field is not used for the create operation. It will always be present in the result of a get or list operation. It is optional for the update operation. Leaving it unset during update indicates that you do not need to detect concurrent updates.

Notes

Note

  • Tested on vSphere 7.0.3

Examples

- name: Create a content library pointing on a NFS share
  vmware.vmware_rest.content_locallibrary:
    name: my_library_on_nfs
    description: automated
    publish_info:
      published: true
      authentication_method: NONE
    storage_backings:
    - storage_uri: nfs://datastore.test/srv/share/content-library
      type: OTHER
    state: present
  register: nfs_lib

- name: Create subscribed library
  vmware.vmware_rest.content_subscribedlibrary:
    name: sub_lib
    subscription_info:
      subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}'
      authentication_method: NONE
      automatic_sync_enabled: false
      on_demand: true
    storage_backings:
    - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}"
      type: DATASTORE
  register: sub_lib

- name: Create subscribed library (again)
  vmware.vmware_rest.content_subscribedlibrary:
    name: sub_lib
    subscription_info:
      subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}'
      authentication_method: NONE
      automatic_sync_enabled: false
      on_demand: true
    storage_backings:
    - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}"
      type: DATASTORE
  register: result

- name: Clean up the cache
  vmware.vmware_rest.content_subscribedlibrary:
    name: sub_lib
    library_id: '{{ sub_lib.id }}'
    state: evict

- name: Trigger a library sync
  vmware.vmware_rest.content_subscribedlibrary:
    name: sub_lib
    library_id: '{{ sub_lib.id }}'
    state: sync

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Delete all the subscribed libraries

Returned: On success

Sample: "All items completed"

results

list / elements=string

Delete all the subscribed libraries

Returned: On success

Sample: [{"_ansible_item_label": {"creation_time": "2022-11-23T20:06:05.189Z", "description": "", "id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "last_modified_time": "2022-11-23T20:06:05.189Z", "last_sync_time": "2022-11-23T20:06:07.717Z", "name": "sub_lib", "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5", "storage_backings": [{"datastore_id": "datastore-1065", "type": "DATASTORE"}], "subscription_info": {"authentication_method": "NONE", "automatic_sync_enabled": 0, "on_demand": 1, "subscription_url": "https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json"}, "type": "SUBSCRIBED", "version": "4"}, "_ansible_no_log": null, "ansible_loop_var": "item", "changed": 1, "failed": 0, "invocation": {"module_args": {"client_token": null, "creation_time": null, "description": null, "id": null, "last_modified_time": null, "last_sync_time": null, "library_id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "name": null, "optimization_info": null, "publish_info": null, "server_guid": null, "session_timeout": null, "state": "absent", "storage_backings": null, "subscription_info": null, "type": null, "vcenter_hostname": "vcenter.test", "vcenter_password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "vcenter_rest_log_file": "/tmp/vmware_rest.log", "vcenter_username": "administrator@vsphere.local", "vcenter_validate_certs": 0, "version": null}}, "item": {"creation_time": "2022-11-23T20:06:05.189Z", "description": "", "id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "last_modified_time": "2022-11-23T20:06:05.189Z", "last_sync_time": "2022-11-23T20:06:07.717Z", "name": "sub_lib", "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5", "storage_backings": [{"datastore_id": "datastore-1065", "type": "DATASTORE"}], "subscription_info": {"authentication_method": "NONE", "automatic_sync_enabled": 0, "on_demand": 1, "subscription_url": "https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json"}, "type": "SUBSCRIBED", "version": "4"}, "value": {}}]

Authors

  • Ansible Cloud Team (@ansible-collections)