/ home / community / community.vmware / 4.2.0 / module / vmware_content_library_manager

community.vmware.vmware_content_library_manager (4.2.0) — module

Create, update and delete VMware content library

Authors: Pavan Bidkar (@pgbidkar)

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

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

vSphere Automation SDK

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of content library.
    - If set to V(present) and library does not exists, then content library is created.
    - If set to V(present) and library exists, then content library is updated.
    - If set to V(absent) and library exists, then content library is deleted.
    - If set to V(absent) and library does not exists, no action is taken.
    required: false
    type: str

hostname:
    description:
    - The hostname or IP address of the vSphere vCenter server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - The connection to protocol.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

library_name:
    description:
    - The name of VMware content library to manage.
    required: true
    type: str

library_type:
    choices:
    - local
    - subscribed
    default: local
    description:
    - The content library type.
    - This is required only if O(state=resent).
    - This parameter is ignored, when O(state=absent).
    required: false
    type: str

datastore_name:
    aliases:
    - datastore
    description:
    - Name of the datastore on which backing content library is created.
    - This is required if O(state=present).
    - This parameter is ignored, when O(state=absent).
    - Currently only datastore backing creation is supported.
    required: false
    type: str

ssl_thumbprint:
    default: ''
    description:
    - The SHA1 SSL thumbprint of the subscribed content library to subscribe to.
    - This is required if O(library_type=subscribed) and the library is https.
    - This parameter is ignored, when O(state=absent).
    - 'The information can be extracted using openssl using the following example: C(echo
      | openssl s_client -connect test-library.com:443 |& openssl x509 -fingerprint -noout)'
    required: false
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid.
    - Set to V(false) when certificates are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

subscription_url:
    default: ''
    description:
    - The url of the content library to subscribe to.
    - This is required if O(library_type=subscribed).
    - This parameter is ignored, when O(state=absent).
    required: false
    type: str

update_on_demand:
    default: false
    description:
    - Whether to download all content on demand.
    - If set to V(true), all content will be downloaded on demand.
    - If set to V(false) content will be downloaded ahead of time.
    - This is required if O(library_type=subscribed).
    - This parameter is ignored, when O(state=absent).
    type: bool

library_description:
    description:
    - The content library description.
    - This is required only if O(state=present).
    - This parameter is ignored, when O(state=absent).
    - Process of updating content library only allows description change.
    required: false
    type: str

Outputs

content_library_info:
  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 'demo-local-lib-4' created.
  type: dict