vmware.vmware_rest.content_configuration_module.rst

vmware.vmware_rest.content_configuration

Updates the configuration

Version added: 2.0.0

Synopsis

• Updates the configuration. The update is incremental. Any {@term field} in the {@link ConfigurationModel} {@term structure} that is {@term unset} will not be modified. Note that this update {@term operation} doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

Requirements

The below requirements are needed on the host that executes this module.

• vSphere 7.0.3 or greater
• python >= 3.6
• aiohttp

Parameters

Parameter	Choices/Defaults	Comments
automatic_sync_enabled boolean	Choices: no yes	Whether automatic synchronization is enabled. When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the subscription_info.automaticSyncEnabled flag turned on will be synchronized every hour between {@link #automaticSyncStartHour} and {@link #automaticSyncStopHour}.
automatic_sync_start_hour integer		The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive.
automatic_sync_stop_hour integer		The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive.
maximum_concurrent_item_syncs integer		The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity. This setting is global across all subscribed libraries.
session_timeout float added in 2.1.0		Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s.
state string	Choices: present ←
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_rest_log_file string		You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that run the module. 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	Choices: no yes ←	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.

Notes

Note

- Tested on vSphere 7.0.3

Examples

- name: Turn on the autmatic syncrhronization
  vmware.vmware_rest.content_configuration:
    automatic_sync_enabled: true

Return Values

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

Key	Returned	Description
id dictionary	On success	moid of the resource
value dictionary	On success	Turn on the autmatic syncrhronization Sample: {'automatic_sync_enabled': 1, 'automatic_sync_start_hour': 20, 'automatic_sync_stop_hour': 7, 'maximum_concurrent_item_syncs': 5}

Status

Authors

• Ansible Cloud Team (@ansible-collections)