community.vmware.vmware_content_library_manager – Create, update and delete VMware content library
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.7.0).
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 | Choices/Defaults | Comments |
---|---|---|
datastore_name string |
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.
| |
hostname string |
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable | |
library_description string |
Default: "" |
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. |
library_name string / required |
The name of VMware content library to manage. | |
library_type string |
|
The content library type. This is required only if state is set to This parameter is ignored, when state is set to |
password string |
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable
| |
port integer |
Default: 443 |
The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable |
protocol string |
|
The connection to protocol. |
ssl_thumbprint string added in 1.7.0 of community.vmware |
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: | |
state string |
|
The state of content library. If set to If set to If set to If set to |
subscription_url string added in 1.7.0 of community.vmware |
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 | |
update_on_demand boolean added in 1.7.0 of community.vmware |
|
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 |
username string |
The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable |
Notes
Note
- Tested on vSphere 6.5, 6.7, and 7.0
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 | Returned | Description |
---|---|---|
content_library_info dictionary |
on success |
library creation success and library_id
Sample: {'library_description': 'Test description', 'library_id': 'd0b92fa9-7039-4f29-8e9c-0debfcb22b72', 'library_type': 'LOCAL', 'msg': "Content Library 'demo-local-lib-4' created."} |
Authors
- Pavan Bidkar (@pgbidkar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_content_library_manager_module.html