kubevirt.core.kubevirt_vm module – Create or delete 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
.
Synopsis
Use the Kubernetes Python client to perform create or delete operations on KubeVirt VirtualMachines.
Pass options to create the VirtualMachine 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
jsonpatch
Parameters
Parameter |
Comments |
---|---|
Specify annotations to set on the Only used when |
|
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 |
|
Specify the See https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec |
|
Configure behavior when deleting an object. Only used when |
|
Specify condition that must be met for delete to proceed. |
|
Specify the resource version of the target object. |
|
Specify the |
|
Use to control how dependent objects are deleted. If not specified, the default policy for the object type will be used. This may vary across object types. Choices:
|
|
If set to Choices:
|
|
Specify the basis of the Only used when Mutually exclusive with |
|
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 |
|
Specify the Only used when |
|
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. |
|
Specify labels to set on the |
|
Specify the name of the This option is ignored when Mutually exclusive with |
|
Specify the namespace of the |
|
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:
|
|
Specify the Only used when |
|
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 Choices:
|
|
Specify the template spec of the See https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec |
|
Determines if an object should be created, patched, or deleted. When set to If set to If set to 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 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: Create a VirtualMachine
kubevirt.core.kubevirt_vm:
state: present
name: testvm
namespace: default
labels:
app: test
instancetype:
name: u1.medium
preference:
name: fedora
spec:
domain:
devices:
interfaces:
- name: default
masquerade: {}
- name: bridge-network
bridge: {}
networks:
- name: default
pod: {}
- name: bridge-network
multus:
networkName: kindexgw
volumes:
- containerDisk:
image: quay.io/containerdisks/fedora:latest
name: containerdisk
- cloudInitNoCloud:
userData: |-
#cloud-config
# The default username is: fedora
ssh_authorized_keys:
- ssh-ed25519 AAAA...
name: cloudinit
- name: Create a VirtualMachine with a DataVolume template
kubevirt.core.kubevirt_vm:
state: present
name: testvm-with-dv
namespace: default
labels:
app: test
instancetype:
name: u1.medium
preference:
name: fedora
data_volume_templates:
- metadata:
name: testdv
spec:
source:
registry:
url: docker://quay.io/containerdisks/fedora:latest
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 5Gi
spec:
domain:
devices: {}
volumes:
- dataVolume:
name: testdv
name: datavolume
- cloudInitNoCloud:
userData: |-
#cloud-config
# The default username is: fedora
ssh_authorized_keys:
- ssh-ed25519 AAAA...
name: cloudinit
wait: true
- name: Delete a VirtualMachine
kubevirt.core.kubevirt_vm:
name: testvm
namespace: default
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The created object. Will be empty in the case of a deletion. Returned: success |
|
Whether the Returned: success Sample: |
|
Method executed on the Kubernetes API. Returned: success |