kubevirt.core.kubevirt_vm_info module – Describe KubeVirt VirtualMachines
Note
This module is part of the kubevirt.core collection (version 1.5.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 kubevirt.core
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: kubevirt.core.kubevirt_vm_info
.
Synopsis
Use the Kubernetes Python client to perform read operations on KubeVirt
VirtualMachines
.Pass options to find
VirtualMachines
as module arguments.Authenticate using either a config file, certificates, password or token.
Supports check mode.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
kubernetes >= 28.1.0
PyYAML >= 3.11
Parameters
Parameter |
Comments |
---|---|
Token used to authenticate with the API. Can also be specified via |
|
Use this to set the API version of KubeVirt. Default: |
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via |
|
Path to a certificate used to authenticate with the API. Can also be specified via |
|
Path to a key file used to authenticate with the API. Can also be specified via |
|
The name of a context found in the config file. Can also be specified via |
|
List of field selectors to use to filter results. Default: |
|
Provide a URL for accessing the API. Can also be specified via |
|
Group(s) to impersonate for the operation. Can also be specified via |
|
Username to impersonate for the operation. Can also be specified via |
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from ~/.kube/config. Can also be specified via Multiple Kubernetes config file can be provided using separator The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0. |
|
List of label selectors to use to filter results. Default: |
|
Specify the name of the |
|
Specify the namespace of |
|
The comma separated list of hosts/domains/IP/CIDR that shouldn’t go through proxy. Can also be specified via Please note that this module does not pick up typical proxy settings from the environment (e.g. This feature requires Example value is |
|
Provide a password for authenticating with the API. Can also be specified via Please read the description of the |
|
Whether or not to save the kube config refresh tokens. Can also be specified via When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file. Disabled by default. Choices:
|
|
The URL of an HTTP proxy to use for the connection. Can also be specified via Please note that this module does not pick up typical proxy settings from the environment (e.g. |
|
The Header used for the HTTP proxy. Documentation can be found here https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers. |
|
Colon-separated username:password for basic authentication header. Can also be specified via |
|
Colon-separated username:password for proxy basic authentication header. Can also be specified via |
|
String representing the user-agent you want, such as foo/1.0. Can also be specified via |
|
Specify whether the This affects the ready condition to wait for. This requires Choices:
|
|
Provide a username for authenticating with the API. Can also be specified via |
|
Whether or not to verify the API server’s SSL certificates. Can also be specified via Choices:
|
|
Whether to wait for the By default this is waiting for the Modify this behavior by setting Choices:
|
|
How long in seconds to wait for the resource to end up in the ready state. Ignored if Default: |
Notes
Note
To avoid SSL certificate validation errors when
validate_certs=yes
, the full certificate chain for the API server must be provided viaca_cert
or in thekubeconfig
file.
Examples
- name: Get an existing VirtualMachine
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
register: default_testvm
- name: Get a list of all VirtualMachines
kubevirt.core.kubevirt_vm_info:
namespace: default
register: vm_list
- name: Get a list of all VirtualMachines from any namespace
kubevirt.core.kubevirt_vm_info:
register: vm_list
- name: Search for all VirtualMachines labelled app=test
kubevirt.core.kubevirt_vm_info:
label_selectors:
- app=test
- name: Wait until the VirtualMachine is running
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
wait: true
- name: Wait until the VirtualMachine is stopped
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
running: false
wait: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the specified Returned: always |
|
The Returned: success |
|
The versioned schema of this representation of an object. Returned: success |
|
Represents the Returned: success |
|
Standard object metadata. Includes name, namespace, annotations, labels, etc. Returned: success |
|
Specific attributes of the Returned: success |
|
Current status details for the Returned: success |