vmware.vmware_rest.content_configuration module – Updates the configuration

Note

This module is part of the vmware.vmware_rest collection (version 4.2.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in vmware.vmware_rest 2.0.0

Synopsis

  • Updates the configuration. The update is incremental. Any field in the ConfigurationModel structure that is unset will not be modified. Note that this update 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

Comments

automatic_sync_enabled

boolean

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 SubscriptionInfo.automatic-sync-enabled flag turned on will be synchronized every hour between ConfigurationModel.automatic-sync-start-hour and ConfigurationModel.automatic-sync-stop-hour.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

Choices:

  • false

  • true

automatic_sync_start_hour

integer

The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

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.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

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.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

session_timeout

float

added in vmware.vmware_rest 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" ← (default)

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 runs 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

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

  • 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

Description

id

dictionary

moid of the resource

Returned: On success

value

dictionary

Turn on the autmatic syncrhronization

Returned: On success

Sample: {"automatic_sync_enabled": 1, "automatic_sync_start_hour": 20, "automatic_sync_stop_hour": 7, "maximum_concurrent_item_syncs": 5}

Authors

  • Ansible Cloud Team (@ansible-collections)