scale_computing.hypercore.task_wait module – Wait for a HyperCore TaskTag to be finished.

Note

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

To install it, use: ansible-galaxy collection install scale_computing.hypercore.

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

New in scale_computing.hypercore 1.0.0

Synopsis

  • A helper module, which waits until the object with a given task_tag is actually created/updated/deleted .

  • Used within a context of a larger role. Whenever POST, PATCH or DELETE method is applied on the HyperCore object, a dict with keys createdUUID and taskTag is returned. Depending on taskTag’s status, the object’s request might be still in queue or may be already executed. This module ensures that the object’s request is not on queue anymore, and execution is finished.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

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.

task_tag

dictionary / required

Result when calling POST, PATCH or DELETE method on the HyperCore object.

Examples

- name: Wait for the object to be created
  scale_computing.hypercore.task_wait:
    task_tag:
      createdUUID: c2d38319-db6b-4cdf-93c6-d628b47c7809
      taskTag: 1483

Authors

  • Tjaž Eržen (@tjazsch)