vmware_content_library_manager – Create, update and delete VMware content library
- 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.
 
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
- vSphere Automation SDK
 
    
        | Parameter | Choices/Defaults | Comments | 
                
                                                            | datastore_name 
                    string
                                                                 |  | Name of the datastore on which backing content library is created. This is required only if stateis set topresent. This parameter is ignored, when stateis set toabsent. Currently only datastore backing creation is supported. aliases: datastore
 | 
                            
                                                            | 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 VMWARE_HOSTwill be used instead. | 
                            
                                                            | library_description 
                    string
                                                                 | Default: 
 "" | The content library description. This is required only if stateis set topresent. This parameter is ignored, when stateis set toabsent. Process of updating content library only allows description change. | 
                            
                                                            | library_name 
                    string
                                             / required                     |  | The name of VMware content library to manage. | 
                            
                                                            | library_type 
                    string
                                                                 | Choices:
                                                                                                                                                            local ←subscribed | The content library type. This is required only if stateis set topresent. This parameter is ignored, when stateis set toabsent. | 
                            
                                                            | password 
                    string
                                                                 |  | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORDwill be used instead. aliases: pass, pwd
 | 
                            
                                                            | protocol 
                    string
                                                                 |  | The connection to protocol. | 
                            
                                                            | state 
                    string
                                                                 | Choices:
                                                                                                                                                            present ←absent | The state of content library. If set to presentand library does not exists, then content library is created. If set to presentand library exists, then content library is updated. If set to absentand library exists, then content library is deleted. If set to absentand library does not exists, no action is taken. | 
                            
                                                            | username 
                    string
                                                                 |  | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_USERwill be used instead. aliases: admin, user
 | 
                            
                                                            | validate_certs 
                    boolean
                                                                 |  | Allows connection when SSL certificates are not valid. Set to nowhen certificates are not trusted. If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTSwill be used instead. | 
                    
 
Note
- Tested on vSphere 6.5, 6.7
 
 
- name: Create Content Library
  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
    validate_certs: False
    state: present
  delegate_to: localhost
- name: Update Content Library
  vmware_content_library_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    library_name: test-content-lib
    library_description: 'Library with Datastore Backing'
    validate_certs: no
    state: present
  delegate_to: localhost
- name: Delete Content Library
  vmware_content_library_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    library_name: test-content-lib
    validate_certs: no
    state: absent
  delegate_to: localhost
 
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_id': 'd0b92fa9-7039-4f29-8e9c-0debfcb22b72', 'library_description': 'Test description', 'library_type': 'LOCAL', 'msg': "Content Library 'demo-local-lib-4' created."} | 
                    
 
Authors
Hint
If you notice any issues in this documentation, you can edit this document to improve it.