kubevirt.core.kubevirt_vm_info 模块 – 描述 KubeVirt 虚拟机

注意

此模块是 kubevirt.core 集合 (版本 2.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install kubevirt.core。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定： kubevirt.core.kubevirt_vm_info。

概要

• 使用 Kubernetes Python 客户端对 KubeVirt VirtualMachines 执行读取操作。

• 传递选项以查找 VirtualMachines 作为模块参数。

• 使用配置文件、证书、密码或令牌进行身份验证。

• 支持检查模式。

要求

执行此模块的主机需要以下要求。

• python >= 3.9

• kubernetes >= 28.1.0

• PyYAML >= 3.11

参数

参数	注释
api_key 字符串	用于向 API 进行身份验证的令牌。 也可以通过 K8S_AUTH_API_KEY 环境变量指定。
api_version 字符串	用于设置 KubeVirt 的 API 版本。 默认值： "kubevirt.io/v1"
ca_cert 别名：ssl_ca_cert 路径	用于向 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链，以避免证书验证错误。 也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。
client_cert 别名：cert_file 路径	用于向 API 进行身份验证的证书的路径。 也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。
client_key 别名：key_file 路径	用于向 API 进行身份验证的密钥文件的路径。 也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。
context 字符串	配置文件中找到的上下文名称。 也可以通过 K8S_AUTH_CONTEXT 环境变量指定。
field_selectors 列表 / 元素=字符串	用于筛选结果的字段选择器列表。 默认值： []
host 字符串	提供用于访问 API 的 URL。 也可以通过 K8S_AUTH_HOST 环境变量指定。
impersonate_groups 列表 / 元素=字符串	要模拟操作的组。 也可以通过 K8S_AUTH_IMPERSONATE_GROUPS 环境变量指定，例如 Group1,Group2。
impersonate_user 字符串	要模拟操作的用户名。 也可以通过 K8S_AUTH_IMPERSONATE_USER 环境变量指定。
kubeconfig 任意	现有 Kubernetes 配置文件的路径。如果未提供，并且未提供其他连接选项，则 Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。 也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。 可以使用分隔符 ;（Windows 平台）或 :（其他平台）提供多个 Kubernetes 配置文件。 Kubernetes 配置可以作为字典提供。此功能需要 python kubernetes 客户端版本 >= 17.17.0。
label_selectors 列表 / 元素=字符串	用于筛选结果的标签选择器列表。 默认值： []
name 字符串	指定 VirtualMachine 的名称。
namespace 字符串	指定VirtualMachines的命名空间。
no_proxy 字符串	不需要通过代理的主机/域名/IP/CIDR 的逗号分隔列表。 也可以通过K8S_AUTH_NO_PROXY环境变量指定。 请注意，此模块不会从环境中获取典型的代理设置（例如 NO_PROXY）。 此功能需要kubernetes>=19.15.0。当kubernetes库版本低于19.15.0时，即使no_proxy设置正确，也会失败。 示例值为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 字符串	提供用于与API进行身份验证的密码。 也可以通过K8S_AUTH_PASSWORD环境变量指定。 请阅读username选项的描述，了解此选项适用的情况。
persist_config 布尔值	是否保存kube config刷新令牌。 也可以通过K8S_AUTH_PERSIST_CONFIG环境变量指定。 当k8s上下文使用具有刷新令牌的用户凭据（如oidc或gke/gcloud auth）时，令牌由k8s python客户端库刷新，但默认情况下不会保存。因此，旧的刷新令牌可能会过期，下次身份验证可能会失败。将此标志设置为true将告诉k8s python客户端将新的刷新令牌保存到kube config文件中。 默认情况下禁用。 选项 false true
proxy 字符串	用于连接的HTTP代理的URL。 也可以通过K8S_AUTH_PROXY环境变量指定。 请注意，此模块不会从环境中获取典型的代理设置（例如 HTTP_PROXY）。
proxy_headers 字典	用于HTTP代理的Header。 文档可在以下网址找到：https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers。
basic_auth 字符串	用于基本身份验证标头的冒号分隔的用户名:密码。 也可以通过K8S_AUTH_PROXY_HEADERS_BASIC_AUTH环境变量指定。
proxy_basic_auth 字符串	用于代理基本身份验证标头的冒号分隔的用户名:密码。 也可以通过K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH环境变量指定。
user_agent 字符串	表示您想要的user-agent的字符串，例如foo/1.0。 也可以通过K8S_AUTH_PROXY_HEADERS_USER_AGENT环境变量指定。
running 布尔值 在 kubevirt.core 1.4.0 中添加	指定VirtualMachine是否应该运行。 这会影响要等待的ready条件。 这需要wait=yes。 选项 false true
username 字符串	提供用于与API进行身份验证的用户名。 也可以通过K8S_AUTH_USERNAME环境变量指定。
validate_certs 别名：verify_ssl 布尔值	是否验证API服务器的SSL证书。 也可以通过K8S_AUTH_VERIFY_SSL环境变量指定。 选项 false true
wait 布尔值	是否等待VirtualMachine进入就绪状态。 默认情况下，这是等待VirtualMachine启动并运行。 通过设置running来修改此行为。 选项 false true
wait_sleep 整数	两次检查之间休眠的秒数。 如果未设置wait，则忽略。 默认值：5
wait_timeout 整数	等待资源进入就绪状态的秒数。 如果未设置wait，则忽略。 默认值：120

注释

注意

• 当validate_certs=yes时，为避免SSL证书验证错误，必须通过ca_cert或kubeconfig文件提供API服务器的完整证书链。

示例

- 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

返回值

公共返回值已记录在此处，以下是此模块特有的字段

键	描述
api_found 布尔值	指定的api_version和VirtualMachine Kind是否已成功映射到目标集群上的现有API。 返回：始终
resources 复杂类型	存在的VirtualMachines。 返回：成功
api_version 字符串	此对象表示的版本化模式。 返回：成功
kind 字符串	表示此对象表示的REST资源。 返回：成功
metadata 字典	标准对象元数据。包括名称、命名空间、注释、标签等。 返回：成功
spec 字典	VirtualMachine的特定属性。可能因api_version而异。 返回：成功
status 字典	VirtualMachine的当前状态详细信息。 返回：成功

作者

• KubeVirt.io 项目

收藏链接

• 问题追踪器
• 主页
• 仓库（源代码）
• 报告问题
• 通信