vmware.vmware.vcsa_backup_schedule_info module – Gather info about one or more VCSA backup schedules.

Note

This module is part of the vmware.vmware collection (version 2.3.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.

To use it in a playbook, specify: vmware.vmware.vcsa_backup_schedule_info.

Synopsis

  • Gather info about vCenter server appliance backup schedules.

  • If a name is provided, only the schedule with that name will be included in the output.

Parameters

Parameter

Comments

hostname

string

The hostname or IP address of the vSphere vCenter server.

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

name

string

The name of the backup schedule for which to gather info.

If no name is provided, all backup schedules are returned.

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

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

port

integer

The port number of the vSphere vCenter server.

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

Default: 443

proxy_host

string

The 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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

The 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 VMWARE_PROXY_PORT will be used instead.

proxy_protocol

aliases: protocol

string

The proxy connection protocol to use.

This option is used if the correct proxy protocol cannot be automatically determined.

Choices:

  • "http"

  • "https" ← (default)

username

aliases: admin, user

string

The username of the vSphere vCenter server.

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

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

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Gather All Backup Schedules Info
  vmware.vmware.vcsa_backup_schedule_info: {}

- name: Gather The Default Schedule Info
  vmware.vmware.vcsa_backup_schedule_info:
    name: default

Return Values

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

Key

Description

schedules

list / elements=string

List of dictionaries describing the backup schedules found

Returned: On success

Sample: [{"enabled": true, "fast_backup": false, "includes_stats_events_and_tasks": true, "includes_supervisors_control_plane": true, "location": "nfs://10.10.10.10:/nfs/iso_datastore/vcenterbackup/", "location_user": "root", "name": "default", "retain_count": 3, "schedule": {"days_of_week": ["SATURDAY"], "hour": 12, "minute": 59}}]

vcsa

dictionary

Identifying information about the appliance

Returned: always

Sample: {"vcsa": {"hostname": "my-appliance", "port": 443}}

Authors

  • Ansible Cloud Team (@ansible-collections)