vmware.vmware.content_library_item_info module – Gather info about content library items.
Note
This module is part of the vmware.vmware collection (version 1.7.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware.content_library_item_info.
Synopsis
Gather info about content library items, using optional search parameters to refine output.
Content Library feature is introduced in vSphere 6.0 version.
This module does not work with vSphere version older than 67U2.
If neither
library_item_idnorlibrary_item_nameare provided, all items in the relevant libraries will be returned.
Requirements
The below requirements are needed on the host that executes this module.
vSphere Automation SDK
Parameters
Parameter |
Comments |
|---|---|
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The ID of the library to search within. Mutually exclusive with If neither |
|
The ID of the library item for which to search. Mutually exclusive with Also mutually exclusive with If If neither |
|
The ID of the library item for which to search. Mutually exclusive with If If neither |
|
The name of the library to search within. Mutually exclusive with If neither |
|
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable Default: |
|
The connection to protocol. Choices:
|
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules require API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’
Examples
- name: Gather Info About All Library Items
vmware.vmware.content_library_item_info: {}
- name: Gather Info About All Library Items In A Specific Library
vmware.vmware.content_library_item_info:
library_name: My Content Library
- name: Gather Info About A Specific Library Item
vmware.vmware.content_library_item_info:
library_item_id: c453d380-d864-4437-8e9f-b36395e4e629
# The returned info can be manipulated to extract attributes about the items
# For example:
- name: Gather Info About All Items
vmware.vmware.content_library_item_info: {}
register: _lib_items
- name: Get ISO File Names
ansible.builtin.set_fact:
my_iso_files: >-
{{
_lib_items.library_item_info |
selectattr('type', 'equalto', 'iso') |
map(attribute='name')
}}
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A list of dictionaries describing the library items found Returned: on success Sample: |