vmware.vmware_rest.content_configuration_info module – Gather information about the global configuration of the vCenter Content Library Service.

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_configuration_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve the service-wide settings that control how the vCenter Content Library Service behaves.

  • These settings include the automatic synchronization schedule for subscribed libraries, the number of concurrent item and file transfers, and the bandwidth used when transferring content.

  • The configuration is a single, global object, so this module always returns one result and takes no selection parameters.

  • Use vmware.vmware_rest.content_configuration to change these settings.

Parameters

Parameter

Comments

session_timeout

float

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

Default: 300.0

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: Gather the Content Library Service configuration
  vmware.vmware_rest.content_configuration_info:
  register: content_config

- name: Show whether automatic synchronization is enabled
  ansible.builtin.debug:
    var: content_config.value.automatic_sync_enabled

Return Values

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

Key

Description

info

list / elements=dictionary

The current global configuration of the Content Library Service, returned as a single-element list.

This mirrors the content of value and is always present for consistency with other info modules.

Returned: On success

Sample: [{"automatic_sync_enabled": true, "automatic_sync_refresh_interval": 240, "automatic_sync_setting_refresh_interval": 600, "automatic_sync_start_hour": 20, "automatic_sync_stop_hour": 7, "maximum_concurrent_item_syncs": 5, "priority_transfer_threads_pool_size": 5, "transfer_nfc_max_concurrent_transfers_per_host": 8, "transfer_threads_pool_size": 20, "transfer_throttling_bandwidth_total": 0}]

value

dictionary

The current global configuration of the Content Library Service.

Returned: On success

Sample: {"automatic_sync_enabled": true, "automatic_sync_refresh_interval": 240, "automatic_sync_setting_refresh_interval": 600, "automatic_sync_start_hour": 20, "automatic_sync_stop_hour": 7, "maximum_concurrent_item_syncs": 5, "priority_transfer_threads_pool_size": 5, "transfer_nfc_max_concurrent_transfers_per_host": 8, "transfer_threads_pool_size": 20, "transfer_throttling_bandwidth_total": 0}

Authors

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