scale_computing.hypercore.vm_info module – Retrieve information about the VMs.
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.vm_info
.
New in scale_computing.hypercore 1.0.0
Synopsis
Retrieve information about all or single VM present on the cluster.
Parameters
Parameter |
Comments |
---|---|
Scale Computing HyperCore instance information. |
|
Select login method. If not set, the value of the 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:
|
|
The HyperCore instance URL. If not set, the value of the For example “https://10.1.2.3:443”. |
|
Password used for authentication. If not set, the value of the |
|
Timeout in seconds for the connection with the Scale Computing HyperCore API instance. If not set, the value of the |
|
Username used for authentication. If not set, the value of the |
|
VM’s name. Serves as unique identifier across endpoint VirDomain. If specified, the VM with that name will get returned. Otherwise, all VMs are going to get returned. |
Examples
- name: Retrieve specific VM
scale_computing.hypercore.vm_info:
vm_name: demo-vm
register: result
- name: Retrieve all VMs.
scale_computing.hypercore.vm_info:
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of VMs records. Returned: success |
|
Bootable disks or nics, in the order that they will boot Returned: success Sample: |
|
Human-readable description Returned: success Sample: |
|
Attached virtual block devices Returned: success Sample: |
|
Attached virtual network devices Returned: success Sample: |
|
VM’s node affinity strategy Returned: success Sample: |
|
VM’s power state Returned: success Sample: |
|
UUID of source VM if this VM is a replicated VM. Empty string is returned if this VM is not replicated. Returned: success Sample: |
|
Name identifier of a snapshot schedule for automated snapshots Returned: success Sample: |
|
User-modifiable words for organizing a group of VMs Returned: success Sample: |
|
Unique identifier Returned: success Sample: |
|
Number of allotted virtual CPUs Returned: success Sample: |
|
Human-readable virtual machine name Returned: success Sample: |