ansible.builtin.vmware_content_library_manager (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

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

• python >= 2.6
• PyVmomi
• vSphere Automation SDK

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

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 C(VMWARE_PORT)
      will be used instead.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of content library.
    - If set to C(present) and library does not exists, then content library is created.
    - If set to C(present) and library exists, then content library is updated.
    - If set to C(absent) and library exists, then content library is deleted.
    - If set to C(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 C(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 C(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 C(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 C(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str
    version_added: 1.12.0
    version_added_collection: community.vmware

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 C(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int
    version_added: 1.12.0
    version_added_collection: community.vmware

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 C(state) is set to C(present).
    - This parameter is ignored, when C(state) is set to C(absent).
    required: false
    type: str

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

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

library_description:
    default: ''
    description:
    - The content library description.
    - This is required only if C(state) is set to C(present).
    - This parameter is ignored, when C(state) is set to C(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