vmware.vmware_rest.content_library_info module – Gather information about vCenter content libraries.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.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.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about the content libraries defined in vCenter, including local, subscribed, and any other library types.

  • When library_id is provided, return the full details of that single library, such as its name, description, type, storage backings, and publish or subscription settings.

  • When library_id is omitted, list every content library available in the Content Library.

  • This module is read-only and does not create, modify, or delete any libraries.

Parameters

Parameter

Comments

library_id

string

The identifier of the content library to retrieve detailed information for.

When omitted, information about all content libraries is returned.

The value must be the identifier (MOID) of an existing content library.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

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_port

integer

The port number of the vSphere vCenter.

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

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all content libraries
  vmware.vmware_rest.content_library_info:
  register: all_libraries

- name: Get information about a single content library
  vmware.vmware_rest.content_library_info:
    library_id: e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c
  register: my_library

- name: Display the name of the queried library
  ansible.builtin.debug:
    var: my_library.value.name

Return Values

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

Key

Description

id

string

The identifier (MOID) of the content library that was queried.

Returned: When only one library, identified by library_id, was queried

Sample: "e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c"

info

list / elements=dictionary

A list of detailed information about all content libraries.

Returned: When library_id is not provided

Sample: [{"creation_time": "2026-01-15T10:22:00.940Z", "description": "Automated content library", "id": "e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c", "last_modified_time": "2026-01-15T10:22:00.940Z", "name": "my_local_library", "type": "LOCAL", "version": "1"}, {"creation_time": "2026-01-16T08:05:11.134Z", "description": "Mirror of the published library", "id": "3393956a-43ed-4e7f-bd96-eb39bd604445", "last_modified_time": "2026-01-16T08:05:11.134Z", "name": "my_subscribed_library", "type": "SUBSCRIBED", "version": "2"}]

value

dictionary

Detailed information about a single content library.

Returned: When only one library, identified by library_id, was queried

Sample: {"creation_time": "2026-01-15T10:22:00.940Z", "description": "Automated content library", "id": "e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c", "last_modified_time": "2026-01-15T10:22:00.940Z", "name": "my_local_library", "publish_info": {"authentication_method": "NONE", "publish_url": "https://vcenter.test:443/cls/vcsp/lib/e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c/lib.json", "published": true}, "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5", "storage_backings": [{"datastore_id": "datastore-1013", "type": "DATASTORE"}], "type": "LOCAL", "version": "1"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)