vmware.vmware_rest.content_library_subscriptions_info module – Gather information about the subscriptions of a published content library.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.content_library_subscriptions_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about the subscriptions of a published content library, that is, the subscribed libraries that receive content from a given published library.

  • When subscription is provided, return the details of that single subscription, including the subscribed library and the vCenter Server instance and placement where it resides.

  • When subscription is omitted, list every subscription of the published library identified by library.

  • This module is read-only and does not create, modify, or delete any subscriptions.

Parameters

Parameter

Comments

library

string / required

The identifier of the published content library whose subscriptions you want to query.

The value must be the identifier (MOID) of an existing published content library.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

subscription

string

The identifier of a single subscription to retrieve detailed information for.

When omitted, information about all subscriptions of the library is returned.

The value must be the identifier (MOID) of an existing subscription.

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid.

Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all subscriptions of a published library
  vmware.vmware_rest.content_library_subscriptions_info:
    library: e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c
  register: all_subscriptions

- name: Get information about a single subscription
  vmware.vmware_rest.content_library_subscriptions_info:
    library: e6d5c7a1-5a52-4a3b-9c1e-8f0b2d3a4b5c
    subscription: 8b1f0a3d-2c4e-4f6a-9b8c-1d2e3f4a5b6c
  register: my_subscription

- name: Display the subscribed library name
  ansible.builtin.debug:
    var: my_subscription.value.subscribed_library_name

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

The identifier (MOID) of the subscription that was queried.

Returned: When only one subscription, identified by subscription, was queried

Sample: "8b1f0a3d-2c4e-4f6a-9b8c-1d2e3f4a5b6c"

info

list / elements=dictionary

A list of detailed information about all subscriptions of the published library.

Returned: When subscription is not provided

Sample: [{"subscribed_library": "3393956a-43ed-4e7f-bd96-eb39bd604445", "subscribed_library_name": "my_subscribed_library", "subscribed_library_vcenter_hostname": "vcenter.test", "subscription": "8b1f0a3d-2c4e-4f6a-9b8c-1d2e3f4a5b6c"}]

value

dictionary

Detailed information about a single subscription.

Returned: When only one subscription, identified by subscription, was queried

Sample: {"subscribed_library": "3393956a-43ed-4e7f-bd96-eb39bd604445", "subscribed_library_location": "LOCAL", "subscribed_library_name": "my_subscribed_library", "subscribed_library_vcenter": {"hostname": "vcenter.test", "https_port": 443, "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5"}}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)