community.vmware.vmware_content_library_manager – Create, update and delete VMware content library
Note
This plugin is part of the community.vmware collection (version 1.17.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 community.vmware.
To use it in a playbook, specify: community.vmware.vmware_content_library_manager.
Synopsis
Module to manage VMware content Library
Content Library feature is introduced in vSphere 6.0 version, so this module is not supported in the earlier versions of vSphere.
All variables and VMware object names are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
vSphere Automation SDK
Parameters
Parameter |
Comments |
|---|---|
Name of the datastore on which backing content library is created. This is required only if state is set to This parameter is ignored, when state is set to Currently only datastore backing creation is supported. |
|
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 content library description. This is required only if state is set to This parameter is ignored, when state is set to Process of updating content library only allows description change. Default: “” |
|
The name of VMware content library to manage. |
|
The content library type. This is required only if state is set to This parameter is ignored, when state is set to Choices:
|
|
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: 443 |
|
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 SHA1 SSL thumbprint of the subscribed content library to subscribe to. This is required only if library_type is set to This parameter is ignored, when state is set to The information can be extracted using openssl using the following example: |
|
The state of content library. If set to If set to If set to If set to Choices:
|
|
The url of the content library to subscribe to. This is required only if library_type is set to This parameter is ignored, when state is set to |
|
Whether to download all content on demand. If set to If set to This is required only if library_type is set to This parameter is ignored, when state is set to Choices:
|
|
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:
|
Examples
- name: Create Local Content Library
community.vmware.vmware_content_library_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
library_name: test-content-lib
library_description: 'Library with Datastore Backing'
library_type: local
datastore_name: datastore
state: present
delegate_to: localhost
- name: Create Subscribed Content Library
community.vmware.vmware_content_library_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
library_name: test-content-lib
library_description: 'Subscribed Library with Datastore Backing'
library_type: subscribed
datastore_name: datastore
subscription_url: 'https://library.url'
ssl_thumbprint: 'aa:bb:cc:dd:ee:ff:gg:hh:ii:jj:kk:ll:mm:nn:oo:pp:qq:rr:ss:tt'
update_on_demand: true
state: present
delegate_to: localhost
- name: Update Content Library
community.vmware.vmware_content_library_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
library_name: test-content-lib
library_description: 'Library with Datastore Backing'
state: present
delegate_to: localhost
- name: Delete Content Library
community.vmware.vmware_content_library_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
library_name: test-content-lib
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
library creation success and library_id Returned: on success Sample: {“library_description”: “Test description”, “library_id”: “d0b92fa9-7039-4f29-8e9c-0debfcb22b72”, “library_type”: “LOCAL”, “msg”: “Content Library \u0027demo-local-lib-4\u0027 created.”} |
Authors
Pavan Bidkar (@pgbidkar)