scale_computing.hypercore.snapshot_schedule_info module – Retrieve information about an automated VM snapshot schedule.

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

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 scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.snapshot_schedule_info.

New in scale_computing.hypercore 1.0.0

Synopsis

  • Retrieve information about an automated VM snapshot schedule on HyperCore API endpoint /rest/v1/VirDomainSnapshotSchedule.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

name

string

Snapshot schedule’s name.

If specified, specific snapshot schedule is going to be obtained.

Otherwise, all snapshot schedules are going to be listed.

See Also

See also

scale_computing.hypercore.snapshot_schedule

Manage snap schedule to configure the desired schedule of snapshot creation.

Examples

- name: List specific snapshot schedule
  scale_computing.hypercore.snapshot_schedule_info:
    name: demo-snap-schedule
  register: result

- name: List all snapshot schedules
  scale_computing.hypercore.snapshot_schedule_info:
  register: result

Return Values

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

Key

Description

records

list / elements=dictionary

List of VM’s snapshot schedules from the HyperCore API endpoint /rest/v1/VirDomainSnapshotSchedule.

Returned: success

name

string

Human-readable snapshot schedule name

Returned: success

Sample: "demo-snap-schedule"

recurrences

list / elements=dictionary

Snapshot scheduling rules

Returned: success

Sample: {"frequency": "FREQ=WEEKLY;INTERVAL=1;BYDAY=TU", "local_retention": 1296000, "name": "weekly-tuesday", "remote_retention": 3024000, "replication": true, "start": "2010-01-01 00:00:00"}

uuid

string

Unique identifier

Returned: success

Sample: "74df5b47-c468-4626-a7e4-34eca13b2f81"

Authors

  • Tjaž Eržen (@tjazsch)