Skip to main content
Version: v1.5 (dev)

Read a Namespaced Virtual Machine Instance

GET 
/apis/kubevirt.io/v1/namespaces/:namespace/virtualmachineinstances/:name

Get a VirtualMachineInstance object.

Request​

Path Parameters

    name stringrequired

    Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

    Name of the resource

    namespace stringrequired

    Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

    Object name and auth scope, such as for teams and projects

Query Parameters

    exact boolean

    Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

    export boolean

    Should this value be exported. Export strips fields that a user can not specify.

Responses​

OK

Schema
    apiVersion stringrequired
    kind stringrequired
    metadata object
    name stringrequired
    namespace string
    spec objectrequired
    accessCredentials object[]
  • Array [
    • sshPublicKey object
    propagationMethod objectrequired
    configDrive object
    noCloud object
    qemuGuestAgent object
    users string[]required
    source objectrequired
    secret object
    secretName stringrequired
    userPassword object
    propagationMethod objectrequired
    qemuGuestAgent object
    source objectrequired
    secret object
    secretName stringrequired
  • ]
    • affinity object
    nodeAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
    • preference objectrequired
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    values string[]
  • ]
    • matchFields object[]
  • Array [
    • key stringrequired
    operator stringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    values string[]
  • ]
    • weight int32required

    Default value: 0

  • ]
    • requiredDuringSchedulingIgnoredDuringExecution object
    nodeSelectorTerms object[]required
  • Array [
    • matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    values string[]
  • ]
    • matchFields object[]
  • Array [
    • key stringrequired
    operator stringrequired

    Possible values: [DoesNotExist, Exists, Gt, In, Lt, NotIn]

    values string[]
  • ]
  • ]
    • podAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
    • podAffinityTerm objectrequired
    labelSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaceSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaces string[]
    topologyKey stringrequired
    weight int32required

    Default value: 0

  • ]
    • requiredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
    • labelSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaceSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaces string[]
    topologyKey stringrequired
  • ]
    • podAntiAffinity object
    preferredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
    • podAffinityTerm objectrequired
    labelSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaceSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaces string[]
    topologyKey stringrequired
    weight int32required

    Default value: 0

  • ]
    • requiredDuringSchedulingIgnoredDuringExecution object[]
  • Array [
    • labelSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaceSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    namespaces string[]
    topologyKey stringrequired
  • ]
    • architecture string
    dnsConfig object
    nameservers string[]
    options object[]
  • Array [
    • name string
    value string
  • ]
    • searches string[]
    dnsPolicy string

    Possible values: [ClusterFirst, ClusterFirstWithHostNet, Default, None]

    domain objectrequired
    chassis object
    asset string
    manufacturer string
    serial string
    sku string
    version string
    clock object
    timer object
    hpet object
    present boolean
    tickPolicy string
    hyperv object
    present boolean
    kvm object
    present boolean
    pit object
    present boolean
    tickPolicy string
    rtc object
    present boolean
    tickPolicy string
    track string
    timezone string
    utc object
    offsetSeconds int32
    cpu object
    cores int64
    dedicatedCpuPlacement boolean
    features object[]
  • Array [
    • name stringrequired
    policy string
  • ]
    • isolateEmulatorThread boolean
    maxSockets int64
    model string
    numa object
    guestMappingPassthrough object
    realtime object
    mask string
    sockets int64
    threads int64
    devices objectrequired
    autoattachGraphicsDevice boolean
    autoattachInputDevice boolean
    autoattachMemBalloon boolean
    autoattachPodInterface boolean
    autoattachSerialConsole boolean
    autoattachVSOCK boolean
    blockMultiQueue boolean
    clientPassthrough object
    disableHotplug boolean
    disks object[]
  • Array [
    • blockSize object
    custom object
    logical int32required

    Default value: 0

    physical int32required

    Default value: 0

    matchVolume object
    enabled boolean
    bootOrder int32
    cache string
    cdrom object
    bus string
    readonly boolean
    tray string
    dedicatedIOThread boolean
    disk object
    bus string
    pciAddress string
    readonly boolean
    errorPolicy string
    io string
    lun object
    bus string
    readonly boolean
    reservation boolean
    name stringrequired
    serial string
    shareable boolean
    tag string
  • ]
    • downwardMetrics object
    filesystems object[]
  • Array [
    • name stringrequired
    virtiofs objectrequired
  • ]
    • gpus object[]
  • Array [
    • deviceName stringrequired
    name stringrequired
    tag string
    virtualGPUOptions object
    display object
    enabled boolean
    ramFB object
    enabled boolean
  • ]
    • hostDevices object[]
  • Array [
    • deviceName stringrequired
    name stringrequired
    tag string
  • ]
    • inputs object[]
  • Array [
    • bus string
    name stringrequired
    type stringrequired
  • ]
    • interfaces object[]
  • Array [
    • acpiIndex int32
    binding object
    name stringrequired
    bootOrder int32
    bridge object
    dhcpOptions object
    bootFileName string
    ntpServers string[]
    privateOptions object[]
  • Array [
    • option int32required

    Default value: 0

    value stringrequired
  • ]
    • tftpServerName string
    macAddress string
    macvtap object
    masquerade object
    model string
    name stringrequired
    passt object
    pciAddress string
    ports object[]
  • Array [
    • name string
    port int32required

    Default value: 0

    protocol string
  • ]
    • slirp object
    sriov object
    state string
    tag string
  • ]
    • logSerialConsole boolean
    networkInterfaceMultiqueue boolean
    rng object
    sound object
    model string
    name stringrequired
    tpm object
    persistent boolean
    useVirtioTransitional boolean
    watchdog object
    i6300esb object
    action string
    name stringrequired
    features object
    acpi object
    enabled boolean
    apic object
    enabled boolean
    endOfInterrupt boolean
    hyperv object
    evmcs object
    enabled boolean
    frequencies object
    enabled boolean
    ipi object
    enabled boolean
    reenlightenment object
    enabled boolean
    relaxed object
    enabled boolean
    reset object
    enabled boolean
    runtime object
    enabled boolean
    spinlocks object
    enabled boolean
    spinlocks int64
    synic object
    enabled boolean
    synictimer object
    direct object
    enabled boolean
    enabled boolean
    tlbflush object
    enabled boolean
    vapic object
    enabled boolean
    vendorid object
    enabled boolean
    vendorid string
    vpindex object
    enabled boolean
    kvm object
    hidden boolean
    pvspinlock object
    enabled boolean
    smm object
    enabled boolean
    firmware object
    bootloader object
    bios object
    useSerial boolean
    efi object
    persistent boolean
    secureBoot boolean
    kernelBoot object
    container object
    image stringrequired
    imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    imagePullSecret string
    initrdPath string
    kernelPath string
    kernelArgs string
    serial string
    uuid string
    ioThreadsPolicy string
    launchSecurity object
    sev object
    attestation object
    dhCert string
    policy object
    encryptedState boolean
    session string
    machine object
    type string
    memory object
    guest k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    hugepages object
    pageSize string
    maxGuest k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    resources object
    limits object
    property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    overcommitGuestOverhead boolean
    requests object
    property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    evictionStrategy string
    hostname string
    livenessProbe object
    exec object
    command string[]
    failureThreshold int32
    guestAgentPing object
    httpGet object
    host string
    httpHeaders object[]
  • Array [
    • name stringrequired
    value stringrequired
  • ]
    • path string
    port int-or-stringrequired

    Default value: [object Object]

    scheme string

    Possible values: [HTTP, HTTPS]

    initialDelaySeconds int32
    periodSeconds int32
    successThreshold int32
    tcpSocket object
    host string
    port int-or-stringrequired

    Default value: [object Object]

    timeoutSeconds int32
    networks object[]
  • Array [
    • multus object
    default boolean
    networkName stringrequired
    name stringrequired
    pod object
    vmIPv6NetworkCIDR string
    vmNetworkCIDR string
  • ]
    • nodeSelector object
    property name* string
    priorityClassName string
    readinessProbe object
    exec object
    command string[]
    failureThreshold int32
    guestAgentPing object
    httpGet object
    host string
    httpHeaders object[]
  • Array [
    • name stringrequired
    value stringrequired
  • ]
    • path string
    port int-or-stringrequired

    Default value: [object Object]

    scheme string

    Possible values: [HTTP, HTTPS]

    initialDelaySeconds int32
    periodSeconds int32
    successThreshold int32
    tcpSocket object
    host string
    port int-or-stringrequired

    Default value: [object Object]

    timeoutSeconds int32
    schedulerName string
    startStrategy string
    subdomain string
    terminationGracePeriodSeconds int64
    tolerations object[]
  • Array [
    • effect string

    Possible values: [NoExecute, NoSchedule, PreferNoSchedule]

    key string
    operator string

    Possible values: [Equal, Exists]

    tolerationSeconds int64
    value string
  • ]
    • topologySpreadConstraints object[]
  • Array [
    • labelSelector object
    matchExpressions object[]
  • Array [
    • key stringrequired
    operator stringrequired
    values string[]
  • ]
    • matchLabels object
    property name* string
    matchLabelKeys string[]
    maxSkew int32required

    Default value: 0

    minDomains int32
    nodeAffinityPolicy string
    nodeTaintsPolicy string
    topologyKey stringrequired
    whenUnsatisfiable stringrequired

    Possible values: [DoNotSchedule, ScheduleAnyway]

  • ]
    • volumes object[]
  • Array [
    • cloudInitConfigDrive object
    networkData string
    networkDataBase64 string
    networkDataSecretRef object
    name string
    secretRef object
    name string
    userData string
    userDataBase64 string
    cloudInitNoCloud object
    networkData string
    networkDataBase64 string
    networkDataSecretRef object
    name string
    secretRef object
    name string
    userData string
    userDataBase64 string
    configMap object
    name string
    optional boolean
    volumeLabel string
    containerDisk object
    image stringrequired
    imagePullPolicy string

    Possible values: [Always, IfNotPresent, Never]

    imagePullSecret string
    path string
    dataVolume object
    hotpluggable boolean
    name stringrequired
    downwardAPI object
    fields object[]
  • Array [
    • fieldRef object
    apiVersion string
    fieldPath stringrequired
    mode int32
    path stringrequired
    resourceFieldRef object
    containerName string
    divisor k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    resource stringrequired
  • ]
    • volumeLabel string
    downwardMetrics object
    emptyDisk object
    capacity k8s.io.apimachinery.pkg.api.resource.Quantity (string)required

    Default value: [object Object]

    ephemeral object
    persistentVolumeClaim object
    claimName stringrequired
    readOnly boolean
    hostDisk object
    capacity k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    path stringrequired
    shared boolean
    type stringrequired
    memoryDump object
    claimName stringrequired
    hotpluggable boolean
    readOnly boolean
    name stringrequired
    persistentVolumeClaim object
    claimName stringrequired
    hotpluggable boolean
    readOnly boolean
    secret object
    optional boolean
    secretName string
    volumeLabel string
    serviceAccount object
    serviceAccountName string
    sysprep object
    configMap object
    name string
    secret object
    name string
  • ]
    • status object
    VSOCKCID int64
    activePods object
    property name* string
    conditions object[]
  • Array [
    • lastProbeTime k8s.io.v1.Time (string)

    Default value: [object Object]

    lastTransitionTime k8s.io.v1.Time (string)

    Default value: [object Object]

    message string
    reason string
    status stringrequired
    type stringrequired
  • ]
    • currentCPUTopology object
    cores int64
    sockets int64
    threads int64
    evacuationNodeName string
    fsFreezeStatus string
    guestOSInfo object
    id string
    kernelRelease string
    kernelVersion string
    machine string
    name string
    prettyName string
    version string
    versionId string
    interfaces object[]
  • Array [
    • infoSource string
    interfaceName string
    ipAddress string
    ipAddresses string[]
    mac string
    name string
    queueCount int32
  • ]
    • kernelBootStatus object
    initrdInfo object
    checksum int64
    kernelInfo object
    checksum int64
    launcherContainerImageVersion string
    machine object
    type string
    memory object
    guestAtBoot k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    guestCurrent k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    guestRequested k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    migrationMethod string
    migrationState object
    abortRequested boolean
    abortStatus string
    completed boolean
    endTimestamp k8s.io.v1.Time (string)
    failed boolean
    migrationConfiguration object
    allowAutoConverge boolean
    allowPostCopy boolean
    bandwidthPerMigration k8s.io.apimachinery.pkg.api.resource.Quantity (string)
    completionTimeoutPerGiB int64
    disableTLS boolean
    matchSELinuxLevelOnMigration boolean
    network string
    nodeDrainTaintKey string
    parallelMigrationsPerCluster int64
    parallelOutboundMigrationsPerNode int64
    progressTimeout int64
    unsafeMigrationOverride boolean
    migrationPolicyName string
    migrationUid string
    mode string
    sourceNode string
    startTimestamp k8s.io.v1.Time (string)
    targetAttachmentPodUID string
    targetCPUSet int32[]
    targetDirectMigrationNodePorts object
    property name* int32

    Default value: 0

    targetNode string
    targetNodeAddress string
    targetNodeDomainDetected boolean
    targetNodeDomainReadyTimestamp k8s.io.v1.Time (string)
    targetNodeTopology string
    targetPod string
    migrationTransport string
    nodeName string
    phase string
    phaseTransitionTimestamps object[]
  • Array [
    • phase string
    phaseTransitionTimestamp k8s.io.v1.Time (string)

    Default value: [object Object]

  • ]
    • qosClass string
    reason string
    runtimeUser int64

    Default value: 0

    selinuxContext string
    topologyHints object
    tscFrequency int64
    virtualMachineRevisionName string
    volumeStatus object[]
  • Array [
    • containerDiskVolume object
    checksum int64
    hotplugVolume object
    attachPodName string
    attachPodUID string
    memoryDumpVolume object
    claimName string
    endTimestamp k8s.io.v1.Time (string)
    startTimestamp k8s.io.v1.Time (string)
    targetFileName string
    message string
    name stringrequired
    persistentVolumeClaimInfo object
    accessModes string[]
    capacity object
    property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    filesystemOverhead string
    preallocated boolean
    requests object
    property name* k8s.io.apimachinery.pkg.api.resource.Quantity (string)

    Default value: [object Object]

    volumeMode string
    phase string
    reason string
    size int64
    target stringrequired
  • ]
Loading...