kubevirt.core.kubevirt_vm_info module – Describe KubeVirt VirtualMachines

Note

This module is part of the kubevirt.core collection (version 2.1.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
api_key string	Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
api_version string	Use this to set the API version of KubeVirt. Default: "kubevirt.io/v1"
ca_cert aliases: ssl_ca_cert path	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 K8S_AUTH_SSL_CA_CERT environment variable.
client_cert aliases: cert_file path	Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
client_key aliases: key_file path	Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
context string	The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
field_selectors list / elements=string	List of field selectors to use to filter results. Default: []
host string	Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
impersonate_groups list / elements=string	Group(s) to impersonate for the operation. Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment variable, e.g. Group1,Group2.
impersonate_user string	Username to impersonate for the operation. Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.
kubeconfig any	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 K8S_AUTH_KUBECONFIG environment variable. Multiple Kubernetes config file can be provided using separator ; for Windows platform or : for others platforms. The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.
label_selectors list / elements=string	List of label selectors to use to filter results. Default: []
name string	Specify the name of the VirtualMachine.
namespace string	Specify the namespace of VirtualMachines.
no_proxy string	The comma separated list of hosts/domains/IP/CIDR that shouldn’t go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable. Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY). This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct. Example value is localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16.
password string	Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. Please read the description of the username option for a discussion of when this option is applicable.
persist_config boolean	Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable. 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: false true
proxy string	The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
proxy_headers dictionary	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.
basic_auth string	Colon-separated username:password for basic authentication header. Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.
proxy_basic_auth string	Colon-separated username:password for proxy basic authentication header. Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment variable.
user_agent string	String representing the user-agent you want, such as foo/1.0. Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment variable.
running boolean added in kubevirt.core 1.4.0	Specify whether the VirtualMachine should be running or not. This affects the ready condition to wait for. This requires wait=yes. Choices: false true
username string	Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
validate_certs aliases: verify_ssl boolean	Whether or not to verify the API server’s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. Choices: false true
wait boolean	Whether to wait for the VirtualMachine to end up in the ready state. By default this is waiting for the VirtualMachine to be up and running. Modify this behavior by setting running. Choices: false true
wait_sleep integer	Number of seconds to sleep between checks. Ignored if wait is not set. Default: 5
wait_timeout integer	How long in seconds to wait for the resource to end up in the ready state. Ignored if wait is not set. Default: 120

Notes

Note

• To avoid SSL certificate validation errors when validate_certs=yes, the full certificate chain for the API server must be provided via ca_cert or in the kubeconfig 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
api_found boolean	Whether the specified api_version and VirtualMachine Kind were successfully mapped to an existing API on the target cluster. Returned: always
resources complex	The VirtualMachines that exist. Returned: success
api_version string	The versioned schema of this representation of an object. Returned: success
kind string	Represents the REST resource this object represents. Returned: success
metadata dictionary	Standard object metadata. Includes name, namespace, annotations, labels, etc. Returned: success
spec dictionary	Specific attributes of the VirtualMachine. Can vary based on the api_version. Returned: success
status dictionary	Current status details for the VirtualMachine. Returned: success

Authors

• KubeVirt.io Project

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)
• Report an issue
• Communication