/ home / community / community.vmware / 4.2.0 / module / vmware_content_library_info

community.vmware.vmware_content_library_info (4.2.0) — module

Gather information about 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 list the content libraries.

Module to get information about specific 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: Get List of Content Libraries
  community.vmware.vmware_content_library_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Get information about content library
  community.vmware.vmware_content_library_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    library_id: '13b0f060-f4d3-4f84-b61f-0fe1b0c0a5a8'
  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

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

library_id:
description:
- content library id for which details needs to be fetched.
required: false
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

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

Outputs

content_lib_details:
  description: list of content library metadata
  returned: on success
  sample:
  - library_creation_time: '2019-07-02T11:50:52.242000'
    library_description: new description
    library_id: 13b0f060-f4d3-4f84-b61f-0fe1b0c0a5a8
    library_name: demo-local-lib
    library_publish_info:
      authentication_method: NONE
      persist_json_enabled: false
      publish_url: null
      published: false
      user_name: null
    library_server_guid: 0fd5813b-aac7-4b92-9fb7-f18f16565613
    library_type: LOCAL
    library_version: '3'
  type: list
content_libs:
  description: list of content libraries
  returned: on success
  sample:
  - ded9c4d5-0dcd-4837-b1d8-af7398511e33
  - 36b72549-14ed-4b5f-94cb-6213fecacc02
  type: list