# openstack.compute.v2.hypervisor

## The Hypervisor Class

The `Hypervisor` class inherits from `Resource`.

class openstack.compute.v2.hypervisor.Hypervisor(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'hypervisor'

    Singular form of key for resource.

  resources_key = 'hypervisors'

    Plural form of key for resource.

  base_path = '/os-hypervisors'

    The base part of the URI for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  cpu_info

    Information about the hypervisor’s CPU. Up to 2.28 it was string.

  host_ip

    IP address of the host

  hypervisor_type

    The type of hypervisor

  hypervisor_version

    Version of the hypervisor

  name

    Name of hypervisor

  service_details

    Service details

  servers

    List of Servers

  state

    State of hypervisor

  status

    Status of hypervisor

  uptime

    The total uptime of the hypervisor and information about average load. This attribute is set only when querying uptime explicitly.

  current_workload

    Measurement of the hypervisor’s current workload

  disk_available

    Disk space available to the scheduler

  local_disk_used

    The amount, in gigabytes, of local storage used

  local_disk_size

    The amount, in gigabytes, of the local storage device

  local_disk_free

    The amount, in gigabytes, of free space on the local storage device

  memory_used

    The amount, in megabytes, of memory

  memory_size

    The amount, in megabytes, of total memory

  memory_free

    The amount, in megabytes, of available memory

  running_vms

    Count of the running virtual machines

  vcpus_used

    Count of the VCPUs in use

  vcpus

    Count of all VCPUs

  get_uptime(session)

    Get uptime information for the hypervisor

    Updates uptime attribute of the hypervisor object

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.